{"function_name": "using_session", "file_path": "capybara/lib/capybara.rb", "focal_code": "def using_session(name_or_session, &block)\n      previous_session = current_session\n      previous_session_info = {\n        specified_session: specified_session,\n        session_name: session_name,\n        current_driver: current_driver,\n        app: app\n      }\n      self.specified_session = self.session_name = nil\n      if name_or_session.is_a? Capybara::Session\n        self.specified_session = name_or_session\n      else\n        self.session_name = name_or_session\n      end\n\n      if block.arity.zero?\n        yield\n      else\n        yield current_session, previous_session\n      end\n    ensure\n      self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session)\n      self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'timeout'\nrequire 'nokogiri'\nrequire 'xpath'\nrequire 'forwardable'\nrequire 'capybara/config'\nrequire 'capybara/registration_container'\n\nmodule Capybara\n  class CapybaraError < StandardError; end\n  class DriverNotFoundError < CapybaraError; end\n  class FrozenInTime < CapybaraError; end\n  class ElementNotFound < CapybaraError; end\n  class ModalNotFound < CapybaraError; end\n  class Ambiguous < ElementNotFound; end\n  class ExpectationNotMet < ElementNotFound; end\n  class FileNotFound < CapybaraError; end\n  class UnselectNotAllowed < CapybaraError; end\n  class NotSupportedByDriverError < CapybaraError; end\n  class InfiniteRedirectError < CapybaraError; end\n  class ScopeError < CapybaraError; end\n  class WindowError < CapybaraError; end\n  class ReadOnlyElementError < CapybaraError; end\n\n  class << self\n    extend Forwardable\n\n    # DelegateCapybara global configurations\n    # @!method app\n    #   See {Capybara.configure}\n    # @!method reuse_server\n    #   See {Capybara.configure}\n    # @!method threadsafe\n    #   See {Capybara.configure}\n    # @!method server\n    #   See {Capybara.configure}\n    # @!method default_driver\n    #   See {Capybara.configure}\n    # @!method javascript_driver\n    #   See {Capybara.configure}\n    # @!method use_html5_parsing\n    #   See {Capybara.configure}\n    Config::OPTIONS.each do |method|\n      def_delegators :config, method, \"#{method}=\"\n    end\n\n    # Delegate Capybara global configurations\n    # @!method default_selector\n    #   See {Capybara.configure}\n    # @!method default_max_wait_time\n    #   See {Capybara.configure}\n    # @!method app_host\n    #   See {Capybara.configure}\n    # @!method always_include_port\n    #   See {Capybara.configure}\n    SessionConfig::OPTIONS.each do |method|\n      def_delegators :config, method, \"#{method}=\"\n    end\n\n    ##\n    #\n    # Configure Capybara to suit your needs.\n    #\n    #     Capybara.configure do |config|\n    #       config.run_server = false\n    #       config.app_host   = 'http://www.google.com'\n    #     end\n    #\n    # #### Configurable options\n    #\n    # - **use_html5_parsing** (Boolean = `false`) - When Nokogiri >= 1.12.0 or `nokogumbo` is installed, whether HTML5 parsing will be used for HTML strings.\n    # - **always_include_port** (Boolean = `false`) - Whether the Rack server's port should automatically be inserted into every visited URL\n    #   unless another port is explicitly specified.\n    # - **app_host** (String, `nil`) - The default host to use when giving a relative URL to visit, must be a valid URL e.g. `http://www.example.com`.\n    # - **asset_host** (String = `nil`) - Where dynamic assets are hosted - will be prepended to relative asset locations if present.\n    # - **automatic_label_click** (Boolean = `false`) - Whether {Capybara::Node::Element#choose Element#choose}, {Capybara::Node::Element#check Element#check},\n    #   {Capybara::Node::Element#uncheck Element#uncheck} will attempt to click the associated `<label>` element if the checkbox/radio button are non-visible.\n    # - **automatic_reload** (Boolean = `true`) - Whether to automatically reload elements as Capybara is waiting.\n    # - **default_max_wait_time** (Numeric = `2`) - The maximum number of seconds to wait for asynchronous processes to finish.\n    # - **default_normalize_ws** (Boolean = `false`) - Whether text predicates and matchers use normalize whitespace behavior.\n    # - **default_retry_interval** (Numeric = `0.01`) - The number of seconds to delay the next check in asynchronous processes.\n    # - **default_selector** (`:css`, `:xpath` = `:css`) - Methods which take a selector use the given type by default. See also {Capybara::Selector}.\n    # - **default_set_options** (Hash = `{}`) - The default options passed to {Capybara::Node::Element#set Element#set}.\n    # - **enable_aria_label** (Boolean = `false`) - Whether fields, links, and buttons will match against `aria-label` attribute.\n    # - **enable_aria_role** (Boolean = `false`) - Selectors will check for relevant aria role (currently only `button`).\n    # - **exact** (Boolean = `false`) - Whether locators are matched exactly or with substrings. Only affects selector conditions\n    #   written using the `XPath#is` method.\n    # - **exact_text** (Boolean = `false`) - Whether the text matchers and `:text` filter match exactly or on substrings.\n    # - **ignore_hidden_elements** (Boolean = `true`) - Whether to ignore hidden elements on the page.\n    # - **match** (`:one`, `:first`, `:prefer_exact`, `:smart` = `:smart`) - The matching strategy to find nodes.\n    # - **predicates_wait** (Boolean = `true`) - Whether Capybara's predicate matchers use waiting behavior by default.\n    # - **raise_server_errors** (Boolean = `true`) - Should errors raised in the server be raised in the tests?\n    # - **reuse_server** (Boolean = `true`) - Whether to reuse the server thread between multiple sessions using the same app object.\n    # - **run_server** (Boolean = `true`) - Whether to start a Rack server for the given Rack app.\n    # - **save_path** (String = `Dir.pwd`) - Where to put pages saved through {Capybara::Session#save_page save_page}, {Capybara::Session#save_screenshot save_screenshot},\n    #   {Capybara::Session#save_and_open_page save_and_open_page}, or {Capybara::Session#save_and_open_screenshot save_and_open_screenshot}.\n    # - **server** (Symbol = `:default` (which uses puma)) - The name of the registered server to use when running the app under test.\n    # - **server_port** (Integer) - The port Capybara will run the application server on, if not specified a random port will be used.\n    # - **server_host** (String = \"127.0.0.1\") - The IP address Capybara will bind the application server to. If the test application is to be accessed from an external host, you will want to change this to \"0.0.0.0\" or to a more specific IP address that your test client can reach.\n    # - **server_errors** (Array\\<Class> = `[Exception]`) - Error classes that should be raised in the tests if they are raised in the server\n    #   and {configure raise_server_errors} is `true`.\n    # - **test_id** (Symbol, String, `nil` = `nil`) - Optional attribute to match locator against with built-in selectors along with id.\n    # - **threadsafe** (Boolean = `false`) - Whether sessions can be configured individually.\n    # - **w3c_click_offset** (Boolean = 'true') - Whether click offsets should be from element center (true) or top left (false)\n    #\n    # #### DSL Options\n    #\n    # When using `capybara/dsl`, the following options are also available:\n    #\n    # - **default_driver** (Symbol = `:rack_test`) - The name of the driver to use by default.\n    # - **javascript_driver** (Symbol = `:selenium`) - The name of a driver to use for JavaScript enabled tests.\n    #\n    def configure\n      yield config\n    end\n\n    ##\n    #\n    # Register a new driver for Capybara.\n    #\n    #     Capybara.register_driver :rack_test do |app|\n    #       Capybara::RackTest::Driver.new(app)\n    #     end\n    #\n    # @param [Symbol] name                    The name of the new driver\n    # @yield [app]                            This block takes a rack app and returns a Capybara driver\n    # @yieldparam [<Rack>] app                The rack application that this driver runs against. May be nil.\n    # @yieldreturn [Capybara::Driver::Base]   A Capybara driver instance\n    #\n    def register_driver(name, &block)\n      drivers.send(:register, name, block)\n    end\n\n    ##\n    #\n    # Register a new server for Capybara.\n    #\n    #     Capybara.register_server :webrick do |app, port, host|\n    #       require 'rack/handler/webrick'\n    #       Rack::Handler::WEBrick.run(app, ...)\n    #     end\n    #\n    # @param [Symbol] name                    The name of the new driver\n    # @yield [app, port, host]                This block takes a rack app and a port and returns a rack server listening on that port\n    # @yieldparam [<Rack>] app                The rack application that this server will contain.\n    # @yieldparam port                        The port number the server should listen on\n    # @yieldparam host                        The host/ip to bind to\n    #\n    def register_server(name, &block)\n      servers.send(:register, name.to_sym, block)\n    end\n\n    ##\n    #\n    # Add a new selector to Capybara. Selectors can be used by various methods in Capybara\n    # to find certain elements on the page in a more convenient way. For example adding a\n    # selector to find certain table rows might look like this:\n    #\n    #     Capybara.add_selector(:row) do\n    #       xpath { |num| \".//tbody/tr[#{num}]\" }\n    #     end\n    #\n    # This makes it possible to use this selector in a variety of ways:\n    #\n    #     find(:row, 3)\n    #     page.find('table#myTable').find(:row, 3).text\n    #     page.find('table#myTable').has_selector?(:row, 3)\n    #     within(:row, 3) { expect(page).to have_content('$100.000') }\n    #\n    # Here is another example:\n    #\n    #     Capybara.add_selector(:id) do\n    #       xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }\n    #     end\n    #\n    # Note that this particular selector already ships with Capybara.\n    #\n    # @param [Symbol] name    The name of the selector to add\n    # @yield                  A block executed in the context of the new {Capybara::Selector}\n    #\n    def add_selector(name, **options, &block)\n      Capybara::Selector.add(name, **options, &block)\n    end\n\n    ##\n    #\n    # Modify a selector previously created by {Capybara.add_selector}.\n    # For example, adding a new filter to the :button selector to filter based on\n    # button style (a class) might look like this\n    #\n    #     Capybara.modify_selector(:button) do\n    #       filter (:btn_style, valid_values: [:primary, :secondary]) { |node, style| node[:class].split.include? \"btn-#{style}\" }\n    #     end\n    #\n    #\n    # @param [Symbol] name    The name of the selector to modify\n    # @yield                  A block executed in the context of the existing {Capybara::Selector}\n    #\n    def modify_selector(name, &block)\n      Capybara::Selector.update(name, &block)\n    end\n\n    def drivers\n      @drivers ||= RegistrationContainer.new\n    end\n\n    def servers\n      @servers ||= RegistrationContainer.new\n    end\n\n    # Wraps the given string, which should contain an HTML document or fragment\n    # in a {Capybara::Node::Simple} which exposes all {Capybara::Node::Matchers},\n    # {Capybara::Node::Finders} and {Capybara::Node::DocumentMatchers}. This allows you to query\n    # any string containing HTML in the exact same way you would query the current document in a Capybara\n    # session.\n    #\n    # @example A single element\n    #     node = Capybara.string('<a href=\"foo\">bar</a>')\n    #     anchor = node.first('a')\n    #     anchor[:href] #=> 'foo'\n    #     anchor.text #=> 'bar'\n    #\n    # @example Multiple elements\n    #     node = Capybara.string <<-HTML\n    #       <ul>\n    #         <li id=\"home\">Home</li>\n    #         <li id=\"projects\">Projects</li>\n    #       </ul>\n    #     HTML\n    #\n    #     node.find('#projects').text # => 'Projects'\n    #     node.has_selector?('li#home', text: 'Home')\n    #     node.has_selector?('#projects')\n    #     node.find('ul').find('li:first-child').text # => 'Home'\n    #\n    # @param [String] html              An html fragment or document\n    # @return [Capybara::Node::Simple]   A node which has Capybara's finders and matchers\n    #\n    def string(html)\n      Capybara::Node::Simple.new(html)\n    end\n\n    ##\n    #\n    # Runs Capybara's default server for the given application and port\n    # under most circumstances you should not have to call this method\n    # manually.\n    #\n    # @param [Rack Application] app    The rack application to run\n    # @param [Integer] port              The port to run the application on\n    #\n    def run_default_server(app, port)\n      servers[:puma].call(app, port, server_host)\n    end\n\n    ##\n    #\n    # @return [Symbol]    The name of the driver currently in use\n    #\n    def current_driver\n      if threadsafe\n        Thread.current.thread_variable_get :capybara_current_driver\n      else\n        @current_driver\n      end || default_driver\n    end\n    alias_method :mode, :current_driver\n\n    def current_driver=(name)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_current_driver, name\n      else\n        @current_driver = name\n      end\n    end\n\n    ##\n    #\n    # Use the default driver as the current driver\n    #\n    def use_default_driver\n      self.current_driver = nil\n    end\n\n    ##\n    #\n    # Yield a block using a specific driver\n    #\n    def using_driver(driver)\n      previous_driver = Capybara.current_driver\n      Capybara.current_driver = driver\n      yield\n    ensure\n      self.current_driver = previous_driver\n    end\n\n    ##\n    #\n    # Yield a block using a specific wait time\n    #\n    def using_wait_time(seconds)\n      previous_wait_time = Capybara.default_max_wait_time\n      Capybara.default_max_wait_time = seconds\n      yield\n    ensure\n      Capybara.default_max_wait_time = previous_wait_time\n    end\n\n    ##\n    #\n    # The current {Capybara::Session} based on what is set as {app} and {current_driver}.\n    #\n    # @return [Capybara::Session]     The currently used session\n    #\n    def current_session\n      specified_session || session_pool[\"#{current_driver}:#{session_name}:#{app.object_id}\"]\n    end\n\n    ##\n    #\n    # Reset sessions, cleaning out the pool of sessions. This will remove any session information such\n    # as cookies.\n    #\n    def reset_sessions!\n      # reset in reverse so sessions that started servers are reset last\n      session_pool.reverse_each { |_mode, session| session.reset! }\n    end\n    alias_method :reset!, :reset_sessions!\n\n    ##\n    #\n    # The current session name.\n    #\n    # @return [Symbol]    The name of the currently used session.\n    #\n    def session_name\n      if threadsafe\n        Thread.current.thread_variable_get(:capybara_session_name) ||\n          Thread.current.thread_variable_set(:capybara_session_name, :default)\n      else\n        @session_name ||= :default\n      end\n    end\n\n    def session_name=(name)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_session_name, name\n      else\n        @session_name = name\n      end\n    end\n\n    ##\n    #\n    # Yield a block using a specific session name or {Capybara::Session} instance.\n    #\n    def using_session(name_or_session, &block)\n      previous_session = current_session\n      previous_session_info = {\n        specified_session: specified_session,\n        session_name: session_name,\n        current_driver: current_driver,\n        app: app\n      }\n      self.specified_session = self.session_name = nil\n      if name_or_session.is_a? Capybara::Session\n        self.specified_session = name_or_session\n      else\n        self.session_name = name_or_session\n      end\n\n      if block.arity.zero?\n        yield\n      else\n        yield current_session, previous_session\n      end\n    ensure\n      self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session)\n      self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe\n    end\n\n    ##\n    #\n    # Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.\n    #\n    # @param [String] html              The raw html\n    # @return [Nokogiri::HTML::Document]      HTML document\n    #\n    def HTML(html) # rubocop:disable Naming/MethodName\n      # Nokogiri >= 1.12.0 or Nokogumbo installed and allowed for use\n      html_parser, using_html5 = if defined?(Nokogiri::HTML5) && Capybara.use_html5_parsing\n        [Nokogiri::HTML5, true]\n      else\n        [defined?(Nokogiri::HTML4) ? Nokogiri::HTML4 : Nokogiri::HTML, false]\n      end\n\n      html_parser.parse(html).tap do |document|\n        document.xpath('//template').each do |template|\n          # template elements content is not part of the document\n          template.inner_html = ''\n        end\n        document.xpath('//textarea').each do |textarea|\n          # The Nokogiri HTML5 parser already returns spec compliant contents\n          textarea['_capybara_raw_value'] = using_html5 ? textarea.content : textarea.content.delete_prefix(\"\\n\")\n        end\n      end\n    end\n\n    def session_options\n      config.session_options\n    end\n\n  private\n\n    def config\n      @config ||= Capybara::Config.new\n    end\n\n    def session_pool\n      @session_pool ||= Hash.new do |hash, name|\n        hash[name] = Capybara::Session.new(current_driver, app)\n      end\n    end\n\n    def specified_session\n      if threadsafe\n        Thread.current.thread_variable_get :capybara_specified_session\n      else\n        @specified_session ||= nil\n      end\n    end\n\n    def specified_session=(session)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_specified_session, session\n      else\n        @specified_session = session\n      end\n    end\n  end\n\n  self.default_driver = nil\n  self.current_driver = nil\n  self.server_host = nil\n\n  module Driver; end\n  module RackTest; end\n  module Selenium; end\n\n  require 'capybara/helpers'\n  require 'capybara/session'\n  require 'capybara/window'\n  require 'capybara/server'\n  require 'capybara/selector'\n  require 'capybara/result'\n  require 'capybara/version'\n\n  require 'capybara/queries/base_query'\n  require 'capybara/queries/selector_query'\n  require 'capybara/queries/text_query'\n  require 'capybara/queries/title_query'\n  require 'capybara/queries/current_path_query'\n  require 'capybara/queries/match_query'\n  require 'capybara/queries/ancestor_query'\n  require 'capybara/queries/sibling_query'\n  require 'capybara/queries/style_query'\n  require 'capybara/queries/active_element_query'\n\n  require 'capybara/node/finders'\n  require 'capybara/node/matchers'\n  require 'capybara/node/actions'\n  require 'capybara/node/document_matchers'\n  require 'capybara/node/simple'\n  require 'capybara/node/base'\n  require 'capybara/node/element'\n  require 'capybara/node/document'\n\n  require 'capybara/driver/base'\n  require 'capybara/driver/node'\n\n  require 'capybara/rack_test/driver'\n  require 'capybara/rack_test/node'\n  require 'capybara/rack_test/form'\n  require 'capybara/rack_test/browser'\n  require 'capybara/rack_test/css_handlers'\n\n  require 'capybara/selenium/node'\n  require 'capybara/selenium/driver'\nend\n\nrequire 'capybara/registrations/servers'\nrequire 'capybara/registrations/drivers'\n\nCapybara.configure do |config|\n  config.always_include_port = false\n  config.run_server = true\n  config.server = :default\n  config.default_selector = :css\n  config.default_max_wait_time = 2\n  config.default_retry_interval = 0.01\n  config.ignore_hidden_elements = true\n  config.default_host = 'http://www.example.com'\n  config.automatic_reload = true\n  config.match = :smart\n  config.exact = false\n  config.exact_text = false\n  config.raise_server_errors = true\n  config.server_errors = [Exception]\n  config.visible_text_only = false\n  config.automatic_label_click = false\n  config.enable_aria_label = false\n  config.enable_aria_role = false\n  config.reuse_server = true\n  config.default_set_options = {}\n  config.test_id = nil\n  config.predicates_wait = true\n  config.default_normalize_ws = false\n  config.use_html5_parsing = false\n  config.w3c_click_offset = true\nend\n", "language": "Ruby", "function_component": {"name": "using_session", "signature": "def using_session(name_or_session, &block)", "start_line": 358, "end_line": 381}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 0}
{"function_name": "HTML", "file_path": "capybara/lib/capybara.rb", "focal_code": "def HTML(html) # rubocop:disable Naming/MethodName\n      # Nokogiri >= 1.12.0 or Nokogumbo installed and allowed for use\n      html_parser, using_html5 = if defined?(Nokogiri::HTML5) && Capybara.use_html5_parsing\n        [Nokogiri::HTML5, true]\n      else\n        [defined?(Nokogiri::HTML4) ? Nokogiri::HTML4 : Nokogiri::HTML, false]\n      end\n\n      html_parser.parse(html).tap do |document|\n        document.xpath('//template').each do |template|\n          # template elements content is not part of the document\n          template.inner_html = ''\n        end\n        document.xpath('//textarea').each do |textarea|\n          # The Nokogiri HTML5 parser already returns spec compliant contents\n          textarea['_capybara_raw_value'] = using_html5 ? textarea.content : textarea.content.delete_prefix(\"\\n\")\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'timeout'\nrequire 'nokogiri'\nrequire 'xpath'\nrequire 'forwardable'\nrequire 'capybara/config'\nrequire 'capybara/registration_container'\n\nmodule Capybara\n  class CapybaraError < StandardError; end\n  class DriverNotFoundError < CapybaraError; end\n  class FrozenInTime < CapybaraError; end\n  class ElementNotFound < CapybaraError; end\n  class ModalNotFound < CapybaraError; end\n  class Ambiguous < ElementNotFound; end\n  class ExpectationNotMet < ElementNotFound; end\n  class FileNotFound < CapybaraError; end\n  class UnselectNotAllowed < CapybaraError; end\n  class NotSupportedByDriverError < CapybaraError; end\n  class InfiniteRedirectError < CapybaraError; end\n  class ScopeError < CapybaraError; end\n  class WindowError < CapybaraError; end\n  class ReadOnlyElementError < CapybaraError; end\n\n  class << self\n    extend Forwardable\n\n    # DelegateCapybara global configurations\n    # @!method app\n    #   See {Capybara.configure}\n    # @!method reuse_server\n    #   See {Capybara.configure}\n    # @!method threadsafe\n    #   See {Capybara.configure}\n    # @!method server\n    #   See {Capybara.configure}\n    # @!method default_driver\n    #   See {Capybara.configure}\n    # @!method javascript_driver\n    #   See {Capybara.configure}\n    # @!method use_html5_parsing\n    #   See {Capybara.configure}\n    Config::OPTIONS.each do |method|\n      def_delegators :config, method, \"#{method}=\"\n    end\n\n    # Delegate Capybara global configurations\n    # @!method default_selector\n    #   See {Capybara.configure}\n    # @!method default_max_wait_time\n    #   See {Capybara.configure}\n    # @!method app_host\n    #   See {Capybara.configure}\n    # @!method always_include_port\n    #   See {Capybara.configure}\n    SessionConfig::OPTIONS.each do |method|\n      def_delegators :config, method, \"#{method}=\"\n    end\n\n    ##\n    #\n    # Configure Capybara to suit your needs.\n    #\n    #     Capybara.configure do |config|\n    #       config.run_server = false\n    #       config.app_host   = 'http://www.google.com'\n    #     end\n    #\n    # #### Configurable options\n    #\n    # - **use_html5_parsing** (Boolean = `false`) - When Nokogiri >= 1.12.0 or `nokogumbo` is installed, whether HTML5 parsing will be used for HTML strings.\n    # - **always_include_port** (Boolean = `false`) - Whether the Rack server's port should automatically be inserted into every visited URL\n    #   unless another port is explicitly specified.\n    # - **app_host** (String, `nil`) - The default host to use when giving a relative URL to visit, must be a valid URL e.g. `http://www.example.com`.\n    # - **asset_host** (String = `nil`) - Where dynamic assets are hosted - will be prepended to relative asset locations if present.\n    # - **automatic_label_click** (Boolean = `false`) - Whether {Capybara::Node::Element#choose Element#choose}, {Capybara::Node::Element#check Element#check},\n    #   {Capybara::Node::Element#uncheck Element#uncheck} will attempt to click the associated `<label>` element if the checkbox/radio button are non-visible.\n    # - **automatic_reload** (Boolean = `true`) - Whether to automatically reload elements as Capybara is waiting.\n    # - **default_max_wait_time** (Numeric = `2`) - The maximum number of seconds to wait for asynchronous processes to finish.\n    # - **default_normalize_ws** (Boolean = `false`) - Whether text predicates and matchers use normalize whitespace behavior.\n    # - **default_retry_interval** (Numeric = `0.01`) - The number of seconds to delay the next check in asynchronous processes.\n    # - **default_selector** (`:css`, `:xpath` = `:css`) - Methods which take a selector use the given type by default. See also {Capybara::Selector}.\n    # - **default_set_options** (Hash = `{}`) - The default options passed to {Capybara::Node::Element#set Element#set}.\n    # - **enable_aria_label** (Boolean = `false`) - Whether fields, links, and buttons will match against `aria-label` attribute.\n    # - **enable_aria_role** (Boolean = `false`) - Selectors will check for relevant aria role (currently only `button`).\n    # - **exact** (Boolean = `false`) - Whether locators are matched exactly or with substrings. Only affects selector conditions\n    #   written using the `XPath#is` method.\n    # - **exact_text** (Boolean = `false`) - Whether the text matchers and `:text` filter match exactly or on substrings.\n    # - **ignore_hidden_elements** (Boolean = `true`) - Whether to ignore hidden elements on the page.\n    # - **match** (`:one`, `:first`, `:prefer_exact`, `:smart` = `:smart`) - The matching strategy to find nodes.\n    # - **predicates_wait** (Boolean = `true`) - Whether Capybara's predicate matchers use waiting behavior by default.\n    # - **raise_server_errors** (Boolean = `true`) - Should errors raised in the server be raised in the tests?\n    # - **reuse_server** (Boolean = `true`) - Whether to reuse the server thread between multiple sessions using the same app object.\n    # - **run_server** (Boolean = `true`) - Whether to start a Rack server for the given Rack app.\n    # - **save_path** (String = `Dir.pwd`) - Where to put pages saved through {Capybara::Session#save_page save_page}, {Capybara::Session#save_screenshot save_screenshot},\n    #   {Capybara::Session#save_and_open_page save_and_open_page}, or {Capybara::Session#save_and_open_screenshot save_and_open_screenshot}.\n    # - **server** (Symbol = `:default` (which uses puma)) - The name of the registered server to use when running the app under test.\n    # - **server_port** (Integer) - The port Capybara will run the application server on, if not specified a random port will be used.\n    # - **server_host** (String = \"127.0.0.1\") - The IP address Capybara will bind the application server to. If the test application is to be accessed from an external host, you will want to change this to \"0.0.0.0\" or to a more specific IP address that your test client can reach.\n    # - **server_errors** (Array\\<Class> = `[Exception]`) - Error classes that should be raised in the tests if they are raised in the server\n    #   and {configure raise_server_errors} is `true`.\n    # - **test_id** (Symbol, String, `nil` = `nil`) - Optional attribute to match locator against with built-in selectors along with id.\n    # - **threadsafe** (Boolean = `false`) - Whether sessions can be configured individually.\n    # - **w3c_click_offset** (Boolean = 'true') - Whether click offsets should be from element center (true) or top left (false)\n    #\n    # #### DSL Options\n    #\n    # When using `capybara/dsl`, the following options are also available:\n    #\n    # - **default_driver** (Symbol = `:rack_test`) - The name of the driver to use by default.\n    # - **javascript_driver** (Symbol = `:selenium`) - The name of a driver to use for JavaScript enabled tests.\n    #\n    def configure\n      yield config\n    end\n\n    ##\n    #\n    # Register a new driver for Capybara.\n    #\n    #     Capybara.register_driver :rack_test do |app|\n    #       Capybara::RackTest::Driver.new(app)\n    #     end\n    #\n    # @param [Symbol] name                    The name of the new driver\n    # @yield [app]                            This block takes a rack app and returns a Capybara driver\n    # @yieldparam [<Rack>] app                The rack application that this driver runs against. May be nil.\n    # @yieldreturn [Capybara::Driver::Base]   A Capybara driver instance\n    #\n    def register_driver(name, &block)\n      drivers.send(:register, name, block)\n    end\n\n    ##\n    #\n    # Register a new server for Capybara.\n    #\n    #     Capybara.register_server :webrick do |app, port, host|\n    #       require 'rack/handler/webrick'\n    #       Rack::Handler::WEBrick.run(app, ...)\n    #     end\n    #\n    # @param [Symbol] name                    The name of the new driver\n    # @yield [app, port, host]                This block takes a rack app and a port and returns a rack server listening on that port\n    # @yieldparam [<Rack>] app                The rack application that this server will contain.\n    # @yieldparam port                        The port number the server should listen on\n    # @yieldparam host                        The host/ip to bind to\n    #\n    def register_server(name, &block)\n      servers.send(:register, name.to_sym, block)\n    end\n\n    ##\n    #\n    # Add a new selector to Capybara. Selectors can be used by various methods in Capybara\n    # to find certain elements on the page in a more convenient way. For example adding a\n    # selector to find certain table rows might look like this:\n    #\n    #     Capybara.add_selector(:row) do\n    #       xpath { |num| \".//tbody/tr[#{num}]\" }\n    #     end\n    #\n    # This makes it possible to use this selector in a variety of ways:\n    #\n    #     find(:row, 3)\n    #     page.find('table#myTable').find(:row, 3).text\n    #     page.find('table#myTable').has_selector?(:row, 3)\n    #     within(:row, 3) { expect(page).to have_content('$100.000') }\n    #\n    # Here is another example:\n    #\n    #     Capybara.add_selector(:id) do\n    #       xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }\n    #     end\n    #\n    # Note that this particular selector already ships with Capybara.\n    #\n    # @param [Symbol] name    The name of the selector to add\n    # @yield                  A block executed in the context of the new {Capybara::Selector}\n    #\n    def add_selector(name, **options, &block)\n      Capybara::Selector.add(name, **options, &block)\n    end\n\n    ##\n    #\n    # Modify a selector previously created by {Capybara.add_selector}.\n    # For example, adding a new filter to the :button selector to filter based on\n    # button style (a class) might look like this\n    #\n    #     Capybara.modify_selector(:button) do\n    #       filter (:btn_style, valid_values: [:primary, :secondary]) { |node, style| node[:class].split.include? \"btn-#{style}\" }\n    #     end\n    #\n    #\n    # @param [Symbol] name    The name of the selector to modify\n    # @yield                  A block executed in the context of the existing {Capybara::Selector}\n    #\n    def modify_selector(name, &block)\n      Capybara::Selector.update(name, &block)\n    end\n\n    def drivers\n      @drivers ||= RegistrationContainer.new\n    end\n\n    def servers\n      @servers ||= RegistrationContainer.new\n    end\n\n    # Wraps the given string, which should contain an HTML document or fragment\n    # in a {Capybara::Node::Simple} which exposes all {Capybara::Node::Matchers},\n    # {Capybara::Node::Finders} and {Capybara::Node::DocumentMatchers}. This allows you to query\n    # any string containing HTML in the exact same way you would query the current document in a Capybara\n    # session.\n    #\n    # @example A single element\n    #     node = Capybara.string('<a href=\"foo\">bar</a>')\n    #     anchor = node.first('a')\n    #     anchor[:href] #=> 'foo'\n    #     anchor.text #=> 'bar'\n    #\n    # @example Multiple elements\n    #     node = Capybara.string <<-HTML\n    #       <ul>\n    #         <li id=\"home\">Home</li>\n    #         <li id=\"projects\">Projects</li>\n    #       </ul>\n    #     HTML\n    #\n    #     node.find('#projects').text # => 'Projects'\n    #     node.has_selector?('li#home', text: 'Home')\n    #     node.has_selector?('#projects')\n    #     node.find('ul').find('li:first-child').text # => 'Home'\n    #\n    # @param [String] html              An html fragment or document\n    # @return [Capybara::Node::Simple]   A node which has Capybara's finders and matchers\n    #\n    def string(html)\n      Capybara::Node::Simple.new(html)\n    end\n\n    ##\n    #\n    # Runs Capybara's default server for the given application and port\n    # under most circumstances you should not have to call this method\n    # manually.\n    #\n    # @param [Rack Application] app    The rack application to run\n    # @param [Integer] port              The port to run the application on\n    #\n    def run_default_server(app, port)\n      servers[:puma].call(app, port, server_host)\n    end\n\n    ##\n    #\n    # @return [Symbol]    The name of the driver currently in use\n    #\n    def current_driver\n      if threadsafe\n        Thread.current.thread_variable_get :capybara_current_driver\n      else\n        @current_driver\n      end || default_driver\n    end\n    alias_method :mode, :current_driver\n\n    def current_driver=(name)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_current_driver, name\n      else\n        @current_driver = name\n      end\n    end\n\n    ##\n    #\n    # Use the default driver as the current driver\n    #\n    def use_default_driver\n      self.current_driver = nil\n    end\n\n    ##\n    #\n    # Yield a block using a specific driver\n    #\n    def using_driver(driver)\n      previous_driver = Capybara.current_driver\n      Capybara.current_driver = driver\n      yield\n    ensure\n      self.current_driver = previous_driver\n    end\n\n    ##\n    #\n    # Yield a block using a specific wait time\n    #\n    def using_wait_time(seconds)\n      previous_wait_time = Capybara.default_max_wait_time\n      Capybara.default_max_wait_time = seconds\n      yield\n    ensure\n      Capybara.default_max_wait_time = previous_wait_time\n    end\n\n    ##\n    #\n    # The current {Capybara::Session} based on what is set as {app} and {current_driver}.\n    #\n    # @return [Capybara::Session]     The currently used session\n    #\n    def current_session\n      specified_session || session_pool[\"#{current_driver}:#{session_name}:#{app.object_id}\"]\n    end\n\n    ##\n    #\n    # Reset sessions, cleaning out the pool of sessions. This will remove any session information such\n    # as cookies.\n    #\n    def reset_sessions!\n      # reset in reverse so sessions that started servers are reset last\n      session_pool.reverse_each { |_mode, session| session.reset! }\n    end\n    alias_method :reset!, :reset_sessions!\n\n    ##\n    #\n    # The current session name.\n    #\n    # @return [Symbol]    The name of the currently used session.\n    #\n    def session_name\n      if threadsafe\n        Thread.current.thread_variable_get(:capybara_session_name) ||\n          Thread.current.thread_variable_set(:capybara_session_name, :default)\n      else\n        @session_name ||= :default\n      end\n    end\n\n    def session_name=(name)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_session_name, name\n      else\n        @session_name = name\n      end\n    end\n\n    ##\n    #\n    # Yield a block using a specific session name or {Capybara::Session} instance.\n    #\n    def using_session(name_or_session, &block)\n      previous_session = current_session\n      previous_session_info = {\n        specified_session: specified_session,\n        session_name: session_name,\n        current_driver: current_driver,\n        app: app\n      }\n      self.specified_session = self.session_name = nil\n      if name_or_session.is_a? Capybara::Session\n        self.specified_session = name_or_session\n      else\n        self.session_name = name_or_session\n      end\n\n      if block.arity.zero?\n        yield\n      else\n        yield current_session, previous_session\n      end\n    ensure\n      self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session)\n      self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe\n    end\n\n    ##\n    #\n    # Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.\n    #\n    # @param [String] html              The raw html\n    # @return [Nokogiri::HTML::Document]      HTML document\n    #\n    def HTML(html) # rubocop:disable Naming/MethodName\n      # Nokogiri >= 1.12.0 or Nokogumbo installed and allowed for use\n      html_parser, using_html5 = if defined?(Nokogiri::HTML5) && Capybara.use_html5_parsing\n        [Nokogiri::HTML5, true]\n      else\n        [defined?(Nokogiri::HTML4) ? Nokogiri::HTML4 : Nokogiri::HTML, false]\n      end\n\n      html_parser.parse(html).tap do |document|\n        document.xpath('//template').each do |template|\n          # template elements content is not part of the document\n          template.inner_html = ''\n        end\n        document.xpath('//textarea').each do |textarea|\n          # The Nokogiri HTML5 parser already returns spec compliant contents\n          textarea['_capybara_raw_value'] = using_html5 ? textarea.content : textarea.content.delete_prefix(\"\\n\")\n        end\n      end\n    end\n\n    def session_options\n      config.session_options\n    end\n\n  private\n\n    def config\n      @config ||= Capybara::Config.new\n    end\n\n    def session_pool\n      @session_pool ||= Hash.new do |hash, name|\n        hash[name] = Capybara::Session.new(current_driver, app)\n      end\n    end\n\n    def specified_session\n      if threadsafe\n        Thread.current.thread_variable_get :capybara_specified_session\n      else\n        @specified_session ||= nil\n      end\n    end\n\n    def specified_session=(session)\n      if threadsafe\n        Thread.current.thread_variable_set :capybara_specified_session, session\n      else\n        @specified_session = session\n      end\n    end\n  end\n\n  self.default_driver = nil\n  self.current_driver = nil\n  self.server_host = nil\n\n  module Driver; end\n  module RackTest; end\n  module Selenium; end\n\n  require 'capybara/helpers'\n  require 'capybara/session'\n  require 'capybara/window'\n  require 'capybara/server'\n  require 'capybara/selector'\n  require 'capybara/result'\n  require 'capybara/version'\n\n  require 'capybara/queries/base_query'\n  require 'capybara/queries/selector_query'\n  require 'capybara/queries/text_query'\n  require 'capybara/queries/title_query'\n  require 'capybara/queries/current_path_query'\n  require 'capybara/queries/match_query'\n  require 'capybara/queries/ancestor_query'\n  require 'capybara/queries/sibling_query'\n  require 'capybara/queries/style_query'\n  require 'capybara/queries/active_element_query'\n\n  require 'capybara/node/finders'\n  require 'capybara/node/matchers'\n  require 'capybara/node/actions'\n  require 'capybara/node/document_matchers'\n  require 'capybara/node/simple'\n  require 'capybara/node/base'\n  require 'capybara/node/element'\n  require 'capybara/node/document'\n\n  require 'capybara/driver/base'\n  require 'capybara/driver/node'\n\n  require 'capybara/rack_test/driver'\n  require 'capybara/rack_test/node'\n  require 'capybara/rack_test/form'\n  require 'capybara/rack_test/browser'\n  require 'capybara/rack_test/css_handlers'\n\n  require 'capybara/selenium/node'\n  require 'capybara/selenium/driver'\nend\n\nrequire 'capybara/registrations/servers'\nrequire 'capybara/registrations/drivers'\n\nCapybara.configure do |config|\n  config.always_include_port = false\n  config.run_server = true\n  config.server = :default\n  config.default_selector = :css\n  config.default_max_wait_time = 2\n  config.default_retry_interval = 0.01\n  config.ignore_hidden_elements = true\n  config.default_host = 'http://www.example.com'\n  config.automatic_reload = true\n  config.match = :smart\n  config.exact = false\n  config.exact_text = false\n  config.raise_server_errors = true\n  config.server_errors = [Exception]\n  config.visible_text_only = false\n  config.automatic_label_click = false\n  config.enable_aria_label = false\n  config.enable_aria_role = false\n  config.reuse_server = true\n  config.default_set_options = {}\n  config.test_id = nil\n  config.predicates_wait = true\n  config.default_normalize_ws = false\n  config.use_html5_parsing = false\n  config.w3c_click_offset = true\nend\n", "language": "Ruby", "function_component": {"name": "HTML", "signature": "def HTML(html) # rubocop:disable Naming/MethodName", "start_line": 390, "end_line": 408}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 1}
{"function_name": "server=", "file_path": "capybara/lib/capybara/config.rb", "focal_code": "def server=(name)\n      name, options = *name if name.is_a? Array\n      @server = if name.respond_to? :call\n        name\n      elsif options\n        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }\n      else\n        Capybara.servers[name.to_sym]\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\nrequire 'capybara/session/config'\n\nmodule Capybara\n  class Config\n    extend Forwardable\n\n    OPTIONS = %i[\n      app reuse_server threadsafe server default_driver javascript_driver use_html5_parsing allow_gumbo\n    ].freeze\n\n    attr_accessor :app, :use_html5_parsing\n    attr_reader :reuse_server, :threadsafe, :session_options # rubocop:disable Style/BisectedAttrAccessor\n    attr_writer :default_driver, :javascript_driver\n\n    SessionConfig::OPTIONS.each do |method|\n      def_delegators :session_options, method, \"#{method}=\"\n    end\n\n    def initialize\n      @session_options = Capybara::SessionConfig.new\n      @javascript_driver = nil\n    end\n\n    attr_writer :reuse_server # rubocop:disable Style/BisectedAttrAccessor\n\n    def threadsafe=(bool)\n      if (bool != threadsafe) && Session.instance_created?\n        raise 'Threadsafe setting cannot be changed once a session is created'\n      end\n\n      @threadsafe = bool\n    end\n\n    ##\n    #\n    # Return the proc that Capybara will call to run the Rack application.\n    # The block returned receives a rack app, port, and host/ip and should run a Rack handler\n    # By default, Capybara will try to use puma.\n    #\n    attr_reader :server\n\n    ##\n    #\n    # Set the server to use.\n    #\n    #     Capybara.server = :webrick\n    #     Capybara.server = :puma, { Silent: true }\n    #\n    # @overload server=(name)\n    #   @param [Symbol] name     Name of the server type to use\n    # @overload server=([name, options])\n    #   @param [Symbol] name Name of the server type to use\n    #   @param [Hash] options Options to pass to the server block\n    # @see register_server\n    #\n    def server=(name)\n      name, options = *name if name.is_a? Array\n      @server = if name.respond_to? :call\n        name\n      elsif options\n        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }\n      else\n        Capybara.servers[name.to_sym]\n      end\n    end\n\n    ##\n    #\n    # @return [Symbol]    The name of the driver to use by default\n    #\n    def default_driver\n      @default_driver || :rack_test\n    end\n\n    ##\n    #\n    # @return [Symbol]    The name of the driver used when JavaScript is needed\n    #\n    def javascript_driver\n      @javascript_driver || :selenium\n    end\n\n    def deprecate(method, alternate_method, once: false)\n      @deprecation_notified ||= {}\n      unless once && @deprecation_notified[method]\n        Capybara::Helpers.warn \"DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead: #{Capybara::Helpers.filter_backtrace(caller)}\"\n      end\n      @deprecation_notified[method] = true\n    end\n\n    def allow_gumbo=(val)\n      deprecate('allow_gumbo=', 'use_html5_parsing=')\n      self.use_html5_parsing = val\n    end\n\n    def allow_gumbo\n      deprecate('allow_gumbo', 'use_html5_parsing')\n      use_html5_parsing\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "server=", "signature": "def server", "start_line": 59, "end_line": 68}, "metadata": {"module": "Capybara", "class_name": "Config", "class_signature": "class Config"}, "task_id": 2}
{"function_name": "each", "file_path": "capybara/lib/capybara/result.rb", "focal_code": "def each(&block)\n      return enum_for(:each) unless block\n\n      @result_cache.each(&block)\n      loop do\n        next_result = @results_enum.next\n        add_to_cache(next_result)\n        yield next_result\n      end\n      self\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\n\nmodule Capybara\n  ##\n  # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this\n  # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:\n  #\n  # * \\[\\]\n  # * each()\n  # * at()\n  # * size()\n  # * count()\n  # * length()\n  # * first()\n  # * last()\n  # * empty?()\n  # * values_at()\n  # * sample()\n  #\n  # @see Capybara::Node::Element\n  #\n  class Result\n    include Enumerable\n    extend Forwardable\n\n    def initialize(elements, query)\n      @elements = elements\n      @result_cache = []\n      @filter_errors = []\n      @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }\n      @query = query\n      @allow_reload = false\n    end\n\n    def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample, :to_ary\n\n    alias index find_index\n\n    def each(&block)\n      return enum_for(:each) unless block\n\n      @result_cache.each(&block)\n      loop do\n        next_result = @results_enum.next\n        add_to_cache(next_result)\n        yield next_result\n      end\n      self\n    end\n\n    def [](*args)\n      idx, length = args\n      max_idx = case idx\n      when Integer\n        if idx.negative?\n          nil\n        else\n          length.nil? ? idx : idx + length - 1\n        end\n      when Range\n        # idx.max is broken with beginless ranges\n        # idx.end && idx.max # endless range will have end == nil\n        max = idx.end\n        max = nil if max&.negative?\n        max -= 1 if max && idx.exclude_end?\n        max\n      end\n\n      if max_idx.nil?\n        full_results[*args]\n      else\n        load_up_to(max_idx + 1)\n        @result_cache[*args]\n      end\n    end\n    alias :at :[]\n\n    def empty?\n      !any?\n    end\n\n    def compare_count\n      return 0 unless @query\n\n      count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)\n\n      # Only check filters for as many elements as necessary to determine result\n      if count && (count = Integer(count))\n        return load_up_to(count + 1) <=> count\n      end\n\n      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)\n\n      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)\n\n      if between\n        min, max = (between.begin && between.min) || 1, between.end\n        max -= 1 if max && between.exclude_end?\n\n        size = load_up_to(max ? max + 1 : min)\n        return size <=> min unless between.include?(size)\n      end\n\n      0\n    end\n\n    def matches_count?\n      compare_count.zero?\n    end\n\n    def failure_message\n      message = @query.failure_message\n      if count.zero?\n        message << ' but there were no matches'\n      else\n        message << \", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: \" \\\n                << full_results.map { |r| r.text.inspect }.join(', ')\n      end\n      unless rest.empty?\n        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier\n        message << '. Also found ' << elements << ', which matched the selector but not all filters. '\n        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?\n      end\n      message\n    end\n\n    def negative_failure_message\n      failure_message.sub(/(to find)/, 'not \\1')\n    end\n\n    def unfiltered_size\n      @elements.length\n    end\n\n    ##\n    # @api private\n    #\n    def allow_reload!\n      @allow_reload = true\n      self\n    end\n\n  private\n\n    def add_to_cache(elem)\n      elem.allow_reload!(@result_cache.size) if @allow_reload\n      @result_cache << elem\n    end\n\n    def load_up_to(num)\n      loop do\n        break if @result_cache.size >= num\n\n        add_to_cache(@results_enum.next)\n      end\n      @result_cache.size\n    end\n\n    def full_results\n      loop { @result_cache << @results_enum.next }\n      @result_cache\n    end\n\n    def rest\n      @rest ||= @elements - full_results\n    end\n\n    if RUBY_PLATFORM == 'java'\n      # JRuby < 9.2.8.0 has an issue with lazy enumerators which\n      # causes a concurrency issue with network requests here\n      # https://github.com/jruby/jruby/issues/4212\n      # while JRuby >= 9.2.8.0 leaks threads when using lazy enumerators\n      # https://github.com/teamcapybara/capybara/issues/2349\n      # so disable the use and JRuby users will need to pay a performance penalty\n      def lazy_select_elements(&block)\n        @elements.select(&block).to_enum # non-lazy evaluation\n      end\n    else\n      def lazy_select_elements(&block)\n        @elements.lazy.select(&block)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "each", "signature": "def each(&block)", "start_line": 41, "end_line": 51}, "metadata": {"module": "Capybara", "class_name": "Result", "class_signature": "class Result"}, "task_id": 3}
{"function_name": "[]", "file_path": "capybara/lib/capybara/result.rb", "focal_code": "def [](*args)\n      idx, length = args\n      max_idx = case idx\n      when Integer\n        if idx.negative?\n          nil\n        else\n          length.nil? ? idx : idx + length - 1\n        end\n      when Range\n        # idx.max is broken with beginless ranges\n        # idx.end && idx.max # endless range will have end == nil\n        max = idx.end\n        max = nil if max&.negative?\n        max -= 1 if max && idx.exclude_end?\n        max\n      end\n\n      if max_idx.nil?\n        full_results[*args]\n      else\n        load_up_to(max_idx + 1)\n        @result_cache[*args]\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\n\nmodule Capybara\n  ##\n  # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this\n  # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:\n  #\n  # * \\[\\]\n  # * each()\n  # * at()\n  # * size()\n  # * count()\n  # * length()\n  # * first()\n  # * last()\n  # * empty?()\n  # * values_at()\n  # * sample()\n  #\n  # @see Capybara::Node::Element\n  #\n  class Result\n    include Enumerable\n    extend Forwardable\n\n    def initialize(elements, query)\n      @elements = elements\n      @result_cache = []\n      @filter_errors = []\n      @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }\n      @query = query\n      @allow_reload = false\n    end\n\n    def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample, :to_ary\n\n    alias index find_index\n\n    def each(&block)\n      return enum_for(:each) unless block\n\n      @result_cache.each(&block)\n      loop do\n        next_result = @results_enum.next\n        add_to_cache(next_result)\n        yield next_result\n      end\n      self\n    end\n\n    def [](*args)\n      idx, length = args\n      max_idx = case idx\n      when Integer\n        if idx.negative?\n          nil\n        else\n          length.nil? ? idx : idx + length - 1\n        end\n      when Range\n        # idx.max is broken with beginless ranges\n        # idx.end && idx.max # endless range will have end == nil\n        max = idx.end\n        max = nil if max&.negative?\n        max -= 1 if max && idx.exclude_end?\n        max\n      end\n\n      if max_idx.nil?\n        full_results[*args]\n      else\n        load_up_to(max_idx + 1)\n        @result_cache[*args]\n      end\n    end\n    alias :at :[]\n\n    def empty?\n      !any?\n    end\n\n    def compare_count\n      return 0 unless @query\n\n      count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)\n\n      # Only check filters for as many elements as necessary to determine result\n      if count && (count = Integer(count))\n        return load_up_to(count + 1) <=> count\n      end\n\n      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)\n\n      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)\n\n      if between\n        min, max = (between.begin && between.min) || 1, between.end\n        max -= 1 if max && between.exclude_end?\n\n        size = load_up_to(max ? max + 1 : min)\n        return size <=> min unless between.include?(size)\n      end\n\n      0\n    end\n\n    def matches_count?\n      compare_count.zero?\n    end\n\n    def failure_message\n      message = @query.failure_message\n      if count.zero?\n        message << ' but there were no matches'\n      else\n        message << \", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: \" \\\n                << full_results.map { |r| r.text.inspect }.join(', ')\n      end\n      unless rest.empty?\n        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier\n        message << '. Also found ' << elements << ', which matched the selector but not all filters. '\n        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?\n      end\n      message\n    end\n\n    def negative_failure_message\n      failure_message.sub(/(to find)/, 'not \\1')\n    end\n\n    def unfiltered_size\n      @elements.length\n    end\n\n    ##\n    # @api private\n    #\n    def allow_reload!\n      @allow_reload = true\n      self\n    end\n\n  private\n\n    def add_to_cache(elem)\n      elem.allow_reload!(@result_cache.size) if @allow_reload\n      @result_cache << elem\n    end\n\n    def load_up_to(num)\n      loop do\n        break if @result_cache.size >= num\n\n        add_to_cache(@results_enum.next)\n      end\n      @result_cache.size\n    end\n\n    def full_results\n      loop { @result_cache << @results_enum.next }\n      @result_cache\n    end\n\n    def rest\n      @rest ||= @elements - full_results\n    end\n\n    if RUBY_PLATFORM == 'java'\n      # JRuby < 9.2.8.0 has an issue with lazy enumerators which\n      # causes a concurrency issue with network requests here\n      # https://github.com/jruby/jruby/issues/4212\n      # while JRuby >= 9.2.8.0 leaks threads when using lazy enumerators\n      # https://github.com/teamcapybara/capybara/issues/2349\n      # so disable the use and JRuby users will need to pay a performance penalty\n      def lazy_select_elements(&block)\n        @elements.select(&block).to_enum # non-lazy evaluation\n      end\n    else\n      def lazy_select_elements(&block)\n        @elements.lazy.select(&block)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "[]", "signature": "def [](*args)", "start_line": 53, "end_line": 77}, "metadata": {"module": "Capybara", "class_name": "Result", "class_signature": "class Result"}, "task_id": 4}
{"function_name": "compare_count", "file_path": "capybara/lib/capybara/result.rb", "focal_code": "def compare_count\n      return 0 unless @query\n\n      count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)\n\n      # Only check filters for as many elements as necessary to determine result\n      if count && (count = Integer(count))\n        return load_up_to(count + 1) <=> count\n      end\n\n      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)\n\n      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)\n\n      if between\n        min, max = (between.begin && between.min) || 1, between.end\n        max -= 1 if max && between.exclude_end?\n\n        size = load_up_to(max ? max + 1 : min)\n        return size <=> min unless between.include?(size)\n      end\n\n      0\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\n\nmodule Capybara\n  ##\n  # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this\n  # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:\n  #\n  # * \\[\\]\n  # * each()\n  # * at()\n  # * size()\n  # * count()\n  # * length()\n  # * first()\n  # * last()\n  # * empty?()\n  # * values_at()\n  # * sample()\n  #\n  # @see Capybara::Node::Element\n  #\n  class Result\n    include Enumerable\n    extend Forwardable\n\n    def initialize(elements, query)\n      @elements = elements\n      @result_cache = []\n      @filter_errors = []\n      @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }\n      @query = query\n      @allow_reload = false\n    end\n\n    def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample, :to_ary\n\n    alias index find_index\n\n    def each(&block)\n      return enum_for(:each) unless block\n\n      @result_cache.each(&block)\n      loop do\n        next_result = @results_enum.next\n        add_to_cache(next_result)\n        yield next_result\n      end\n      self\n    end\n\n    def [](*args)\n      idx, length = args\n      max_idx = case idx\n      when Integer\n        if idx.negative?\n          nil\n        else\n          length.nil? ? idx : idx + length - 1\n        end\n      when Range\n        # idx.max is broken with beginless ranges\n        # idx.end && idx.max # endless range will have end == nil\n        max = idx.end\n        max = nil if max&.negative?\n        max -= 1 if max && idx.exclude_end?\n        max\n      end\n\n      if max_idx.nil?\n        full_results[*args]\n      else\n        load_up_to(max_idx + 1)\n        @result_cache[*args]\n      end\n    end\n    alias :at :[]\n\n    def empty?\n      !any?\n    end\n\n    def compare_count\n      return 0 unless @query\n\n      count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)\n\n      # Only check filters for as many elements as necessary to determine result\n      if count && (count = Integer(count))\n        return load_up_to(count + 1) <=> count\n      end\n\n      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)\n\n      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)\n\n      if between\n        min, max = (between.begin && between.min) || 1, between.end\n        max -= 1 if max && between.exclude_end?\n\n        size = load_up_to(max ? max + 1 : min)\n        return size <=> min unless between.include?(size)\n      end\n\n      0\n    end\n\n    def matches_count?\n      compare_count.zero?\n    end\n\n    def failure_message\n      message = @query.failure_message\n      if count.zero?\n        message << ' but there were no matches'\n      else\n        message << \", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: \" \\\n                << full_results.map { |r| r.text.inspect }.join(', ')\n      end\n      unless rest.empty?\n        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier\n        message << '. Also found ' << elements << ', which matched the selector but not all filters. '\n        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?\n      end\n      message\n    end\n\n    def negative_failure_message\n      failure_message.sub(/(to find)/, 'not \\1')\n    end\n\n    def unfiltered_size\n      @elements.length\n    end\n\n    ##\n    # @api private\n    #\n    def allow_reload!\n      @allow_reload = true\n      self\n    end\n\n  private\n\n    def add_to_cache(elem)\n      elem.allow_reload!(@result_cache.size) if @allow_reload\n      @result_cache << elem\n    end\n\n    def load_up_to(num)\n      loop do\n        break if @result_cache.size >= num\n\n        add_to_cache(@results_enum.next)\n      end\n      @result_cache.size\n    end\n\n    def full_results\n      loop { @result_cache << @results_enum.next }\n      @result_cache\n    end\n\n    def rest\n      @rest ||= @elements - full_results\n    end\n\n    if RUBY_PLATFORM == 'java'\n      # JRuby < 9.2.8.0 has an issue with lazy enumerators which\n      # causes a concurrency issue with network requests here\n      # https://github.com/jruby/jruby/issues/4212\n      # while JRuby >= 9.2.8.0 leaks threads when using lazy enumerators\n      # https://github.com/teamcapybara/capybara/issues/2349\n      # so disable the use and JRuby users will need to pay a performance penalty\n      def lazy_select_elements(&block)\n        @elements.select(&block).to_enum # non-lazy evaluation\n      end\n    else\n      def lazy_select_elements(&block)\n        @elements.lazy.select(&block)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "compare_count", "signature": "def compare_count return 0 unless @query", "start_line": 84, "end_line": 107}, "metadata": {"module": "Capybara", "class_name": "Result", "class_signature": "class Result"}, "task_id": 5}
{"function_name": "failure_message", "file_path": "capybara/lib/capybara/result.rb", "focal_code": "def failure_message\n      message = @query.failure_message\n      if count.zero?\n        message << ' but there were no matches'\n      else\n        message << \", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: \" \\\n                << full_results.map { |r| r.text.inspect }.join(', ')\n      end\n      unless rest.empty?\n        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier\n        message << '. Also found ' << elements << ', which matched the selector but not all filters. '\n        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?\n      end\n      message\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\n\nmodule Capybara\n  ##\n  # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this\n  # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:\n  #\n  # * \\[\\]\n  # * each()\n  # * at()\n  # * size()\n  # * count()\n  # * length()\n  # * first()\n  # * last()\n  # * empty?()\n  # * values_at()\n  # * sample()\n  #\n  # @see Capybara::Node::Element\n  #\n  class Result\n    include Enumerable\n    extend Forwardable\n\n    def initialize(elements, query)\n      @elements = elements\n      @result_cache = []\n      @filter_errors = []\n      @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }\n      @query = query\n      @allow_reload = false\n    end\n\n    def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample, :to_ary\n\n    alias index find_index\n\n    def each(&block)\n      return enum_for(:each) unless block\n\n      @result_cache.each(&block)\n      loop do\n        next_result = @results_enum.next\n        add_to_cache(next_result)\n        yield next_result\n      end\n      self\n    end\n\n    def [](*args)\n      idx, length = args\n      max_idx = case idx\n      when Integer\n        if idx.negative?\n          nil\n        else\n          length.nil? ? idx : idx + length - 1\n        end\n      when Range\n        # idx.max is broken with beginless ranges\n        # idx.end && idx.max # endless range will have end == nil\n        max = idx.end\n        max = nil if max&.negative?\n        max -= 1 if max && idx.exclude_end?\n        max\n      end\n\n      if max_idx.nil?\n        full_results[*args]\n      else\n        load_up_to(max_idx + 1)\n        @result_cache[*args]\n      end\n    end\n    alias :at :[]\n\n    def empty?\n      !any?\n    end\n\n    def compare_count\n      return 0 unless @query\n\n      count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)\n\n      # Only check filters for as many elements as necessary to determine result\n      if count && (count = Integer(count))\n        return load_up_to(count + 1) <=> count\n      end\n\n      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)\n\n      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)\n\n      if between\n        min, max = (between.begin && between.min) || 1, between.end\n        max -= 1 if max && between.exclude_end?\n\n        size = load_up_to(max ? max + 1 : min)\n        return size <=> min unless between.include?(size)\n      end\n\n      0\n    end\n\n    def matches_count?\n      compare_count.zero?\n    end\n\n    def failure_message\n      message = @query.failure_message\n      if count.zero?\n        message << ' but there were no matches'\n      else\n        message << \", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: \" \\\n                << full_results.map { |r| r.text.inspect }.join(', ')\n      end\n      unless rest.empty?\n        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier\n        message << '. Also found ' << elements << ', which matched the selector but not all filters. '\n        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?\n      end\n      message\n    end\n\n    def negative_failure_message\n      failure_message.sub(/(to find)/, 'not \\1')\n    end\n\n    def unfiltered_size\n      @elements.length\n    end\n\n    ##\n    # @api private\n    #\n    def allow_reload!\n      @allow_reload = true\n      self\n    end\n\n  private\n\n    def add_to_cache(elem)\n      elem.allow_reload!(@result_cache.size) if @allow_reload\n      @result_cache << elem\n    end\n\n    def load_up_to(num)\n      loop do\n        break if @result_cache.size >= num\n\n        add_to_cache(@results_enum.next)\n      end\n      @result_cache.size\n    end\n\n    def full_results\n      loop { @result_cache << @results_enum.next }\n      @result_cache\n    end\n\n    def rest\n      @rest ||= @elements - full_results\n    end\n\n    if RUBY_PLATFORM == 'java'\n      # JRuby < 9.2.8.0 has an issue with lazy enumerators which\n      # causes a concurrency issue with network requests here\n      # https://github.com/jruby/jruby/issues/4212\n      # while JRuby >= 9.2.8.0 leaks threads when using lazy enumerators\n      # https://github.com/teamcapybara/capybara/issues/2349\n      # so disable the use and JRuby users will need to pay a performance penalty\n      def lazy_select_elements(&block)\n        @elements.select(&block).to_enum # non-lazy evaluation\n      end\n    else\n      def lazy_select_elements(&block)\n        @elements.lazy.select(&block)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "failure_message", "signature": "def failure_message message = @query.failure_message", "start_line": 113, "end_line": 127}, "metadata": {"module": "Capybara", "class_name": "Result", "class_signature": "class Result"}, "task_id": 6}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/server.rb", "focal_code": "def initialize(app,\n                   *deprecated_options,\n                   port: Capybara.server_port,\n                   host: Capybara.server_host,\n                   reportable_errors: Capybara.server_errors,\n                   extra_middleware: [])\n      unless deprecated_options.empty?\n        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'\n      end\n      @app = app\n      @extra_middleware = extra_middleware\n      @server_thread = nil # suppress warnings\n      @host = deprecated_options[1] || host\n      @reportable_errors = deprecated_options[2] || reportable_errors\n      @port = deprecated_options[0] || port\n      @port ||= Capybara::Server.ports[port_key]\n      @port ||= find_available_port(host)\n      @checker = Checker.new(@host, @port)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'net/http'\nrequire 'rack'\nrequire 'capybara/server/middleware'\nrequire 'capybara/server/animation_disabler'\nrequire 'capybara/server/checker'\n\nmodule Capybara\n  # @api private\n  class Server\n    class << self\n      def ports\n        @ports ||= {}\n      end\n    end\n\n    attr_reader :app, :port, :host\n\n    def initialize(app,\n                   *deprecated_options,\n                   port: Capybara.server_port,\n                   host: Capybara.server_host,\n                   reportable_errors: Capybara.server_errors,\n                   extra_middleware: [])\n      unless deprecated_options.empty?\n        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'\n      end\n      @app = app\n      @extra_middleware = extra_middleware\n      @server_thread = nil # suppress warnings\n      @host = deprecated_options[1] || host\n      @reportable_errors = deprecated_options[2] || reportable_errors\n      @port = deprecated_options[0] || port\n      @port ||= Capybara::Server.ports[port_key]\n      @port ||= find_available_port(host)\n      @checker = Checker.new(@host, @port)\n    end\n\n    def reset_error!\n      middleware.clear_error\n    end\n\n    def error\n      middleware.error\n    end\n\n    def using_ssl?\n      @checker.ssl?\n    end\n\n    def responsive?\n      return false if @server_thread&.join(0)\n\n      res = @checker.request { |http| http.get('/__identify__') }\n\n      res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)\n    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError\n      false\n    end\n\n    def wait_for_pending_requests\n      timer = Capybara::Helpers.timer(expire_in: 60)\n      while pending_requests?\n        raise \"Requests did not finish in 60 seconds: #{middleware.pending_requests}\" if timer.expired?\n\n        sleep 0.01\n      end\n    end\n\n    def boot\n      unless responsive?\n        Capybara::Server.ports[port_key] = port\n\n        @server_thread = Thread.new do\n          Capybara.server.call(middleware, port, host)\n        end\n\n        timer = Capybara::Helpers.timer(expire_in: 60)\n        until responsive?\n          raise 'Rack application timed out during boot' if timer.expired?\n\n          @server_thread.join(0.1)\n        end\n      end\n\n      self\n    end\n\n    def base_url\n      \"http#{'s' if using_ssl?}://#{host}:#{port}\"\n    end\n\n  private\n\n    def middleware\n      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)\n    end\n\n    def port_key\n      Capybara.reuse_server ? app.object_id : middleware.object_id\n    end\n\n    def pending_requests?\n      middleware.pending_requests?\n    end\n\n    def find_available_port(host)\n      server = TCPServer.new(host, 0)\n      port = server.addr[1]\n      server.close\n\n      # Workaround issue where some platforms (mac, ???) when passed a host\n      # of '0.0.0.0' will return a port that is only available on one of the\n      # ip addresses that resolves to, but the next binding to that port requires\n      # that port to be available on all ips\n      server = TCPServer.new(host, port)\n      port\n    rescue Errno::EADDRINUSE\n      retry\n    ensure\n      server&.close\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: [])", "start_line": 21, "end_line": 39}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 7}
{"function_name": "boot", "file_path": "capybara/lib/capybara/server.rb", "focal_code": "def boot\n      unless responsive?\n        Capybara::Server.ports[port_key] = port\n\n        @server_thread = Thread.new do\n          Capybara.server.call(middleware, port, host)\n        end\n\n        timer = Capybara::Helpers.timer(expire_in: 60)\n        until responsive?\n          raise 'Rack application timed out during boot' if timer.expired?\n\n          @server_thread.join(0.1)\n        end\n      end\n\n      self\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'net/http'\nrequire 'rack'\nrequire 'capybara/server/middleware'\nrequire 'capybara/server/animation_disabler'\nrequire 'capybara/server/checker'\n\nmodule Capybara\n  # @api private\n  class Server\n    class << self\n      def ports\n        @ports ||= {}\n      end\n    end\n\n    attr_reader :app, :port, :host\n\n    def initialize(app,\n                   *deprecated_options,\n                   port: Capybara.server_port,\n                   host: Capybara.server_host,\n                   reportable_errors: Capybara.server_errors,\n                   extra_middleware: [])\n      unless deprecated_options.empty?\n        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'\n      end\n      @app = app\n      @extra_middleware = extra_middleware\n      @server_thread = nil # suppress warnings\n      @host = deprecated_options[1] || host\n      @reportable_errors = deprecated_options[2] || reportable_errors\n      @port = deprecated_options[0] || port\n      @port ||= Capybara::Server.ports[port_key]\n      @port ||= find_available_port(host)\n      @checker = Checker.new(@host, @port)\n    end\n\n    def reset_error!\n      middleware.clear_error\n    end\n\n    def error\n      middleware.error\n    end\n\n    def using_ssl?\n      @checker.ssl?\n    end\n\n    def responsive?\n      return false if @server_thread&.join(0)\n\n      res = @checker.request { |http| http.get('/__identify__') }\n\n      res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)\n    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError\n      false\n    end\n\n    def wait_for_pending_requests\n      timer = Capybara::Helpers.timer(expire_in: 60)\n      while pending_requests?\n        raise \"Requests did not finish in 60 seconds: #{middleware.pending_requests}\" if timer.expired?\n\n        sleep 0.01\n      end\n    end\n\n    def boot\n      unless responsive?\n        Capybara::Server.ports[port_key] = port\n\n        @server_thread = Thread.new do\n          Capybara.server.call(middleware, port, host)\n        end\n\n        timer = Capybara::Helpers.timer(expire_in: 60)\n        until responsive?\n          raise 'Rack application timed out during boot' if timer.expired?\n\n          @server_thread.join(0.1)\n        end\n      end\n\n      self\n    end\n\n    def base_url\n      \"http#{'s' if using_ssl?}://#{host}:#{port}\"\n    end\n\n  private\n\n    def middleware\n      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)\n    end\n\n    def port_key\n      Capybara.reuse_server ? app.object_id : middleware.object_id\n    end\n\n    def pending_requests?\n      middleware.pending_requests?\n    end\n\n    def find_available_port(host)\n      server = TCPServer.new(host, 0)\n      port = server.addr[1]\n      server.close\n\n      # Workaround issue where some platforms (mac, ???) when passed a host\n      # of '0.0.0.0' will return a port that is only available on one of the\n      # ip addresses that resolves to, but the next binding to that port requires\n      # that port to be available on all ips\n      server = TCPServer.new(host, port)\n      port\n    rescue Errno::EADDRINUSE\n      retry\n    ensure\n      server&.close\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "boot", "signature": "def boot unless responsive?", "start_line": 72, "end_line": 89}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 8}
{"function_name": "find_available_port", "file_path": "capybara/lib/capybara/server.rb", "focal_code": "def find_available_port(host)\n      server = TCPServer.new(host, 0)\n      port = server.addr[1]\n      server.close\n\n      # Workaround issue where some platforms (mac, ???) when passed a host\n      # of '0.0.0.0' will return a port that is only available on one of the\n      # ip addresses that resolves to, but the next binding to that port requires\n      # that port to be available on all ips\n      server = TCPServer.new(host, port)\n      port\n    rescue Errno::EADDRINUSE\n      retry\n    ensure\n      server&.close\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'net/http'\nrequire 'rack'\nrequire 'capybara/server/middleware'\nrequire 'capybara/server/animation_disabler'\nrequire 'capybara/server/checker'\n\nmodule Capybara\n  # @api private\n  class Server\n    class << self\n      def ports\n        @ports ||= {}\n      end\n    end\n\n    attr_reader :app, :port, :host\n\n    def initialize(app,\n                   *deprecated_options,\n                   port: Capybara.server_port,\n                   host: Capybara.server_host,\n                   reportable_errors: Capybara.server_errors,\n                   extra_middleware: [])\n      unless deprecated_options.empty?\n        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'\n      end\n      @app = app\n      @extra_middleware = extra_middleware\n      @server_thread = nil # suppress warnings\n      @host = deprecated_options[1] || host\n      @reportable_errors = deprecated_options[2] || reportable_errors\n      @port = deprecated_options[0] || port\n      @port ||= Capybara::Server.ports[port_key]\n      @port ||= find_available_port(host)\n      @checker = Checker.new(@host, @port)\n    end\n\n    def reset_error!\n      middleware.clear_error\n    end\n\n    def error\n      middleware.error\n    end\n\n    def using_ssl?\n      @checker.ssl?\n    end\n\n    def responsive?\n      return false if @server_thread&.join(0)\n\n      res = @checker.request { |http| http.get('/__identify__') }\n\n      res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)\n    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError\n      false\n    end\n\n    def wait_for_pending_requests\n      timer = Capybara::Helpers.timer(expire_in: 60)\n      while pending_requests?\n        raise \"Requests did not finish in 60 seconds: #{middleware.pending_requests}\" if timer.expired?\n\n        sleep 0.01\n      end\n    end\n\n    def boot\n      unless responsive?\n        Capybara::Server.ports[port_key] = port\n\n        @server_thread = Thread.new do\n          Capybara.server.call(middleware, port, host)\n        end\n\n        timer = Capybara::Helpers.timer(expire_in: 60)\n        until responsive?\n          raise 'Rack application timed out during boot' if timer.expired?\n\n          @server_thread.join(0.1)\n        end\n      end\n\n      self\n    end\n\n    def base_url\n      \"http#{'s' if using_ssl?}://#{host}:#{port}\"\n    end\n\n  private\n\n    def middleware\n      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)\n    end\n\n    def port_key\n      Capybara.reuse_server ? app.object_id : middleware.object_id\n    end\n\n    def pending_requests?\n      middleware.pending_requests?\n    end\n\n    def find_available_port(host)\n      server = TCPServer.new(host, 0)\n      port = server.addr[1]\n      server.close\n\n      # Workaround issue where some platforms (mac, ???) when passed a host\n      # of '0.0.0.0' will return a port that is only available on one of the\n      # ip addresses that resolves to, but the next binding to that port requires\n      # that port to be available on all ips\n      server = TCPServer.new(host, port)\n      port\n    rescue Errno::EADDRINUSE\n      retry\n    ensure\n      server&.close\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_available_port", "signature": "def find_available_port(host)", "start_line": 109, "end_line": 124}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 9}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(mode, app = nil)", "start_line": 79, "end_line": 98}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 10}
{"function_name": "driver", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "driver", "signature": "def driver @driver ||= begin", "start_line": 100, "end_line": 110}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 11}
{"function_name": "reset!", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "reset!", "signature": "def reset! if @touched", "start_line": 130, "end_line": 139}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 12}
{"function_name": "raise_server_error!", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "raise_server_error!", "signature": "def raise_server_error! return unless @server&.error", "start_line": 158, "end_line": 171}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 13}
{"function_name": "visit", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "visit", "signature": "def visit(visit_uri)", "start_line": 261, "end_line": 282}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 14}
{"function_name": "switch_to_frame", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "switch_to_frame", "signature": "def switch_to_frame(frame)", "start_line": 408, "end_line": 434}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 15}
{"function_name": "within_window", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "within_window", "signature": "def within_window(window_or_proc)", "start_line": 545, "end_line": 566}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 16}
{"function_name": "window_opened_by", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "window_opened_by", "signature": "def window_opened_by(**options)", "start_line": 581, "end_line": 593}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 17}
{"function_name": "using_wait_time", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "using_wait_time", "signature": "def using_wait_time(seconds, &block)", "start_line": 800, "end_line": 812}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 18}
{"function_name": "element_script_result", "file_path": "capybara/lib/capybara/session.rb", "focal_code": "def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/session/matchers'\nrequire 'addressable/uri'\n\nmodule Capybara\n  ##\n  #\n  # The {Session} class represents a single user's interaction with the system. The {Session} can use\n  # any of the underlying drivers. A session can be initialized manually like this:\n  #\n  #     session = Capybara::Session.new(:culerity, MyRackApp)\n  #\n  # The application given as the second argument is optional. When running Capybara against an external\n  # page, you might want to leave it out:\n  #\n  #     session = Capybara::Session.new(:culerity)\n  #     session.visit('http://www.google.com')\n  #\n  # When {Capybara.configure threadsafe} is `true` the sessions options will be initially set to the\n  # current values of the global options and a configuration block can be passed to the session initializer.\n  # For available options see {Capybara::SessionConfig::OPTIONS}:\n  #\n  #     session = Capybara::Session.new(:driver, MyRackApp) do |config|\n  #       config.app_host = \"http://my_host.dev\"\n  #     end\n  #\n  # The {Session} provides a number of methods for controlling the navigation of the page, such as {#visit},\n  # {#current_path}, and so on. It also delegates a number of methods to a {Capybara::Document}, representing\n  # the current HTML document. This allows interaction:\n  #\n  #     session.fill_in('q', with: 'Capybara')\n  #     session.click_button('Search')\n  #     expect(session).to have_content('Capybara')\n  #\n  # When using `capybara/dsl`, the {Session} is initialized automatically for you.\n  #\n  class Session\n    include Capybara::SessionMatchers\n\n    NODE_METHODS = %i[\n      all first attach_file text check choose scroll_to scroll_by\n      click double_click right_click\n      click_link_or_button click_button click_link\n      fill_in find find_all find_button find_by_id find_field find_link\n      has_content? has_text? has_css? has_no_content? has_no_text?\n      has_no_css? has_no_xpath? has_xpath? select uncheck\n      has_element? has_no_element?\n      has_link? has_no_link? has_button? has_no_button? has_field?\n      has_no_field? has_checked_field? has_unchecked_field?\n      has_no_table? has_table? unselect has_select? has_no_select?\n      has_selector? has_no_selector? click_on has_no_checked_field?\n      has_no_unchecked_field? query assert_selector assert_no_selector\n      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors\n      refute_selector assert_text assert_no_text\n    ].freeze\n    # @api private\n    DOCUMENT_METHODS = %i[\n      title assert_title assert_no_title has_title? has_no_title?\n    ].freeze\n    SESSION_METHODS = %i[\n      body html source current_url current_host current_path\n      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys\n      within within_element within_fieldset within_table within_frame switch_to_frame\n      current_window windows open_new_window switch_to_window within_window window_opened_by\n      save_page save_and_open_page save_screenshot\n      save_and_open_screenshot reset_session! response_headers\n      status_code current_scope\n      assert_current_path assert_no_current_path has_current_path? has_no_current_path?\n    ].freeze + DOCUMENT_METHODS\n    MODAL_METHODS = %i[\n      accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt\n    ].freeze\n    DSL_METHODS = NODE_METHODS + SESSION_METHODS + MODAL_METHODS\n\n    attr_reader :mode, :app, :server\n    attr_accessor :synchronized\n\n    def initialize(mode, app = nil)\n      if app && !app.respond_to?(:call)\n        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'\n      end\n\n      @@instance_created = true # rubocop:disable Style/ClassVars\n      @mode = mode\n      @app = app\n      if block_given?\n        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n        yield config\n      end\n      @server = if config.run_server && @app && driver.needs_server?\n        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }\n        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation\n        Capybara::Server.new(@app, **server_options).boot\n      end\n      @touched = false\n    end\n\n    def driver\n      @driver ||= begin\n        unless Capybara.drivers[mode]\n          other_drivers = Capybara.drivers.names.map(&:inspect)\n          raise Capybara::DriverNotFoundError, \"no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}\"\n        end\n        driver = Capybara.drivers[mode].call(app)\n        driver.session = self if driver.respond_to?(:session=)\n        driver\n      end\n    end\n\n    ##\n    #\n    # Reset the session (i.e. remove cookies and navigate to blank page).\n    #\n    # This method does not:\n    #\n    # * accept modal dialogs if they are present (Selenium driver now does, others may not)\n    # * clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.\n    # * modify state of the driver/underlying browser in any other way\n    #\n    # as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.\n    #\n    # If you want to do anything from the list above on a general basis you can:\n    #\n    # * write RSpec/Cucumber/etc. after hook\n    # * monkeypatch this method\n    # * use Ruby's `prepend` method\n    #\n    def reset!\n      if @touched\n        driver.reset!\n        @touched = false\n        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier\n        @scopes = [nil]\n      end\n      @server&.wait_for_pending_requests\n      raise_server_error!\n    end\n    alias_method :cleanup!, :reset!\n    alias_method :reset_session!, :reset!\n\n    ##\n    #\n    # Disconnect from the current driver. A new driver will be instantiated on the next interaction.\n    #\n    def quit\n      @driver.quit if @driver.respond_to? :quit\n      @document = @driver = nil\n      @touched = false\n      @server&.reset_error!\n    end\n\n    ##\n    #\n    # Raise errors encountered in the server.\n    #\n    def raise_server_error!\n      return unless @server&.error\n\n      # Force an explanation for the error being raised as the exception cause\n      begin\n        if config.raise_server_errors\n          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'\n        end\n      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName\n        raise @server.error, cause: capy_error\n      ensure\n        @server.reset_error!\n      end\n    end\n\n    ##\n    #\n    # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Hash<String, String>] A hash of response headers.\n    #\n    def response_headers\n      driver.response_headers\n    end\n\n    ##\n    #\n    # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium).\n    #\n    # @return [Integer] Current HTTP status code\n    #\n    def status_code\n      driver.status_code\n    end\n\n    ##\n    #\n    # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).\n    #\n    def html\n      driver.html || ''\n    end\n    alias_method :body, :html\n    alias_method :source, :html\n\n    ##\n    #\n    # @return [String] Path of the current page, without any domain information\n    #\n    def current_path\n      # Addressable parsing is more lenient than URI\n      uri = ::Addressable::URI.parse(current_url)\n\n      # Addressable doesn't support opaque URIs - we want nil here\n      return nil if uri&.scheme == 'about'\n\n      path = uri&.path\n      path unless path&.empty?\n    end\n\n    ##\n    #\n    # @return [String] Host of the current page\n    #\n    def current_host\n      uri = URI.parse(current_url)\n      \"#{uri.scheme}://#{uri.host}\" if uri.host\n    end\n\n    ##\n    #\n    # @return [String] Fully qualified URL of the current page\n    #\n    def current_url\n      driver.current_url\n    end\n\n    ##\n    #\n    # Navigate to the given URL. The URL can either be a relative URL or an absolute URL\n    # The behaviour of either depends on the driver.\n    #\n    #     session.visit('/foo')\n    #     session.visit('http://google.com')\n    #\n    # For drivers which can run against an external application, such as the selenium driver\n    # giving an absolute URL will navigate to that page. This allows testing applications\n    # running on remote servers. For these drivers, setting {Capybara.configure app_host} will make the\n    # remote server the default. For example:\n    #\n    #     Capybara.app_host = 'http://google.com'\n    #     session.visit('/') # visits the google homepage\n    #\n    # If {Capybara.configure always_include_port} is set to `true` and this session is running against\n    # a rack application, then the port that the rack application is running on will automatically\n    # be inserted into the URL. Supposing the app is running on port `4567`, doing something like:\n    #\n    #     visit(\"http://google.com/test\")\n    #\n    # Will actually navigate to `http://google.com:4567/test`.\n    #\n    # @param [#to_s] visit_uri     The URL to navigate to. The parameter will be cast to a String.\n    #\n    def visit(visit_uri)\n      raise_server_error!\n      @touched = true\n\n      visit_uri = ::Addressable::URI.parse(visit_uri.to_s)\n      base_uri = ::Addressable::URI.parse(config.app_host || server_url)\n\n      if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)\n        if visit_uri.relative?\n          visit_uri_parts = visit_uri.to_hash.compact\n\n          # Useful to people deploying to a subdirectory\n          # and/or single page apps where only the url fragment changes\n          visit_uri_parts[:path] = base_uri.path + visit_uri.path\n\n          visit_uri = base_uri.merge(visit_uri_parts)\n        end\n        adjust_server_port(visit_uri)\n      end\n\n      driver.visit(visit_uri.to_s)\n    end\n\n    ##\n    #\n    # Refresh the page.\n    #\n    def refresh\n      raise_server_error!\n      driver.refresh\n    end\n\n    ##\n    #\n    # Move back a single entry in the browser's history.\n    #\n    def go_back\n      driver.go_back\n    end\n\n    ##\n    #\n    # Move forward a single entry in the browser's history.\n    #\n    def go_forward\n      driver.go_forward\n    end\n\n    ##\n    # @!method send_keys\n    #   @see Capybara::Node::Element#send_keys\n    #\n    def send_keys(...)\n      driver.send_keys(...)\n    end\n\n    ##\n    #\n    # Returns the element with focus.\n    #\n    # Not supported by Rack Test\n    #\n    def active_element\n      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)\n    end\n\n    ##\n    #\n    # Executes the given block within the context of a node. {#within} takes the\n    # same options as {Capybara::Node::Finders#find #find}, as well as a block. For the duration of the\n    # block, any command to Capybara will be handled as though it were scoped\n    # to the given element.\n    #\n    #     within(:xpath, './/div[@id=\"delivery-address\"]') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Just as with `#find`, if multiple elements match the selector given to\n    # {#within}, an error will be raised, and just as with `#find`, this\n    # behaviour can be controlled through the `:match` and `:exact` options.\n    #\n    # It is possible to omit the first parameter, in that case, the selector is\n    # assumed to be of the type set in {Capybara.configure default_selector}.\n    #\n    #     within('div#delivery-address') do\n    #       fill_in('Street', with: '12 Main Street')\n    #     end\n    #\n    # Note that a lot of uses of {#within} can be replaced more succinctly with\n    # chaining:\n    #\n    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')\n    #\n    # @overload within(*find_args)\n    #   @param (see Capybara::Node::Finders#all)\n    #\n    # @overload within(a_node)\n    #   @param [Capybara::Node::Base] a_node   The node in whose scope the block should be evaluated\n    #\n    # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires\n    #\n    def within(*args, **kw_args)\n      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)\n      begin\n        scopes.push(new_scope)\n        yield new_scope if block_given?\n      ensure\n        scopes.pop\n      end\n    end\n    alias_method :within_element, :within\n\n    ##\n    #\n    # Execute the given block within the a specific fieldset given the id or legend of that fieldset.\n    #\n    # @param [String] locator    Id or legend of the fieldset\n    #\n    def within_fieldset(locator, &block)\n      within(:fieldset, locator, &block)\n    end\n\n    ##\n    #\n    # Execute the given block within the a specific table given the id or caption of that table.\n    #\n    # @param [String] locator    Id or caption of the table\n    #\n    def within_table(locator, &block)\n      within(:table, locator, &block)\n    end\n\n    ##\n    #\n    # Switch to the given frame.\n    #\n    # If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to.\n    # {#within_frame} is preferred over this method and should be used when possible.\n    # May not be supported by all drivers.\n    #\n    # @overload switch_to_frame(element)\n    #   @param [Capybara::Node::Element] element    iframe/frame element to switch to\n    # @overload switch_to_frame(location)\n    #   @param [Symbol] location relative location of the frame to switch to\n    #                            * :parent - the parent frame\n    #                            * :top - the top level document\n    #\n    def switch_to_frame(frame)\n      case frame\n      when Capybara::Node::Element\n        driver.switch_to_frame(frame)\n        scopes.push(:frame)\n      when :parent\n        if scopes.last != :frame\n          raise Capybara::ScopeError, \"`switch_to_frame(:parent)` cannot be called from inside a descendant frame's \" \\\n                                      '`within` block.'\n        end\n        scopes.pop\n        driver.switch_to_frame(:parent)\n      when :top\n        idx = scopes.index(:frame)\n        top_level_scopes = [:frame, nil]\n        if idx\n          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }\n            raise Capybara::ScopeError, \"`switch_to_frame(:top)` cannot be called from inside a descendant frame's \" \\\n                                        '`within` block.'\n          end\n          scopes.slice!(idx..)\n          driver.switch_to_frame(:top)\n        end\n      else\n        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'\n      end\n    end\n\n    ##\n    #\n    # Execute the given block within the given iframe using given frame, frame name/id or index.\n    # May not be supported by all drivers.\n    #\n    # @overload within_frame(element)\n    #   @param [Capybara::Node::Element]  frame element\n    # @overload within_frame([kind = :frame], locator, **options)\n    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame\n    #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element\n    # @overload within_frame(index)\n    #   @param [Integer] index         index of a frame (0 based)\n    def within_frame(*args, **kw_args)\n      switch_to_frame(_find_frame(*args, **kw_args))\n      begin\n        yield if block_given?\n      ensure\n        switch_to_frame(:parent)\n      end\n    end\n\n    ##\n    # @return [Capybara::Window]   current window\n    #\n    def current_window\n      Window.new(self, driver.current_window_handle)\n    end\n\n    ##\n    # Get all opened windows.\n    # The order of windows in returned array is not defined.\n    # The driver may sort windows by their creation time but it's not required.\n    #\n    # @return [Array<Capybara::Window>]   an array of all windows\n    #\n    def windows\n      driver.window_handles.map do |handle|\n        Window.new(self, handle)\n      end\n    end\n\n    ##\n    # Open a new window.\n    # The current window doesn't change as the result of this call.\n    # It should be switched to explicitly.\n    #\n    # @return [Capybara::Window]   window that has been opened\n    #\n    def open_new_window(kind = :tab)\n      window_opened_by do\n        if driver.method(:open_new_window).arity.zero?\n          driver.open_new_window\n        else\n          driver.open_new_window(kind)\n        end\n      end\n    end\n\n    ##\n    # Switch to the given window.\n    #\n    # @overload switch_to_window(&block)\n    #   Switches to the first window for which given block returns a value other than false or nil.\n    #   If window that matches block can't be found, the window will be switched back and {Capybara::WindowError} will be raised.\n    #   @example\n    #     window = switch_to_window { title == 'Page title' }\n    #   @raise [Capybara::WindowError]     if no window matches given block\n    # @overload switch_to_window(window)\n    #   @param window [Capybara::Window]   window that should be switched to\n    #   @raise [Capybara::Driver::Base#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    #\n    # @return [Capybara::Window]         window that has been switched to\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within} or\n    #   {#within_frame} methods\n    # @raise [ArgumentError]               if both or neither arguments were provided\n    #\n    def switch_to_window(window = nil, **options, &window_locator)\n      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator\n      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator\n\n      unless scopes.last.nil?\n        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \\\n                                    '`within` or `within_frame` blocks.'\n      end\n\n      _switch_to_window(window, **options, &window_locator)\n    end\n\n    ##\n    # This method does the following:\n    #\n    # 1. Switches to the given window (it can be located by window instance/lambda/string).\n    # 2. Executes the given block (within window located at previous step).\n    # 3. Switches back (this step will be invoked even if an exception occurs at the second step).\n    #\n    # @overload within_window(window) { do_something }\n    #   @param window [Capybara::Window]       instance of {Capybara::Window} class\n    #     that will be switched to\n    #   @raise [driver#no_such_window_error] if nonexistent (e.g. closed) window was passed\n    # @overload within_window(proc_or_lambda) { do_something }\n    #   @param lambda [Proc]                  First window for which lambda\n    #     returns a value other than false or nil will be switched to.\n    #   @example\n    #     within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }\n    #   @raise [Capybara::WindowError]         if no window matching lambda was found\n    #\n    # @raise [Capybara::ScopeError]        if this method is invoked inside {#within_frame} method\n    # @return                              value returned by the block\n    #\n    def within_window(window_or_proc)\n      original = current_window\n      scopes << nil\n      begin\n        case window_or_proc\n        when Capybara::Window\n          _switch_to_window(window_or_proc) unless original == window_or_proc\n        when Proc\n          _switch_to_window { window_or_proc.call }\n        else\n          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'\n        end\n\n        begin\n          yield if block_given?\n        ensure\n          _switch_to_window(original) unless original == window_or_proc\n        end\n      ensure\n        scopes.pop\n      end\n    end\n\n    ##\n    # Get the window that has been opened by the passed block.\n    # It will wait for it to be opened (in the same way as other Capybara methods wait).\n    # It's better to use this method than `windows.last`\n    # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}.\n    #\n    # @overload window_opened_by(**options, &block)\n    #   @param options [Hash]\n    #   @option options [Numeric] :wait  maximum wait time. Defaults to {Capybara.configure default_max_wait_time}\n    #   @return [Capybara::Window]       the window that has been opened within a block\n    #   @raise [Capybara::WindowError]   if block passed to window hasn't opened window\n    #     or opened more than one window\n    #\n    def window_opened_by(**options)\n      old_handles = driver.window_handles\n      yield\n\n      synchronize_windows(options) do\n        opened_handles = (driver.window_handles - old_handles)\n        if opened_handles.size != 1\n          raise Capybara::WindowError, 'block passed to #window_opened_by ' \\\n                                       \"opened #{opened_handles.size} windows instead of 1\"\n        end\n        Window.new(self, opened_handles.first)\n      end\n    end\n\n    ##\n    #\n    # Execute the given script, not returning a result. This is useful for scripts that return\n    # complex objects, such as jQuery statements. {#execute_script} should be used over\n    # {#evaluate_script} whenever possible.\n    #\n    # @param [String] script   A string of JavaScript to execute\n    # @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 drivers\n    #\n    def execute_script(script, *args)\n      @touched = true\n      driver.execute_script(script, *driver_args(args))\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and return the result. Be careful when using this with\n    # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n    # be a better alternative.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_script(script, *args)\n      @touched = true\n      result = driver.evaluate_script(script.strip, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.\n    #\n    # @param  [String] script   A string of JavaScript to evaluate\n    # @param           args     Optional arguments that will be passed to the script\n    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n    #\n    def evaluate_async_script(script, *args)\n      @touched = true\n      result = driver.evaluate_async_script(script, *driver_args(args))\n      element_script_result(result)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a alert.\n    #\n    # @!macro modal_params\n    #   Expects a block whose actions will trigger the display modal to appear.\n    #   @example\n    #     $0 do\n    #       click_link('link that triggers appearance of system modal')\n    #     end\n    #   @overload $0(text, **options, &blk)\n    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @overload $0(**options, &blk)\n    #     @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}.\n    #     @yield Block whose actions will trigger the system modal\n    #   @return [String]  the message shown in the modal\n    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found\n    #\n    def accept_alert(text = nil, **options, &blk)\n      accept_modal(:alert, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a confirm.\n    #\n    # @macro modal_params\n    #\n    def accept_confirm(text = nil, **options, &blk)\n      accept_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a confirm.\n    #\n    # @macro modal_params\n    #\n    def dismiss_confirm(text = nil, **options, &blk)\n      dismiss_modal(:confirm, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, accepting a prompt, optionally responding to the prompt.\n    #\n    # @macro modal_params\n    # @option options [String] :with   Response to provide to the prompt\n    #\n    def accept_prompt(text = nil, **options, &blk)\n      accept_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Execute the block, dismissing a prompt.\n    #\n    # @macro modal_params\n    #\n    def dismiss_prompt(text = nil, **options, &blk)\n      dismiss_modal(:prompt, text, options, &blk)\n    end\n\n    ##\n    #\n    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag\n    # pointing to {Capybara.configure asset_host}.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    # @return [String]      the path to which the file was saved\n    #\n    def save_page(path = nil)\n      prepare_path(path, 'html').tap do |p_path|\n        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')\n      end\n    end\n\n    ##\n    #\n    # Save a snapshot of the page and open it in a browser for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path  the path to where it should be saved\n    #\n    def save_and_open_page(path = nil)\n      save_page(path).tap { |s_path| open_file(s_path) }\n    end\n\n    ##\n    #\n    # Save a screenshot of page.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    # @return [String]        the path to which the file was saved\n    def save_screenshot(path = nil, **options)\n      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }\n    end\n\n    ##\n    #\n    # Save a screenshot of the page and open it for inspection.\n    #\n    # If invoked without arguments it will save file to {Capybara.configure save_path}\n    # and file will be given randomly generated filename. If invoked with a relative path\n    # the path will be relative to {Capybara.configure save_path}.\n    #\n    # @param [String] path    the path to where it should be saved\n    # @param [Hash] options   a customizable set of options\n    #\n    def save_and_open_screenshot(path = nil, **options)\n      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }\n    end\n\n    def document\n      @document ||= Capybara::Node::Document.new(self, driver)\n    end\n\n    NODE_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          @touched = true\n          current_scope.#{method}(...)\n        end\n      METHOD\n    end\n\n    DOCUMENT_METHODS.each do |method|\n      class_eval <<~METHOD, __FILE__, __LINE__ + 1\n        def #{method}(...)\n          document.#{method}(...)\n        end\n      METHOD\n    end\n\n    def inspect\n      %(#<Capybara::Session>)\n    end\n\n    def current_scope\n      scope = scopes.last\n      [nil, :frame].include?(scope) ? document : scope\n    end\n\n    ##\n    #\n    # Yield a block using a specific maximum wait time.\n    #\n    def using_wait_time(seconds, &block)\n      if Capybara.threadsafe\n        begin\n          previous_wait_time = config.default_max_wait_time\n          config.default_max_wait_time = seconds\n          yield\n        ensure\n          config.default_max_wait_time = previous_wait_time\n        end\n      else\n        Capybara.using_wait_time(seconds, &block)\n      end\n    end\n\n    ##\n    #\n    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect\n    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.\n    #\n    def configure\n      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe\n\n      yield config\n    end\n\n    def self.instance_created?\n      @@instance_created\n    end\n\n    def config\n      @config ||= if Capybara.threadsafe\n        Capybara.session_options.dup\n      else\n        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)\n      end\n    end\n\n    def server_url\n      @server&.base_url\n    end\n\n  private\n\n    @@instance_created = false # rubocop:disable Style/ClassVars\n\n    def driver_args(args)\n      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }\n    end\n\n    def accept_modal(type, text_or_options, options, &blk)\n      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def dismiss_modal(type, text_or_options, options, &blk)\n      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)\n    end\n\n    def modal_options(text = nil, **options)\n      options[:text] ||= text unless text.nil?\n      options[:wait] ||= config.default_max_wait_time\n      options\n    end\n\n    def open_file(path)\n      require 'launchy'\n      Launchy.open(path)\n    rescue LoadError\n      warn \"File saved to #{path}.\\nPlease install the launchy gem to open the file automatically.\"\n    end\n\n    def prepare_path(path, extension)\n      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|\n        FileUtils.mkdir_p(File.dirname(p_path))\n      end\n    end\n\n    def default_fn(extension)\n      timestamp = Time.new.strftime('%Y%m%d%H%M%S')\n      \"capybara-#{timestamp}#{rand(10**10)}.#{extension}\"\n    end\n\n    def scopes\n      @scopes ||= [nil]\n    end\n\n    def element_script_result(arg)\n      case arg\n      when Array\n        arg.map { |subarg| element_script_result(subarg) }\n      when Hash\n        arg.transform_values! { |value| element_script_result(value) }\n      when Capybara::Driver::Node\n        Capybara::Node::Element.new(self, arg, nil, nil)\n      else\n        arg\n      end\n    end\n\n    def adjust_server_port(uri)\n      uri.port ||= @server.port if @server && config.always_include_port\n    end\n\n    def _find_frame(*args, **kw_args)\n      case args[0]\n      when Capybara::Node::Element\n        args[0]\n      when String, nil\n        find(:frame, *args, **kw_args)\n      when Symbol\n        find(*args, **kw_args)\n      when Integer\n        idx = args[0]\n        all(:frame, minimum: idx + 1)[idx]\n      else\n        raise TypeError\n      end\n    end\n\n    def _switch_to_window(window = nil, **options, &window_locator)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)\n      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?\n\n      if window\n        driver.switch_to_window(window.handle)\n        window\n      else\n        synchronize_windows(options) do\n          original_window_handle = driver.current_window_handle\n          begin\n            _switch_to_window_by_locator(&window_locator)\n          rescue StandardError\n            driver.switch_to_window(original_window_handle)\n            raise\n          end\n        end\n      end\n    end\n\n    def _switch_to_window_by_locator\n      driver.window_handles.each do |handle|\n        driver.switch_to_window handle\n        return Window.new(self, handle) if yield\n      end\n      raise Capybara::WindowError, 'Could not find a window matching block/lambda'\n    end\n\n    def synchronize_windows(options, &block)\n      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)\n      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "element_script_result", "signature": "def element_script_result(arg)", "start_line": 885, "end_line": 896}, "metadata": {"module": "Capybara", "class_name": "Session", "class_signature": "class Session"}, "task_id": 19}
{"function_name": "wait_for_stable_size", "file_path": "capybara/lib/capybara/window.rb", "focal_code": "def wait_for_stable_size(seconds = session.config.default_max_wait_time)\n      res = yield if block_given?\n      timer = Capybara::Helpers.timer(expire_in: seconds)\n      loop do\n        prev_size = size\n        sleep 0.025\n        return res if prev_size == size\n        break if timer.expired?\n      end\n      raise Capybara::WindowError, \"Window size not stable within #{seconds} seconds.\"\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  ##\n  # The {Window} class represents a browser window.\n  #\n  # You can get an instance of the class by calling any of:\n  #\n  # * {Capybara::Session#windows}\n  # * {Capybara::Session#current_window}\n  # * {Capybara::Session#window_opened_by}\n  # * {Capybara::Session#switch_to_window}\n  #\n  # Note that some drivers (e.g. Selenium) support getting size of/resizing/closing only\n  # current window. So if you invoke such method for:\n  #\n  # * window that is current, Capybara will make 2 Selenium method invocations\n  #   (get handle of current window + get size/resize/close).\n  # * window that is not current, Capybara will make 4 Selenium method invocations\n  #   (get handle of current window + switch to given handle + get size/resize/close + switch to original handle)\n  #\n  class Window\n    # @return [String]   a string that uniquely identifies window within session\n    attr_reader :handle\n\n    # @return [Capybara::Session] session that this window belongs to\n    attr_reader :session\n\n    # @api private\n    def initialize(session, handle)\n      @session = session\n      @driver = session.driver\n      @handle = handle\n    end\n\n    ##\n    # @return [Boolean] whether the window is not closed\n    def exists?\n      @driver.window_handles.include?(@handle)\n    end\n\n    ##\n    # @return [Boolean] whether the window is closed\n    def closed?\n      !exists?\n    end\n\n    ##\n    # @return [Boolean] whether this window is the window in which commands are being executed\n    def current?\n      @driver.current_window_handle == @handle\n    rescue @driver.no_such_window_error\n      false\n    end\n\n    ##\n    # Close window.\n    #\n    # If this method was called for window that is current, then after calling this method\n    # future invocations of other Capybara methods should raise\n    # {Capybara::Driver::Base#no_such_window_error session.driver.no_such_window_error} until another window will be switched to.\n    #\n    # @!macro about_current\n    #   If this method was called for window that is not current, then after calling this method\n    #   current window should remain the same as it was before calling this method.\n    #\n    def close\n      @driver.close_window(handle)\n    end\n\n    ##\n    # Get window size.\n    #\n    # @macro about_current\n    # @return [Array<(Integer, Integer)>] an array with width and height\n    #\n    def size\n      @driver.window_size(handle)\n    end\n\n    ##\n    # Resize window.\n    #\n    # @macro about_current\n    # @param width [Integer]  the new window width in pixels\n    # @param height [Integer]  the new window height in pixels\n    #\n    def resize_to(width, height)\n      wait_for_stable_size { @driver.resize_window_to(handle, width, height) }\n    end\n\n    ##\n    # Maximize window.\n    #\n    # If a particular driver (e.g. headless driver) doesn't have concept of maximizing it\n    # may not support this method.\n    #\n    # @macro about_current\n    #\n    def maximize\n      wait_for_stable_size { @driver.maximize_window(handle) }\n    end\n\n    ##\n    # Fullscreen window.\n    #\n    # If a particular driver doesn't have concept of fullscreen it may not support this method.\n    #\n    # @macro about_current\n    #\n    def fullscreen\n      @driver.fullscreen_window(handle)\n    end\n\n    def eql?(other)\n      other.is_a?(self.class) && @session == other.session && @handle == other.handle\n    end\n    alias_method :==, :eql?\n\n    def hash\n      [@session, @handle].hash\n    end\n\n    def inspect\n      \"#<Window @handle=#{@handle.inspect}>\"\n    end\n\n  private\n\n    def wait_for_stable_size(seconds = session.config.default_max_wait_time)\n      res = yield if block_given?\n      timer = Capybara::Helpers.timer(expire_in: seconds)\n      loop do\n        prev_size = size\n        sleep 0.025\n        return res if prev_size == size\n        break if timer.expired?\n      end\n      raise Capybara::WindowError, \"Window size not stable within #{seconds} seconds.\"\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "wait_for_stable_size", "signature": "def wait_for_stable_size(seconds = session.config.default_max_wait_time)", "start_line": 130, "end_line": 140}, "metadata": {"module": "Capybara", "class_name": "Window", "class_signature": "class Window"}, "task_id": 20}
{"function_name": "attach_file", "file_path": "capybara/lib/capybara/node/actions.rb", "focal_code": "def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments\n        if locator && block_given?\n          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'\n        end\n\n        Array(paths).each do |path|\n          raise Capybara::FileNotFound, \"cannot attach file, #{path} does not exist\" unless File.exist?(path.to_s)\n        end\n        options[:allow_self] = true if locator.nil?\n\n        if block_given?\n          begin\n            execute_script CAPTURE_FILE_ELEMENT_SCRIPT\n            yield\n            file_field = evaluate_script 'window._capybara_clicked_file_input'\n            raise ArgumentError, \"Capybara was unable to determine the file input you're attaching to\" unless file_field\n          rescue ::Capybara::NotSupportedByDriverError\n            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'\n          end\n        end\n        # Allow user to update the CSS style of the file input since they are so often hidden on a page\n        if make_visible\n          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))\n          while_visible(ff, make_visible) { |el| el.set(paths) }\n        else\n          (file_field || find(:file_field, locator, **options)).set(paths)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Actions\n      # @!macro waiting_behavior\n      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time\n      #   and continuously retry finding the element until either the element is found or the time\n      #   expires. The length of time this method will wait is controlled through {Capybara.configure default_max_wait_time}.\n      #\n      #   @option options [false, true, Numeric] wait\n      #     Maximum time to wait for matching element to appear. Defaults to {Capybara.configure default_max_wait_time}.\n\n      ##\n      #\n      # Finds a button or link and clicks it. See {#click_button} and\n      # {#click_link} for what locator will match against for each type of element.\n      #\n      # @overload click_link_or_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      See {#click_button} and {#click_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      #\n      def click_link_or_button(locator = nil, **options)\n        find(:link_or_button, locator, **options).click\n      end\n      alias_method :click_on, :click_link_or_button\n\n      ##\n      #\n      # Finds a link by id, {Capybara.configure test_id} attribute, text or title and clicks it. Also looks at image\n      # alt text inside the link.\n      #\n      # @overload click_link([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator         text, id, {Capybara.configure test_id} attribute, title or nested image's alt attribute\n      #   @param [Hash] options           See {Capybara::Node::Finders#find_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_link(locator = nil, **options)\n        find(:link, locator, **options).click\n      end\n\n      ##\n      #\n      # Finds a button on the page and clicks it.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title. `<button>` elements can also be found\n      # by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload click_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      Which button to find\n      #   @param [Hash] options        See {Capybara::Node::Finders#find_button}\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_button(locator = nil, **options)\n        find(:button, locator, **options).click\n      end\n\n      ##\n      #\n      # Locate a text field or text area and fill it in with the given text.\n      # The field can be found via its name, id, {Capybara.configure test_id} attribute, placeholder, or label text.\n      # If no locator is provided this will operate on self or a descendant.\n      #\n      #     # will fill in a descendant fillable field with name, id, or label text matching 'Name'\n      #     page.fill_in 'Name', with: 'Bob'\n      #\n      #     # will fill in `el` if it's a fillable field\n      #     el.fill_in with: 'Tom'\n      #\n      #\n      # @overload fill_in([locator], with:, **options)\n      #   @param [String] locator                 Which field to fill in\n      #   @param [Hash] options\n      #   @param with: [String]                  The value to fill in\n      #   @macro waiting_behavior\n      #   @option options [String] currently_with The current value property of the field to fill in\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from {Capybara.configure default_set_options})\n      #\n      # @return [Capybara::Node::Element]  The element filled in\n      def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)\n        find_options[:with] = currently_with if currently_with\n        find_options[:allow_self] = true if locator.nil?\n        find(:fillable_field, locator, **find_options).set(with, **fill_options)\n      end\n\n      # @!macro label_click\n      #   @option options [Boolean, Hash] allow_label_click\n      #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.\n      #     If set to a Hash it is passed as options to the `click` on the label\n\n      ##\n      #\n      # Find a descendant radio button and mark it as checked. The radio button can be found\n      # via name, id, {Capybara.configure test_id} attribute or label text. If no locator is\n      # provided this will match against self or a descendant.\n      #\n      #     # will choose a descendant radio button with a name, id, or label text matching 'Male'\n      #     page.choose('Male')\n      #\n      #     # will choose `el` if it's a radio button element\n      #     el.choose()\n      #\n      # @overload choose([locator], **options)\n      #   @param [String] locator           Which radio button to choose\n      #\n      #   @option options [String] option  Value of the radio_button to choose\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro waiting_behavior\n      #   @macro label_click\n      #\n      # @return [Capybara::Node::Element]  The element chosen or the label clicked\n      def choose(locator = nil, **options)\n        _check_with_label(:radio_button, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and mark it as checked. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If no locator\n      # is provided this will match against self or a descendant.\n      #\n      #     # will check a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.check('German')\n      #\n      #     # will check `el` if it's a checkbox element\n      #     el.check()\n      #\n      #\n      # @overload check([locator], **options)\n      #   @param [String] locator           Which check box to check\n      #\n      #   @option options [String] option  Value of the checkbox to select\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element checked or the label clicked\n      def check(locator = nil, **options)\n        _check_with_label(:checkbox, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and uncheck it. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If\n      # no locator is provided this will match against self or a descendant.\n      #\n      #     # will uncheck a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.uncheck('German')\n      #\n      #     # will uncheck `el` if it's a checkbox element\n      #     el.uncheck()\n      #\n      #\n      # @overload uncheck([locator], **options)\n      #   @param [String] locator           Which check box to uncheck\n      #\n      #   @option options [String] option  Value of the checkbox to deselect\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element unchecked or the label clicked\n      def uncheck(locator = nil, **options)\n        _check_with_label(:checkbox, false, locator, **options)\n      end\n\n      ##\n      #\n      # If `from` option is present, {#select} finds a select box, or text input with associated datalist,\n      # on the page and selects a particular option from it.\n      # Otherwise it finds an option inside current scope and selects it.\n      # If the select box is a multiple select, {#select} can be called multiple times to select more than\n      # one option.\n      # The select box can be found via its name, id, {Capybara.configure test_id} attribute, or label text.\n      # The option can be found by its text.\n      #\n      #     page.select 'March', from: 'Month'\n      #\n      # @overload select(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String] Which option to select\n      #   @param from [String]  The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      # @return [Capybara::Node::Element]  The option element selected\n      def select(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        el = from ? find_select_or_datalist_input(from, options) : self\n\n        if el.respond_to?(:tag_name) && (el.tag_name == 'input')\n          select_datalist_option(el, value)\n        else\n          el.find(:option, value, **options).select_option\n        end\n      end\n\n      ##\n      #\n      # Find a select box on the page and unselect a particular option from it. If the select\n      # box is a multiple select, {#unselect} can be called multiple times to unselect more than\n      # one option. The select box can be found via its name, id, {Capybara.configure test_id} attribute,\n      # or label text.\n      #\n      #     page.unselect 'March', from: 'Month'\n      #\n      # @overload unselect(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String]     Which option to unselect\n      #   @param from [String]      The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      #\n      # @return [Capybara::Node::Element]  The option element unselected\n      def unselect(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        scope = from ? find(:select, from, **options) : self\n        scope.find(:option, value, **options).unselect_option\n      end\n\n      ##\n      #\n      # Find a descendant file field on the page and attach a file given its path. There are two ways to use\n      # {#attach_file}, in the first method the file field can be found via its name, id,\n      # {Capybara.configure test_id} attribute, or label text. In the case of the file field being hidden for\n      # styling reasons the `make_visible` option can be used to temporarily change the CSS of\n      # the file field, attach the file, and then revert the CSS back to original. If no locator is\n      # passed this will match self or a descendant.\n      # The second method, which is currently in beta and may be changed/removed, involves passing a block\n      # which performs whatever actions would trigger the file chooser to appear.\n      #\n      #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'\n      #     page.attach_file('My File', '/path/to/file.png')\n      #\n      #     # will attach file to el if it's a file input element\n      #     el.attach_file('/path/to/file.png')\n      #\n      #     # will attach file to whatever file input is triggered by the block\n      #     page.attach_file('/path/to/file.png') do\n      #       page.find('#upload_button').click\n      #     end\n      #\n      # @overload attach_file([locator], paths, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param [String] locator                  Which field to attach the file to\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #\n      #   @option options [Symbol] match\n      #     The matching strategy to use (:one, :first, :prefer_exact, :smart). Defaults to {Capybara.configure match}.\n      #   @option options [Boolean] exact\n      #     Match the exact label name/contents or accept a partial match. Defaults to {Capybara.configure exact}.\n      #   @option options [Boolean] multiple Match field which allows multiple file selection\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [true, Hash] make_visible\n      #     A Hash of CSS styles to change before attempting to attach the file, if `true`, `{ opacity: 1, display: 'block', visibility: 'visible' }` is used (may not be supported by all drivers).\n      # @overload attach_file(paths, &blk)\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #   @yield Block whose actions will trigger the system file chooser to be shown\n      # @return [Capybara::Node::Element]  The file field element\n      def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments\n        if locator && block_given?\n          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'\n        end\n\n        Array(paths).each do |path|\n          raise Capybara::FileNotFound, \"cannot attach file, #{path} does not exist\" unless File.exist?(path.to_s)\n        end\n        options[:allow_self] = true if locator.nil?\n\n        if block_given?\n          begin\n            execute_script CAPTURE_FILE_ELEMENT_SCRIPT\n            yield\n            file_field = evaluate_script 'window._capybara_clicked_file_input'\n            raise ArgumentError, \"Capybara was unable to determine the file input you're attaching to\" unless file_field\n          rescue ::Capybara::NotSupportedByDriverError\n            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'\n          end\n        end\n        # Allow user to update the CSS style of the file input since they are so often hidden on a page\n        if make_visible\n          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))\n          while_visible(ff, make_visible) { |el| el.set(paths) }\n        else\n          (file_field || find(:file_field, locator, **options)).set(paths)\n        end\n      end\n\n    private\n\n      def find_select_or_datalist_input(from, options)\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          find(:select, from, **options)\n        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName\n          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }\n\n          begin\n            find(:datalist_input, from, **options)\n          rescue Capybara::ElementNotFound => dlinput_error\n            raise Capybara::ElementNotFound, \"#{select_error.message} and #{dlinput_error.message}\"\n          end\n        end\n      end\n\n      def select_datalist_option(input, value)\n        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)\n        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }\n        raise ::Capybara::ElementNotFound, %(Unable to find datalist option \"#{value}\") unless option\n\n        input.set(option['value'])\n      rescue ::Capybara::NotSupportedByDriverError\n        # Implement for drivers that don't support JS\n        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)\n        option = datalist.find(:datalist_option, value, disabled: false)\n        input.set(option.value)\n      end\n\n      def while_visible(element, visible_css)\n        if visible_css == true\n          visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }\n        end\n        _update_style(element, visible_css)\n        unless element.visible?\n          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'\n        end\n\n        begin\n          yield element\n        ensure\n          _reset_style(element)\n        end\n      end\n\n      def _update_style(element, style)\n        element.execute_script(UPDATE_STYLE_SCRIPT, style)\n      rescue Capybara::NotSupportedByDriverError\n        warn 'The :make_visible option is not supported by the current driver - ignoring'\n      end\n\n      def _reset_style(element)\n        element.execute_script(RESET_STYLE_SCRIPT)\n      rescue StandardError # rubocop:disable Lint/SuppressedException -- swallow extra errors\n      end\n\n      def _check_with_label(selector, checked, locator,\n                            allow_label_click: session_options.automatic_label_click, **options)\n        options[:allow_self] = true if locator.nil?\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          el = find(selector, locator, **options)\n          el.set(checked)\n        rescue StandardError => e\n          raise unless allow_label_click && catch_error?(e)\n\n          begin\n            el ||= find(selector, locator, **options.merge(visible: :all))\n            unless el.checked? == checked\n              el.session\n                .find(:label, for: el, visible: true, match: :first)\n                .click(**(Hash.try_convert(allow_label_click) || {}))\n            end\n          rescue StandardError # swallow extra errors - raise original\n            raise e\n          end\n        end\n      end\n\n      UPDATE_STYLE_SCRIPT = <<~JS\n        this.capybara_style_cache = this.style.cssText;\n        var css = arguments[0];\n        for (var prop in css){\n          if (css.hasOwnProperty(prop)) {\n            this.style.setProperty(prop, css[prop], \"important\");\n          }\n        }\n      JS\n\n      RESET_STYLE_SCRIPT = <<~JS\n        if (this.hasOwnProperty('capybara_style_cache')) {\n          this.style.cssText = this.capybara_style_cache;\n          delete this.capybara_style_cache;\n        }\n      JS\n\n      DATALIST_OPTIONS_SCRIPT = <<~JS\n        Array.prototype.slice.call((this.list||{}).options || []).\n          filter(function(el){ return !el.disabled }).\n          map(function(el){ return { \"value\": el.value, \"label\": el.label} })\n      JS\n\n      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS\n        document.addEventListener('click', function file_catcher(e){\n          if (e.target.matches(\"input[type='file']\")) {\n            window._capybara_clicked_file_input = e.target;\n            this.removeEventListener('click', file_catcher);\n            e.preventDefault();\n          }\n        }, {capture: true})\n      JS\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "attach_file", "signature": "def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments", "start_line": 279, "end_line": 306}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 21}
{"function_name": "find_select_or_datalist_input", "file_path": "capybara/lib/capybara/node/actions.rb", "focal_code": "def find_select_or_datalist_input(from, options)\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          find(:select, from, **options)\n        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName\n          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }\n\n          begin\n            find(:datalist_input, from, **options)\n          rescue Capybara::ElementNotFound => dlinput_error\n            raise Capybara::ElementNotFound, \"#{select_error.message} and #{dlinput_error.message}\"\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Actions\n      # @!macro waiting_behavior\n      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time\n      #   and continuously retry finding the element until either the element is found or the time\n      #   expires. The length of time this method will wait is controlled through {Capybara.configure default_max_wait_time}.\n      #\n      #   @option options [false, true, Numeric] wait\n      #     Maximum time to wait for matching element to appear. Defaults to {Capybara.configure default_max_wait_time}.\n\n      ##\n      #\n      # Finds a button or link and clicks it. See {#click_button} and\n      # {#click_link} for what locator will match against for each type of element.\n      #\n      # @overload click_link_or_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      See {#click_button} and {#click_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      #\n      def click_link_or_button(locator = nil, **options)\n        find(:link_or_button, locator, **options).click\n      end\n      alias_method :click_on, :click_link_or_button\n\n      ##\n      #\n      # Finds a link by id, {Capybara.configure test_id} attribute, text or title and clicks it. Also looks at image\n      # alt text inside the link.\n      #\n      # @overload click_link([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator         text, id, {Capybara.configure test_id} attribute, title or nested image's alt attribute\n      #   @param [Hash] options           See {Capybara::Node::Finders#find_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_link(locator = nil, **options)\n        find(:link, locator, **options).click\n      end\n\n      ##\n      #\n      # Finds a button on the page and clicks it.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title. `<button>` elements can also be found\n      # by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload click_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      Which button to find\n      #   @param [Hash] options        See {Capybara::Node::Finders#find_button}\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_button(locator = nil, **options)\n        find(:button, locator, **options).click\n      end\n\n      ##\n      #\n      # Locate a text field or text area and fill it in with the given text.\n      # The field can be found via its name, id, {Capybara.configure test_id} attribute, placeholder, or label text.\n      # If no locator is provided this will operate on self or a descendant.\n      #\n      #     # will fill in a descendant fillable field with name, id, or label text matching 'Name'\n      #     page.fill_in 'Name', with: 'Bob'\n      #\n      #     # will fill in `el` if it's a fillable field\n      #     el.fill_in with: 'Tom'\n      #\n      #\n      # @overload fill_in([locator], with:, **options)\n      #   @param [String] locator                 Which field to fill in\n      #   @param [Hash] options\n      #   @param with: [String]                  The value to fill in\n      #   @macro waiting_behavior\n      #   @option options [String] currently_with The current value property of the field to fill in\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from {Capybara.configure default_set_options})\n      #\n      # @return [Capybara::Node::Element]  The element filled in\n      def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)\n        find_options[:with] = currently_with if currently_with\n        find_options[:allow_self] = true if locator.nil?\n        find(:fillable_field, locator, **find_options).set(with, **fill_options)\n      end\n\n      # @!macro label_click\n      #   @option options [Boolean, Hash] allow_label_click\n      #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.\n      #     If set to a Hash it is passed as options to the `click` on the label\n\n      ##\n      #\n      # Find a descendant radio button and mark it as checked. The radio button can be found\n      # via name, id, {Capybara.configure test_id} attribute or label text. If no locator is\n      # provided this will match against self or a descendant.\n      #\n      #     # will choose a descendant radio button with a name, id, or label text matching 'Male'\n      #     page.choose('Male')\n      #\n      #     # will choose `el` if it's a radio button element\n      #     el.choose()\n      #\n      # @overload choose([locator], **options)\n      #   @param [String] locator           Which radio button to choose\n      #\n      #   @option options [String] option  Value of the radio_button to choose\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro waiting_behavior\n      #   @macro label_click\n      #\n      # @return [Capybara::Node::Element]  The element chosen or the label clicked\n      def choose(locator = nil, **options)\n        _check_with_label(:radio_button, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and mark it as checked. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If no locator\n      # is provided this will match against self or a descendant.\n      #\n      #     # will check a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.check('German')\n      #\n      #     # will check `el` if it's a checkbox element\n      #     el.check()\n      #\n      #\n      # @overload check([locator], **options)\n      #   @param [String] locator           Which check box to check\n      #\n      #   @option options [String] option  Value of the checkbox to select\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element checked or the label clicked\n      def check(locator = nil, **options)\n        _check_with_label(:checkbox, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and uncheck it. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If\n      # no locator is provided this will match against self or a descendant.\n      #\n      #     # will uncheck a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.uncheck('German')\n      #\n      #     # will uncheck `el` if it's a checkbox element\n      #     el.uncheck()\n      #\n      #\n      # @overload uncheck([locator], **options)\n      #   @param [String] locator           Which check box to uncheck\n      #\n      #   @option options [String] option  Value of the checkbox to deselect\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element unchecked or the label clicked\n      def uncheck(locator = nil, **options)\n        _check_with_label(:checkbox, false, locator, **options)\n      end\n\n      ##\n      #\n      # If `from` option is present, {#select} finds a select box, or text input with associated datalist,\n      # on the page and selects a particular option from it.\n      # Otherwise it finds an option inside current scope and selects it.\n      # If the select box is a multiple select, {#select} can be called multiple times to select more than\n      # one option.\n      # The select box can be found via its name, id, {Capybara.configure test_id} attribute, or label text.\n      # The option can be found by its text.\n      #\n      #     page.select 'March', from: 'Month'\n      #\n      # @overload select(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String] Which option to select\n      #   @param from [String]  The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      # @return [Capybara::Node::Element]  The option element selected\n      def select(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        el = from ? find_select_or_datalist_input(from, options) : self\n\n        if el.respond_to?(:tag_name) && (el.tag_name == 'input')\n          select_datalist_option(el, value)\n        else\n          el.find(:option, value, **options).select_option\n        end\n      end\n\n      ##\n      #\n      # Find a select box on the page and unselect a particular option from it. If the select\n      # box is a multiple select, {#unselect} can be called multiple times to unselect more than\n      # one option. The select box can be found via its name, id, {Capybara.configure test_id} attribute,\n      # or label text.\n      #\n      #     page.unselect 'March', from: 'Month'\n      #\n      # @overload unselect(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String]     Which option to unselect\n      #   @param from [String]      The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      #\n      # @return [Capybara::Node::Element]  The option element unselected\n      def unselect(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        scope = from ? find(:select, from, **options) : self\n        scope.find(:option, value, **options).unselect_option\n      end\n\n      ##\n      #\n      # Find a descendant file field on the page and attach a file given its path. There are two ways to use\n      # {#attach_file}, in the first method the file field can be found via its name, id,\n      # {Capybara.configure test_id} attribute, or label text. In the case of the file field being hidden for\n      # styling reasons the `make_visible` option can be used to temporarily change the CSS of\n      # the file field, attach the file, and then revert the CSS back to original. If no locator is\n      # passed this will match self or a descendant.\n      # The second method, which is currently in beta and may be changed/removed, involves passing a block\n      # which performs whatever actions would trigger the file chooser to appear.\n      #\n      #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'\n      #     page.attach_file('My File', '/path/to/file.png')\n      #\n      #     # will attach file to el if it's a file input element\n      #     el.attach_file('/path/to/file.png')\n      #\n      #     # will attach file to whatever file input is triggered by the block\n      #     page.attach_file('/path/to/file.png') do\n      #       page.find('#upload_button').click\n      #     end\n      #\n      # @overload attach_file([locator], paths, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param [String] locator                  Which field to attach the file to\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #\n      #   @option options [Symbol] match\n      #     The matching strategy to use (:one, :first, :prefer_exact, :smart). Defaults to {Capybara.configure match}.\n      #   @option options [Boolean] exact\n      #     Match the exact label name/contents or accept a partial match. Defaults to {Capybara.configure exact}.\n      #   @option options [Boolean] multiple Match field which allows multiple file selection\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [true, Hash] make_visible\n      #     A Hash of CSS styles to change before attempting to attach the file, if `true`, `{ opacity: 1, display: 'block', visibility: 'visible' }` is used (may not be supported by all drivers).\n      # @overload attach_file(paths, &blk)\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #   @yield Block whose actions will trigger the system file chooser to be shown\n      # @return [Capybara::Node::Element]  The file field element\n      def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments\n        if locator && block_given?\n          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'\n        end\n\n        Array(paths).each do |path|\n          raise Capybara::FileNotFound, \"cannot attach file, #{path} does not exist\" unless File.exist?(path.to_s)\n        end\n        options[:allow_self] = true if locator.nil?\n\n        if block_given?\n          begin\n            execute_script CAPTURE_FILE_ELEMENT_SCRIPT\n            yield\n            file_field = evaluate_script 'window._capybara_clicked_file_input'\n            raise ArgumentError, \"Capybara was unable to determine the file input you're attaching to\" unless file_field\n          rescue ::Capybara::NotSupportedByDriverError\n            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'\n          end\n        end\n        # Allow user to update the CSS style of the file input since they are so often hidden on a page\n        if make_visible\n          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))\n          while_visible(ff, make_visible) { |el| el.set(paths) }\n        else\n          (file_field || find(:file_field, locator, **options)).set(paths)\n        end\n      end\n\n    private\n\n      def find_select_or_datalist_input(from, options)\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          find(:select, from, **options)\n        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName\n          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }\n\n          begin\n            find(:datalist_input, from, **options)\n          rescue Capybara::ElementNotFound => dlinput_error\n            raise Capybara::ElementNotFound, \"#{select_error.message} and #{dlinput_error.message}\"\n          end\n        end\n      end\n\n      def select_datalist_option(input, value)\n        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)\n        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }\n        raise ::Capybara::ElementNotFound, %(Unable to find datalist option \"#{value}\") unless option\n\n        input.set(option['value'])\n      rescue ::Capybara::NotSupportedByDriverError\n        # Implement for drivers that don't support JS\n        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)\n        option = datalist.find(:datalist_option, value, disabled: false)\n        input.set(option.value)\n      end\n\n      def while_visible(element, visible_css)\n        if visible_css == true\n          visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }\n        end\n        _update_style(element, visible_css)\n        unless element.visible?\n          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'\n        end\n\n        begin\n          yield element\n        ensure\n          _reset_style(element)\n        end\n      end\n\n      def _update_style(element, style)\n        element.execute_script(UPDATE_STYLE_SCRIPT, style)\n      rescue Capybara::NotSupportedByDriverError\n        warn 'The :make_visible option is not supported by the current driver - ignoring'\n      end\n\n      def _reset_style(element)\n        element.execute_script(RESET_STYLE_SCRIPT)\n      rescue StandardError # rubocop:disable Lint/SuppressedException -- swallow extra errors\n      end\n\n      def _check_with_label(selector, checked, locator,\n                            allow_label_click: session_options.automatic_label_click, **options)\n        options[:allow_self] = true if locator.nil?\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          el = find(selector, locator, **options)\n          el.set(checked)\n        rescue StandardError => e\n          raise unless allow_label_click && catch_error?(e)\n\n          begin\n            el ||= find(selector, locator, **options.merge(visible: :all))\n            unless el.checked? == checked\n              el.session\n                .find(:label, for: el, visible: true, match: :first)\n                .click(**(Hash.try_convert(allow_label_click) || {}))\n            end\n          rescue StandardError # swallow extra errors - raise original\n            raise e\n          end\n        end\n      end\n\n      UPDATE_STYLE_SCRIPT = <<~JS\n        this.capybara_style_cache = this.style.cssText;\n        var css = arguments[0];\n        for (var prop in css){\n          if (css.hasOwnProperty(prop)) {\n            this.style.setProperty(prop, css[prop], \"important\");\n          }\n        }\n      JS\n\n      RESET_STYLE_SCRIPT = <<~JS\n        if (this.hasOwnProperty('capybara_style_cache')) {\n          this.style.cssText = this.capybara_style_cache;\n          delete this.capybara_style_cache;\n        }\n      JS\n\n      DATALIST_OPTIONS_SCRIPT = <<~JS\n        Array.prototype.slice.call((this.list||{}).options || []).\n          filter(function(el){ return !el.disabled }).\n          map(function(el){ return { \"value\": el.value, \"label\": el.label} })\n      JS\n\n      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS\n        document.addEventListener('click', function file_catcher(e){\n          if (e.target.matches(\"input[type='file']\")) {\n            window._capybara_clicked_file_input = e.target;\n            this.removeEventListener('click', file_catcher);\n            e.preventDefault();\n          }\n        }, {capture: true})\n      JS\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_select_or_datalist_input", "signature": "def find_select_or_datalist_input(from, options)", "start_line": 310, "end_line": 322}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 22}
{"function_name": "select_datalist_option", "file_path": "capybara/lib/capybara/node/actions.rb", "focal_code": "def select_datalist_option(input, value)\n        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)\n        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }\n        raise ::Capybara::ElementNotFound, %(Unable to find datalist option \"#{value}\") unless option\n\n        input.set(option['value'])\n      rescue ::Capybara::NotSupportedByDriverError\n        # Implement for drivers that don't support JS\n        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)\n        option = datalist.find(:datalist_option, value, disabled: false)\n        input.set(option.value)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Actions\n      # @!macro waiting_behavior\n      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time\n      #   and continuously retry finding the element until either the element is found or the time\n      #   expires. The length of time this method will wait is controlled through {Capybara.configure default_max_wait_time}.\n      #\n      #   @option options [false, true, Numeric] wait\n      #     Maximum time to wait for matching element to appear. Defaults to {Capybara.configure default_max_wait_time}.\n\n      ##\n      #\n      # Finds a button or link and clicks it. See {#click_button} and\n      # {#click_link} for what locator will match against for each type of element.\n      #\n      # @overload click_link_or_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      See {#click_button} and {#click_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      #\n      def click_link_or_button(locator = nil, **options)\n        find(:link_or_button, locator, **options).click\n      end\n      alias_method :click_on, :click_link_or_button\n\n      ##\n      #\n      # Finds a link by id, {Capybara.configure test_id} attribute, text or title and clicks it. Also looks at image\n      # alt text inside the link.\n      #\n      # @overload click_link([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator         text, id, {Capybara.configure test_id} attribute, title or nested image's alt attribute\n      #   @param [Hash] options           See {Capybara::Node::Finders#find_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_link(locator = nil, **options)\n        find(:link, locator, **options).click\n      end\n\n      ##\n      #\n      # Finds a button on the page and clicks it.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title. `<button>` elements can also be found\n      # by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload click_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      Which button to find\n      #   @param [Hash] options        See {Capybara::Node::Finders#find_button}\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_button(locator = nil, **options)\n        find(:button, locator, **options).click\n      end\n\n      ##\n      #\n      # Locate a text field or text area and fill it in with the given text.\n      # The field can be found via its name, id, {Capybara.configure test_id} attribute, placeholder, or label text.\n      # If no locator is provided this will operate on self or a descendant.\n      #\n      #     # will fill in a descendant fillable field with name, id, or label text matching 'Name'\n      #     page.fill_in 'Name', with: 'Bob'\n      #\n      #     # will fill in `el` if it's a fillable field\n      #     el.fill_in with: 'Tom'\n      #\n      #\n      # @overload fill_in([locator], with:, **options)\n      #   @param [String] locator                 Which field to fill in\n      #   @param [Hash] options\n      #   @param with: [String]                  The value to fill in\n      #   @macro waiting_behavior\n      #   @option options [String] currently_with The current value property of the field to fill in\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from {Capybara.configure default_set_options})\n      #\n      # @return [Capybara::Node::Element]  The element filled in\n      def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)\n        find_options[:with] = currently_with if currently_with\n        find_options[:allow_self] = true if locator.nil?\n        find(:fillable_field, locator, **find_options).set(with, **fill_options)\n      end\n\n      # @!macro label_click\n      #   @option options [Boolean, Hash] allow_label_click\n      #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.\n      #     If set to a Hash it is passed as options to the `click` on the label\n\n      ##\n      #\n      # Find a descendant radio button and mark it as checked. The radio button can be found\n      # via name, id, {Capybara.configure test_id} attribute or label text. If no locator is\n      # provided this will match against self or a descendant.\n      #\n      #     # will choose a descendant radio button with a name, id, or label text matching 'Male'\n      #     page.choose('Male')\n      #\n      #     # will choose `el` if it's a radio button element\n      #     el.choose()\n      #\n      # @overload choose([locator], **options)\n      #   @param [String] locator           Which radio button to choose\n      #\n      #   @option options [String] option  Value of the radio_button to choose\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro waiting_behavior\n      #   @macro label_click\n      #\n      # @return [Capybara::Node::Element]  The element chosen or the label clicked\n      def choose(locator = nil, **options)\n        _check_with_label(:radio_button, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and mark it as checked. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If no locator\n      # is provided this will match against self or a descendant.\n      #\n      #     # will check a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.check('German')\n      #\n      #     # will check `el` if it's a checkbox element\n      #     el.check()\n      #\n      #\n      # @overload check([locator], **options)\n      #   @param [String] locator           Which check box to check\n      #\n      #   @option options [String] option  Value of the checkbox to select\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element checked or the label clicked\n      def check(locator = nil, **options)\n        _check_with_label(:checkbox, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and uncheck it. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If\n      # no locator is provided this will match against self or a descendant.\n      #\n      #     # will uncheck a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.uncheck('German')\n      #\n      #     # will uncheck `el` if it's a checkbox element\n      #     el.uncheck()\n      #\n      #\n      # @overload uncheck([locator], **options)\n      #   @param [String] locator           Which check box to uncheck\n      #\n      #   @option options [String] option  Value of the checkbox to deselect\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element unchecked or the label clicked\n      def uncheck(locator = nil, **options)\n        _check_with_label(:checkbox, false, locator, **options)\n      end\n\n      ##\n      #\n      # If `from` option is present, {#select} finds a select box, or text input with associated datalist,\n      # on the page and selects a particular option from it.\n      # Otherwise it finds an option inside current scope and selects it.\n      # If the select box is a multiple select, {#select} can be called multiple times to select more than\n      # one option.\n      # The select box can be found via its name, id, {Capybara.configure test_id} attribute, or label text.\n      # The option can be found by its text.\n      #\n      #     page.select 'March', from: 'Month'\n      #\n      # @overload select(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String] Which option to select\n      #   @param from [String]  The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      # @return [Capybara::Node::Element]  The option element selected\n      def select(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        el = from ? find_select_or_datalist_input(from, options) : self\n\n        if el.respond_to?(:tag_name) && (el.tag_name == 'input')\n          select_datalist_option(el, value)\n        else\n          el.find(:option, value, **options).select_option\n        end\n      end\n\n      ##\n      #\n      # Find a select box on the page and unselect a particular option from it. If the select\n      # box is a multiple select, {#unselect} can be called multiple times to unselect more than\n      # one option. The select box can be found via its name, id, {Capybara.configure test_id} attribute,\n      # or label text.\n      #\n      #     page.unselect 'March', from: 'Month'\n      #\n      # @overload unselect(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String]     Which option to unselect\n      #   @param from [String]      The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      #\n      # @return [Capybara::Node::Element]  The option element unselected\n      def unselect(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        scope = from ? find(:select, from, **options) : self\n        scope.find(:option, value, **options).unselect_option\n      end\n\n      ##\n      #\n      # Find a descendant file field on the page and attach a file given its path. There are two ways to use\n      # {#attach_file}, in the first method the file field can be found via its name, id,\n      # {Capybara.configure test_id} attribute, or label text. In the case of the file field being hidden for\n      # styling reasons the `make_visible` option can be used to temporarily change the CSS of\n      # the file field, attach the file, and then revert the CSS back to original. If no locator is\n      # passed this will match self or a descendant.\n      # The second method, which is currently in beta and may be changed/removed, involves passing a block\n      # which performs whatever actions would trigger the file chooser to appear.\n      #\n      #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'\n      #     page.attach_file('My File', '/path/to/file.png')\n      #\n      #     # will attach file to el if it's a file input element\n      #     el.attach_file('/path/to/file.png')\n      #\n      #     # will attach file to whatever file input is triggered by the block\n      #     page.attach_file('/path/to/file.png') do\n      #       page.find('#upload_button').click\n      #     end\n      #\n      # @overload attach_file([locator], paths, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param [String] locator                  Which field to attach the file to\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #\n      #   @option options [Symbol] match\n      #     The matching strategy to use (:one, :first, :prefer_exact, :smart). Defaults to {Capybara.configure match}.\n      #   @option options [Boolean] exact\n      #     Match the exact label name/contents or accept a partial match. Defaults to {Capybara.configure exact}.\n      #   @option options [Boolean] multiple Match field which allows multiple file selection\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [true, Hash] make_visible\n      #     A Hash of CSS styles to change before attempting to attach the file, if `true`, `{ opacity: 1, display: 'block', visibility: 'visible' }` is used (may not be supported by all drivers).\n      # @overload attach_file(paths, &blk)\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #   @yield Block whose actions will trigger the system file chooser to be shown\n      # @return [Capybara::Node::Element]  The file field element\n      def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments\n        if locator && block_given?\n          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'\n        end\n\n        Array(paths).each do |path|\n          raise Capybara::FileNotFound, \"cannot attach file, #{path} does not exist\" unless File.exist?(path.to_s)\n        end\n        options[:allow_self] = true if locator.nil?\n\n        if block_given?\n          begin\n            execute_script CAPTURE_FILE_ELEMENT_SCRIPT\n            yield\n            file_field = evaluate_script 'window._capybara_clicked_file_input'\n            raise ArgumentError, \"Capybara was unable to determine the file input you're attaching to\" unless file_field\n          rescue ::Capybara::NotSupportedByDriverError\n            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'\n          end\n        end\n        # Allow user to update the CSS style of the file input since they are so often hidden on a page\n        if make_visible\n          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))\n          while_visible(ff, make_visible) { |el| el.set(paths) }\n        else\n          (file_field || find(:file_field, locator, **options)).set(paths)\n        end\n      end\n\n    private\n\n      def find_select_or_datalist_input(from, options)\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          find(:select, from, **options)\n        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName\n          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }\n\n          begin\n            find(:datalist_input, from, **options)\n          rescue Capybara::ElementNotFound => dlinput_error\n            raise Capybara::ElementNotFound, \"#{select_error.message} and #{dlinput_error.message}\"\n          end\n        end\n      end\n\n      def select_datalist_option(input, value)\n        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)\n        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }\n        raise ::Capybara::ElementNotFound, %(Unable to find datalist option \"#{value}\") unless option\n\n        input.set(option['value'])\n      rescue ::Capybara::NotSupportedByDriverError\n        # Implement for drivers that don't support JS\n        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)\n        option = datalist.find(:datalist_option, value, disabled: false)\n        input.set(option.value)\n      end\n\n      def while_visible(element, visible_css)\n        if visible_css == true\n          visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }\n        end\n        _update_style(element, visible_css)\n        unless element.visible?\n          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'\n        end\n\n        begin\n          yield element\n        ensure\n          _reset_style(element)\n        end\n      end\n\n      def _update_style(element, style)\n        element.execute_script(UPDATE_STYLE_SCRIPT, style)\n      rescue Capybara::NotSupportedByDriverError\n        warn 'The :make_visible option is not supported by the current driver - ignoring'\n      end\n\n      def _reset_style(element)\n        element.execute_script(RESET_STYLE_SCRIPT)\n      rescue StandardError # rubocop:disable Lint/SuppressedException -- swallow extra errors\n      end\n\n      def _check_with_label(selector, checked, locator,\n                            allow_label_click: session_options.automatic_label_click, **options)\n        options[:allow_self] = true if locator.nil?\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          el = find(selector, locator, **options)\n          el.set(checked)\n        rescue StandardError => e\n          raise unless allow_label_click && catch_error?(e)\n\n          begin\n            el ||= find(selector, locator, **options.merge(visible: :all))\n            unless el.checked? == checked\n              el.session\n                .find(:label, for: el, visible: true, match: :first)\n                .click(**(Hash.try_convert(allow_label_click) || {}))\n            end\n          rescue StandardError # swallow extra errors - raise original\n            raise e\n          end\n        end\n      end\n\n      UPDATE_STYLE_SCRIPT = <<~JS\n        this.capybara_style_cache = this.style.cssText;\n        var css = arguments[0];\n        for (var prop in css){\n          if (css.hasOwnProperty(prop)) {\n            this.style.setProperty(prop, css[prop], \"important\");\n          }\n        }\n      JS\n\n      RESET_STYLE_SCRIPT = <<~JS\n        if (this.hasOwnProperty('capybara_style_cache')) {\n          this.style.cssText = this.capybara_style_cache;\n          delete this.capybara_style_cache;\n        }\n      JS\n\n      DATALIST_OPTIONS_SCRIPT = <<~JS\n        Array.prototype.slice.call((this.list||{}).options || []).\n          filter(function(el){ return !el.disabled }).\n          map(function(el){ return { \"value\": el.value, \"label\": el.label} })\n      JS\n\n      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS\n        document.addEventListener('click', function file_catcher(e){\n          if (e.target.matches(\"input[type='file']\")) {\n            window._capybara_clicked_file_input = e.target;\n            this.removeEventListener('click', file_catcher);\n            e.preventDefault();\n          }\n        }, {capture: true})\n      JS\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "select_datalist_option", "signature": "def select_datalist_option(input, value)", "start_line": 324, "end_line": 335}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 23}
{"function_name": "while_visible", "file_path": "capybara/lib/capybara/node/actions.rb", "focal_code": "def while_visible(element, visible_css)\n        if visible_css == true\n          visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }\n        end\n        _update_style(element, visible_css)\n        unless element.visible?\n          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'\n        end\n\n        begin\n          yield element\n        ensure\n          _reset_style(element)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Actions\n      # @!macro waiting_behavior\n      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time\n      #   and continuously retry finding the element until either the element is found or the time\n      #   expires. The length of time this method will wait is controlled through {Capybara.configure default_max_wait_time}.\n      #\n      #   @option options [false, true, Numeric] wait\n      #     Maximum time to wait for matching element to appear. Defaults to {Capybara.configure default_max_wait_time}.\n\n      ##\n      #\n      # Finds a button or link and clicks it. See {#click_button} and\n      # {#click_link} for what locator will match against for each type of element.\n      #\n      # @overload click_link_or_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      See {#click_button} and {#click_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      #\n      def click_link_or_button(locator = nil, **options)\n        find(:link_or_button, locator, **options).click\n      end\n      alias_method :click_on, :click_link_or_button\n\n      ##\n      #\n      # Finds a link by id, {Capybara.configure test_id} attribute, text or title and clicks it. Also looks at image\n      # alt text inside the link.\n      #\n      # @overload click_link([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator         text, id, {Capybara.configure test_id} attribute, title or nested image's alt attribute\n      #   @param [Hash] options           See {Capybara::Node::Finders#find_link}\n      #\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_link(locator = nil, **options)\n        find(:link, locator, **options).click\n      end\n\n      ##\n      #\n      # Finds a button on the page and clicks it.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title. `<button>` elements can also be found\n      # by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload click_button([locator], **options)\n      #   @macro waiting_behavior\n      #   @param [String] locator      Which button to find\n      #   @param [Hash] options        See {Capybara::Node::Finders#find_button}\n      # @return [Capybara::Node::Element]  The element clicked\n      def click_button(locator = nil, **options)\n        find(:button, locator, **options).click\n      end\n\n      ##\n      #\n      # Locate a text field or text area and fill it in with the given text.\n      # The field can be found via its name, id, {Capybara.configure test_id} attribute, placeholder, or label text.\n      # If no locator is provided this will operate on self or a descendant.\n      #\n      #     # will fill in a descendant fillable field with name, id, or label text matching 'Name'\n      #     page.fill_in 'Name', with: 'Bob'\n      #\n      #     # will fill in `el` if it's a fillable field\n      #     el.fill_in with: 'Tom'\n      #\n      #\n      # @overload fill_in([locator], with:, **options)\n      #   @param [String] locator                 Which field to fill in\n      #   @param [Hash] options\n      #   @param with: [String]                  The value to fill in\n      #   @macro waiting_behavior\n      #   @option options [String] currently_with The current value property of the field to fill in\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from {Capybara.configure default_set_options})\n      #\n      # @return [Capybara::Node::Element]  The element filled in\n      def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)\n        find_options[:with] = currently_with if currently_with\n        find_options[:allow_self] = true if locator.nil?\n        find(:fillable_field, locator, **find_options).set(with, **fill_options)\n      end\n\n      # @!macro label_click\n      #   @option options [Boolean, Hash] allow_label_click\n      #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.\n      #     If set to a Hash it is passed as options to the `click` on the label\n\n      ##\n      #\n      # Find a descendant radio button and mark it as checked. The radio button can be found\n      # via name, id, {Capybara.configure test_id} attribute or label text. If no locator is\n      # provided this will match against self or a descendant.\n      #\n      #     # will choose a descendant radio button with a name, id, or label text matching 'Male'\n      #     page.choose('Male')\n      #\n      #     # will choose `el` if it's a radio button element\n      #     el.choose()\n      #\n      # @overload choose([locator], **options)\n      #   @param [String] locator           Which radio button to choose\n      #\n      #   @option options [String] option  Value of the radio_button to choose\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro waiting_behavior\n      #   @macro label_click\n      #\n      # @return [Capybara::Node::Element]  The element chosen or the label clicked\n      def choose(locator = nil, **options)\n        _check_with_label(:radio_button, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and mark it as checked. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If no locator\n      # is provided this will match against self or a descendant.\n      #\n      #     # will check a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.check('German')\n      #\n      #     # will check `el` if it's a checkbox element\n      #     el.check()\n      #\n      #\n      # @overload check([locator], **options)\n      #   @param [String] locator           Which check box to check\n      #\n      #   @option options [String] option  Value of the checkbox to select\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element checked or the label clicked\n      def check(locator = nil, **options)\n        _check_with_label(:checkbox, true, locator, **options)\n      end\n\n      ##\n      #\n      # Find a descendant check box and uncheck it. The check box can be found\n      # via name, id, {Capybara.configure test_id} attribute, or label text. If\n      # no locator is provided this will match against self or a descendant.\n      #\n      #     # will uncheck a descendant checkbox with a name, id, or label text matching 'German'\n      #     page.uncheck('German')\n      #\n      #     # will uncheck `el` if it's a checkbox element\n      #     el.uncheck()\n      #\n      #\n      # @overload uncheck([locator], **options)\n      #   @param [String] locator           Which check box to uncheck\n      #\n      #   @option options [String] option  Value of the checkbox to deselect\n      #   @option options [String, Regexp] id       Match fields that match the id attribute\n      #   @option options [String] name     Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @macro label_click\n      #   @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]  The element unchecked or the label clicked\n      def uncheck(locator = nil, **options)\n        _check_with_label(:checkbox, false, locator, **options)\n      end\n\n      ##\n      #\n      # If `from` option is present, {#select} finds a select box, or text input with associated datalist,\n      # on the page and selects a particular option from it.\n      # Otherwise it finds an option inside current scope and selects it.\n      # If the select box is a multiple select, {#select} can be called multiple times to select more than\n      # one option.\n      # The select box can be found via its name, id, {Capybara.configure test_id} attribute, or label text.\n      # The option can be found by its text.\n      #\n      #     page.select 'March', from: 'Month'\n      #\n      # @overload select(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String] Which option to select\n      #   @param from [String]  The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      # @return [Capybara::Node::Element]  The option element selected\n      def select(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        el = from ? find_select_or_datalist_input(from, options) : self\n\n        if el.respond_to?(:tag_name) && (el.tag_name == 'input')\n          select_datalist_option(el, value)\n        else\n          el.find(:option, value, **options).select_option\n        end\n      end\n\n      ##\n      #\n      # Find a select box on the page and unselect a particular option from it. If the select\n      # box is a multiple select, {#unselect} can be called multiple times to unselect more than\n      # one option. The select box can be found via its name, id, {Capybara.configure test_id} attribute,\n      # or label text.\n      #\n      #     page.unselect 'March', from: 'Month'\n      #\n      # @overload unselect(value = nil, from: nil, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param value [String]     Which option to unselect\n      #   @param from [String]      The id, {Capybara.configure test_id} attribute, name or label of the select box\n      #\n      #\n      # @return [Capybara::Node::Element]  The option element unselected\n      def unselect(value = nil, from: nil, **options)\n        raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element\n\n        scope = from ? find(:select, from, **options) : self\n        scope.find(:option, value, **options).unselect_option\n      end\n\n      ##\n      #\n      # Find a descendant file field on the page and attach a file given its path. There are two ways to use\n      # {#attach_file}, in the first method the file field can be found via its name, id,\n      # {Capybara.configure test_id} attribute, or label text. In the case of the file field being hidden for\n      # styling reasons the `make_visible` option can be used to temporarily change the CSS of\n      # the file field, attach the file, and then revert the CSS back to original. If no locator is\n      # passed this will match self or a descendant.\n      # The second method, which is currently in beta and may be changed/removed, involves passing a block\n      # which performs whatever actions would trigger the file chooser to appear.\n      #\n      #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'\n      #     page.attach_file('My File', '/path/to/file.png')\n      #\n      #     # will attach file to el if it's a file input element\n      #     el.attach_file('/path/to/file.png')\n      #\n      #     # will attach file to whatever file input is triggered by the block\n      #     page.attach_file('/path/to/file.png') do\n      #       page.find('#upload_button').click\n      #     end\n      #\n      # @overload attach_file([locator], paths, **options)\n      #   @macro waiting_behavior\n      #\n      #   @param [String] locator                  Which field to attach the file to\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #\n      #   @option options [Symbol] match\n      #     The matching strategy to use (:one, :first, :prefer_exact, :smart). Defaults to {Capybara.configure match}.\n      #   @option options [Boolean] exact\n      #     Match the exact label name/contents or accept a partial match. Defaults to {Capybara.configure exact}.\n      #   @option options [Boolean] multiple Match field which allows multiple file selection\n      #   @option options [String, Regexp] id             Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided\n      #   @option options [true, Hash] make_visible\n      #     A Hash of CSS styles to change before attempting to attach the file, if `true`, `{ opacity: 1, display: 'block', visibility: 'visible' }` is used (may not be supported by all drivers).\n      # @overload attach_file(paths, &blk)\n      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached\n      #   @yield Block whose actions will trigger the system file chooser to be shown\n      # @return [Capybara::Node::Element]  The file field element\n      def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments\n        if locator && block_given?\n          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'\n        end\n\n        Array(paths).each do |path|\n          raise Capybara::FileNotFound, \"cannot attach file, #{path} does not exist\" unless File.exist?(path.to_s)\n        end\n        options[:allow_self] = true if locator.nil?\n\n        if block_given?\n          begin\n            execute_script CAPTURE_FILE_ELEMENT_SCRIPT\n            yield\n            file_field = evaluate_script 'window._capybara_clicked_file_input'\n            raise ArgumentError, \"Capybara was unable to determine the file input you're attaching to\" unless file_field\n          rescue ::Capybara::NotSupportedByDriverError\n            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'\n          end\n        end\n        # Allow user to update the CSS style of the file input since they are so often hidden on a page\n        if make_visible\n          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))\n          while_visible(ff, make_visible) { |el| el.set(paths) }\n        else\n          (file_field || find(:file_field, locator, **options)).set(paths)\n        end\n      end\n\n    private\n\n      def find_select_or_datalist_input(from, options)\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          find(:select, from, **options)\n        rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName\n          raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }\n\n          begin\n            find(:datalist_input, from, **options)\n          rescue Capybara::ElementNotFound => dlinput_error\n            raise Capybara::ElementNotFound, \"#{select_error.message} and #{dlinput_error.message}\"\n          end\n        end\n      end\n\n      def select_datalist_option(input, value)\n        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)\n        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }\n        raise ::Capybara::ElementNotFound, %(Unable to find datalist option \"#{value}\") unless option\n\n        input.set(option['value'])\n      rescue ::Capybara::NotSupportedByDriverError\n        # Implement for drivers that don't support JS\n        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)\n        option = datalist.find(:datalist_option, value, disabled: false)\n        input.set(option.value)\n      end\n\n      def while_visible(element, visible_css)\n        if visible_css == true\n          visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }\n        end\n        _update_style(element, visible_css)\n        unless element.visible?\n          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'\n        end\n\n        begin\n          yield element\n        ensure\n          _reset_style(element)\n        end\n      end\n\n      def _update_style(element, style)\n        element.execute_script(UPDATE_STYLE_SCRIPT, style)\n      rescue Capybara::NotSupportedByDriverError\n        warn 'The :make_visible option is not supported by the current driver - ignoring'\n      end\n\n      def _reset_style(element)\n        element.execute_script(RESET_STYLE_SCRIPT)\n      rescue StandardError # rubocop:disable Lint/SuppressedException -- swallow extra errors\n      end\n\n      def _check_with_label(selector, checked, locator,\n                            allow_label_click: session_options.automatic_label_click, **options)\n        options[:allow_self] = true if locator.nil?\n        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do\n          el = find(selector, locator, **options)\n          el.set(checked)\n        rescue StandardError => e\n          raise unless allow_label_click && catch_error?(e)\n\n          begin\n            el ||= find(selector, locator, **options.merge(visible: :all))\n            unless el.checked? == checked\n              el.session\n                .find(:label, for: el, visible: true, match: :first)\n                .click(**(Hash.try_convert(allow_label_click) || {}))\n            end\n          rescue StandardError # swallow extra errors - raise original\n            raise e\n          end\n        end\n      end\n\n      UPDATE_STYLE_SCRIPT = <<~JS\n        this.capybara_style_cache = this.style.cssText;\n        var css = arguments[0];\n        for (var prop in css){\n          if (css.hasOwnProperty(prop)) {\n            this.style.setProperty(prop, css[prop], \"important\");\n          }\n        }\n      JS\n\n      RESET_STYLE_SCRIPT = <<~JS\n        if (this.hasOwnProperty('capybara_style_cache')) {\n          this.style.cssText = this.capybara_style_cache;\n          delete this.capybara_style_cache;\n        }\n      JS\n\n      DATALIST_OPTIONS_SCRIPT = <<~JS\n        Array.prototype.slice.call((this.list||{}).options || []).\n          filter(function(el){ return !el.disabled }).\n          map(function(el){ return { \"value\": el.value, \"label\": el.label} })\n      JS\n\n      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS\n        document.addEventListener('click', function file_catcher(e){\n          if (e.target.matches(\"input[type='file']\")) {\n            window._capybara_clicked_file_input = e.target;\n            this.removeEventListener('click', file_catcher);\n            e.preventDefault();\n          }\n        }, {capture: true})\n      JS\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "while_visible", "signature": "def while_visible(element, visible_css)", "start_line": 337, "end_line": 351}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 24}
{"function_name": "synchronize", "file_path": "capybara/lib/capybara/node/base.rb", "focal_code": "def synchronize(seconds = nil, errors: nil)\n        return yield if session.synchronized\n\n        seconds = session_options.default_max_wait_time if [nil, true].include? seconds\n        interval = session_options.default_retry_interval\n        session.synchronized = true\n        timer = Capybara::Helpers.timer(expire_in: seconds)\n        begin\n          yield\n        rescue StandardError => e\n          session.raise_server_error!\n          raise e unless catch_error?(e, errors)\n\n          if driver.wait?\n            raise e if timer.expired?\n\n            sleep interval\n            reload if session_options.automatic_reload\n          else\n            old_base = @base\n            reload if session_options.automatic_reload\n            raise e if old_base == @base\n          end\n          retry\n        ensure\n          session.synchronized = false\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Base} represents either an element on a page through the subclass\n    # {Capybara::Node::Element} or a document through {Capybara::Node::Document}.\n    #\n    # Both types of Node share the same methods, used for interacting with the\n    # elements on the page. These methods are divided into three categories,\n    # finders, actions and matchers. These are found in the modules\n    # {Capybara::Node::Finders}, {Capybara::Node::Actions} and {Capybara::Node::Matchers}\n    # respectively.\n    #\n    # A {Capybara::Session} exposes all methods from {Capybara::Node::Document} directly:\n    #\n    #     session = Capybara::Session.new(:rack_test, my_app)\n    #     session.visit('/')\n    #     session.fill_in('Foo', with: 'Bar')    # from Capybara::Node::Actions\n    #     bar = session.find('#bar')                # from Capybara::Node::Finders\n    #     bar.select('Baz', from: 'Quox')        # from Capybara::Node::Actions\n    #     session.has_css?('#foobar')               # from Capybara::Node::Matchers\n    #\n    class Base\n      attr_reader :session, :base, :query_scope\n\n      include Capybara::Node::Finders\n      include Capybara::Node::Actions\n      include Capybara::Node::Matchers\n\n      def initialize(session, base)\n        @session = session\n        @base = base\n      end\n\n      # overridden in subclasses, e.g. Capybara::Node::Element\n      def reload\n        self\n      end\n\n      ##\n      #\n      # This method is Capybara's primary defence against asynchronicity\n      # problems. It works by attempting to run a given block of code until it\n      # succeeds. The exact behaviour of this method depends on a number of\n      # factors. Basically there are certain exceptions which, when raised\n      # from the block, instead of bubbling up, are caught, and the block is\n      # re-run.\n      #\n      # Certain drivers, such as RackTest, have no support for asynchronous\n      # processes, these drivers run the block, and any error raised bubbles up\n      # immediately. This allows faster turn around in the case where an\n      # expectation fails.\n      #\n      # Only exceptions that are {Capybara::ElementNotFound} or any subclass\n      # thereof cause the block to be rerun. Drivers may specify additional\n      # exceptions which also cause reruns. This usually occurs when a node is\n      # manipulated which no longer exists on the page. For example, the\n      # Selenium driver specifies\n      # `Selenium::WebDriver::Error::ObsoleteElementError`.\n      #\n      # As long as any of these exceptions are thrown, the block is re-run,\n      # until a certain amount of time passes. The amount of time defaults to\n      # {Capybara.default_max_wait_time} and can be overridden through the `seconds`\n      # argument. This time is compared with the system time to see how much\n      # time has passed. On rubies/platforms which don't support access to a monotonic process clock\n      # if the return value of `Time.now` is stubbed out, Capybara will raise `Capybara::FrozenInTime`.\n      #\n      # @param  [Integer] seconds  (current sessions default_max_wait_time) Maximum number of seconds to retry this block\n      # @param  [Array<Exception>] errors (driver.invalid_element_errors +\n      #   [Capybara::ElementNotFound]) exception types that cause the block to be rerun\n      # @return [Object]                  The result of the given block\n      # @raise  [Capybara::FrozenInTime]  If the return value of `Time.now` appears stuck\n      #\n      def synchronize(seconds = nil, errors: nil)\n        return yield if session.synchronized\n\n        seconds = session_options.default_max_wait_time if [nil, true].include? seconds\n        interval = session_options.default_retry_interval\n        session.synchronized = true\n        timer = Capybara::Helpers.timer(expire_in: seconds)\n        begin\n          yield\n        rescue StandardError => e\n          session.raise_server_error!\n          raise e unless catch_error?(e, errors)\n\n          if driver.wait?\n            raise e if timer.expired?\n\n            sleep interval\n            reload if session_options.automatic_reload\n          else\n            old_base = @base\n            reload if session_options.automatic_reload\n            raise e if old_base == @base\n          end\n          retry\n        ensure\n          session.synchronized = false\n        end\n      end\n\n      # @api private\n      def find_css(css, **options)\n        if base.method(:find_css).arity == 1\n          base.find_css(css)\n        else\n          base.find_css(css, **options)\n        end\n      end\n\n      # @api private\n      def find_xpath(xpath, **options)\n        if base.method(:find_xpath).arity == 1\n          base.find_xpath(xpath)\n        else\n          base.find_xpath(xpath, **options)\n        end\n      end\n\n      # @api private\n      def session_options\n        session.config\n      end\n\n      def to_capybara_node\n        self\n      end\n\n    protected\n\n      def catch_error?(error, errors = nil)\n        errors ||= (driver.invalid_element_errors + [Capybara::ElementNotFound])\n        errors.any? { |type| error.is_a?(type) }\n      end\n\n      def driver\n        session.driver\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "synchronize", "signature": "def synchronize(seconds = nil, errors: nil)", "start_line": 76, "end_line": 103}, "metadata": {"module": "Capybara", "class_name": "Base", "class_signature": "class Base"}, "task_id": 25}
{"function_name": "style", "file_path": "capybara/lib/capybara/node/element.rb", "focal_code": "def style(*styles)\n        styles = styles.flatten.map(&:to_s)\n        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?\n\n        begin\n          synchronize { base.style(styles) }\n        rescue NotImplementedError => e\n          begin\n            evaluate_script(STYLE_SCRIPT, *styles)\n          rescue Capybara::NotSupportedByDriverError\n            raise e\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Element} represents a single element on the page. It is possible\n    # to interact with the contents of this element the same as with a document:\n    #\n    #     session = Capybara::Session.new(:rack_test, my_app)\n    #\n    #     bar = session.find('#bar')              # from Capybara::Node::Finders\n    #     bar.select('Baz', from: 'Quox')      # from Capybara::Node::Actions\n    #\n    # {Capybara::Node::Element} also has access to HTML attributes and other properties of the\n    # element:\n    #\n    #      bar.value\n    #      bar.text\n    #      bar[:title]\n    #\n    # @see Capybara::Node\n    #\n    class Element < Base\n      def initialize(session, base, query_scope, query)\n        super(session, base)\n        @query_scope = query_scope\n        @query = query\n        @allow_reload = false\n        @query_idx = nil\n      end\n\n      def allow_reload!(idx = nil)\n        @query_idx = idx\n        @allow_reload = true\n      end\n\n      ##\n      #\n      # @return [Object]    The native element from the driver, this allows access to driver specific methods\n      #\n      def native\n        synchronize { base.native }\n      end\n\n      ##\n      #\n      # Retrieve the text of the element. If {Capybara.configure ignore_hidden_elements}\n      # is `true`, which it is by default, then this will return only text\n      # which is visible. The exact semantics of this may differ between\n      # drivers, but generally any text within elements with `display:none` is\n      # ignored. This behaviour can be overridden by passing `:all` to this\n      # method.\n      #\n      # @param type [:all, :visible]  Whether to return only visible or all text\n      # @return [String]              The text of the element\n      #\n      def text(type = nil, normalize_ws: false)\n        type ||= :all unless session_options.ignore_hidden_elements || session_options.visible_text_only\n        txt = synchronize { type == :all ? base.all_text : base.visible_text }\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute.\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] attribute     The attribute to retrieve\n      # @return [String]               The value of the attribute\n      #\n      def [](attribute)\n        synchronize { base[attribute] }\n      end\n\n      ##\n      #\n      # Retrieve the given CSS styles.\n      #\n      #     element.style('color', 'font-size') # => Computed values of CSS 'color' and 'font-size' styles\n      #\n      # @param [Array<String>] styles   Names of the desired CSS properties\n      # @return [Hash]            Hash of the CSS property names to computed values\n      #\n      def style(*styles)\n        styles = styles.flatten.map(&:to_s)\n        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?\n\n        begin\n          synchronize { base.style(styles) }\n        rescue NotImplementedError => e\n          begin\n            evaluate_script(STYLE_SCRIPT, *styles)\n          rescue Capybara::NotSupportedByDriverError\n            raise e\n          end\n        end\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        synchronize { base.value }\n      end\n\n      ##\n      #\n      # Set the value of the form element to the given value.\n      #\n      # @param [String] value    The new value\n      # @param [Hash] options    Driver specific options for how to set the value. Take default values from {Capybara.configure default_set_options}.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def set(value, **options)\n        if ENV.fetch('CAPYBARA_THOROUGH', nil) && readonly?\n          raise Capybara::ReadOnlyElementError, \"Attempt to set readonly element with value: #{value}\"\n        end\n\n        options = session_options.default_set_options.to_h.merge(options)\n        synchronize { base.set(value, **options) }\n        self\n      end\n\n      ##\n      #\n      # Select this node if it is an option element inside a select tag.\n      #\n      # @!macro action_waiting_behavior\n      #   If the driver dynamic pages (JS) and the element is currently non-interactable, this method will\n      #   continuously retry the action until either the element becomes interactable or the maximum\n      #   wait time expires.\n      #\n      #   @param [false, Numeric] wait\n      #     Maximum time to wait for the action to succeed. Defaults to {Capybara.configure default_max_wait_time}.\n      # @return [Capybara::Node::Element]  The element\n      def select_option(wait: nil)\n        synchronize(wait) { base.select_option }\n        self\n      end\n\n      ##\n      #\n      # Unselect this node if it is an option element inside a multiple select tag.\n      #\n      # @macro action_waiting_behavior\n      # @return [Capybara::Node::Element]  The element\n      def unselect_option(wait: nil)\n        synchronize(wait) { base.unselect_option }\n        self\n      end\n\n      ##\n      #\n      # Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @!macro click_modifiers\n      #   Both x: and y: must be specified if an offset is wanted, if not specified the click will occur at the middle of the element.\n      #   @overload $0(*modifier_keys, wait: nil, **offset)\n      #     @param *modifier_keys [:alt, :control, :meta, :shift] ([]) Keys to be held down when clicking\n      #     @option options [Integer] x  X coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      #     @option options [Integer] y  Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Right Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def right_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.right_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Double Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @return [Capybara::Node::Element]  The element\n      def double_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.double_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Send Keystrokes to the Element.\n      #\n      # @overload send_keys(keys, ...)\n      #   @param keys [String, Symbol, Array<String,Symbol>]\n      #\n      # Examples:\n      #\n      #     element.send_keys \"foo\"                     #=> value: 'foo'\n      #     element.send_keys \"tet\", :left, \"s\"         #=> value: 'test'\n      #     element.send_keys [:control, 'a'], :space   #=> value: ' ' - assuming ctrl-a selects all contents\n      #\n      # Symbols supported for keys:\n      # * :cancel\n      # * :help\n      # * :backspace\n      # * :tab\n      # * :clear\n      # * :return\n      # * :enter\n      # * :shift\n      # * :control\n      # * :alt\n      # * :pause\n      # * :escape\n      # * :space\n      # * :page_up\n      # * :page_down\n      # * :end\n      # * :home\n      # * :left\n      # * :up\n      # * :right\n      # * :down\n      # * :insert\n      # * :delete\n      # * :semicolon\n      # * :equals\n      # * :numpad0\n      # * :numpad1\n      # * :numpad2\n      # * :numpad3\n      # * :numpad4\n      # * :numpad5\n      # * :numpad6\n      # * :numpad7\n      # * :numpad8\n      # * :numpad9\n      # * :multiply      - numeric keypad *\n      # * :add           - numeric keypad +\n      # * :separator     - numeric keypad 'separator' key ??\n      # * :subtract      - numeric keypad -\n      # * :decimal       - numeric keypad .\n      # * :divide        - numeric keypad /\n      # * :f1\n      # * :f2\n      # * :f3\n      # * :f4\n      # * :f5\n      # * :f6\n      # * :f7\n      # * :f8\n      # * :f9\n      # * :f10\n      # * :f11\n      # * :f12\n      # * :meta\n      # * :command      - alias of :meta\n      #\n      # @return [Capybara::Node::Element]  The element\n      def send_keys(*args)\n        synchronize { base.send_keys(*args) }\n        self\n      end\n\n      ##\n      #\n      # Hover on the Element.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def hover\n        synchronize { base.hover }\n        self\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        # Element type is immutable so cache it\n        @tag_name ||= initial_cache[:tag_name] || synchronize { base.tag_name }\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Not all drivers support CSS, so\n      # the result may be inaccurate.\n      #\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?\n        synchronize { base.visible? }\n      end\n\n      ##\n      #\n      # Whether or not the element is currently in the viewport and it (or descendants)\n      # would be considered clickable at the elements center point.\n      #\n      # @return [Boolean]     Whether the elements center is obscured.\n      #\n      def obscured?\n        synchronize { base.obscured? }\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        synchronize { base.checked? }\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        synchronize { base.selected? }\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      #\n      def disabled?\n        synchronize { base.disabled? }\n      end\n\n      ##\n      #\n      # Whether or not the element is readonly.\n      #\n      # @return [Boolean]     Whether the element is readonly\n      #\n      def readonly?\n        synchronize { base.readonly? }\n      end\n\n      ##\n      #\n      # Whether or not the element supports multiple results.\n      #\n      # @return [Boolean]     Whether the element supports multiple results.\n      #\n      def multiple?\n        synchronize { base.multiple? }\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found.\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        synchronize { base.path }\n      end\n\n      def rect\n        synchronize { base.rect }\n      end\n\n      ##\n      #\n      # Trigger any event on the current element, for example mouseover or focus\n      # events. Not supported with the Selenium driver, and SHOULDN'T BE USED IN TESTING unless you\n      # fully understand why you're using it, that it can allow actions a user could never\n      # perform, and that it may completely invalidate your test.\n      #\n      # @param [String] event       The name of the event to trigger\n      #\n      # @return [Capybara::Node::Element]  The element\n      def trigger(event)\n        synchronize { base.trigger(event) }\n        self\n      end\n\n      ##\n      #\n      # Drag the element to the given other element.\n      #\n      #     source = page.find('#foo')\n      #     target = page.find('#bar')\n      #     source.drag_to(target)\n      #\n      # @param [Capybara::Node::Element] node     The element to drag to\n      # @param [Hash] options  Driver specific options for dragging. May not be supported by all drivers.\n      # @option options [Numeric] :delay   (0.05) When using Chrome/Firefox with Selenium and HTML5 dragging this is the number\n      #                                    of seconds between each stage of the drag.\n      # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5\n      #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to\n      #                                    detect the correct method to use.\n      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.\n      #\n      #\n      # @return [Capybara::Node::Element]  The dragged element\n      def drag_to(node, **options)\n        synchronize { base.drag_to(node.base, **options) }\n        self\n      end\n\n      ##\n      #\n      # Drop items on the current element.\n      #\n      #     target = page.find('#foo')\n      #     target.drop('/some/path/file.csv')\n      #\n      # @overload drop(path, ...)\n      #   @param [String, #to_path] path Location of the file to drop on the element\n      #\n      # @overload drop(strings, ...)\n      #   @param [Hash] strings A hash of type to data to be dropped - `{ \"text/url\" => \"https://www.google.com\" }`\n      #\n      # @return [Capybara::Node::Element]  The element\n      def drop(*args)\n        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }\n        synchronize { base.drop(*options) }\n        self\n      end\n\n      ##\n      #\n      # Scroll the page or element.\n      #\n      # @overload scroll_to(position, offset: [0,0])\n      #   Scroll the page or element to its top, bottom or middle.\n      #   @param [:top, :bottom, :center, :current] position\n      #   @param [[Integer, Integer]] offset\n      #\n      # @overload scroll_to(element, align: :top)\n      #   Scroll the page or current element until the given element is aligned at the top, bottom, or center of it.\n      #   @param [Capybara::Node::Element] element   The element to be scrolled into view\n      #   @param [:top, :bottom, :center] align Where to align the element being scrolled into view with relation to the current page/element if possible\n      #\n      # @overload scroll_to(x,y)\n      #   @param [Integer] x    Horizontal scroll offset\n      #   @param [Integer] y    Vertical scroll offset\n      #\n      # @return [Capybara::Node::Element]  The element\n      def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)\n        case pos_or_el_or_x\n        when Symbol\n          synchronize { base.scroll_to(nil, pos_or_el_or_x) } unless pos_or_el_or_x == :current\n        when Capybara::Node::Element\n          synchronize { base.scroll_to(pos_or_el_or_x.base, align) }\n        else\n          synchronize { base.scroll_to(nil, nil, [pos_or_el_or_x, y]) }\n        end\n        synchronize { base.scroll_by(*offset) } unless offset.nil?\n        self\n      end\n\n      ##\n      #\n      # Return the shadow_root for the current element\n      #\n      # @return [Capybara::Node::Element]  The shadow root\n\n      def shadow_root\n        root = synchronize { base.shadow_root }\n        root && Capybara::Node::Element.new(session, root, nil, nil)\n      end\n\n      ##\n      #\n      # Execute the given JS in the context of the element not returning a result. This is useful for scripts that return\n      # complex objects, such as jQuery statements. {#execute_script} should be used over\n      # {#evaluate_script} whenever a result is not expected or needed. `this` in the script will refer to the element this is called on.\n      #\n      # @param [String] script   A string of JavaScript to execute\n      # @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 drivers\n      #\n      def execute_script(script, *args)\n        session.execute_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JS in the context of the element and return the result. Be careful when using this with\n      # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n      # be a better alternative. `this` in the script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_script(script, *args)\n        session.evaluate_script(<<~JS, self, *args)\n          (function(){\n            return #{script.strip}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JavaScript in the context of the element and obtain the result from a\n      # callback function which will be passed as the last argument to the script. `this` in the\n      # script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_async_script(script, *args)\n        session.evaluate_async_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Toggle the elements background color between white and black for a period of time.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def flash\n        execute_script(<<~JS, 100)\n          async function flash(el, delay){\n            var old_bg = el.style.backgroundColor;\n            var colors = [\"black\", \"white\"];\n            for(var i=0; i<20; i++){\n              el.style.backgroundColor = colors[i % colors.length];\n              await new Promise(resolve => setTimeout(resolve, delay));\n            }\n            el.style.backgroundColor = old_bg;\n          }\n          flash(this, arguments[0]);\n        JS\n\n        self\n      end\n\n      # @api private\n      def reload\n        return self unless @allow_reload\n\n        begin\n          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]\n          @base = reloaded.base if reloaded\n        rescue StandardError => e\n          raise e unless catch_error?(e)\n        end\n        self\n      end\n\n      ##\n      #\n      # A human-readable representation of the element.\n      #\n      # @return [String]  A string representation\n      def inspect\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\" path=\"#{base.path}\">)\n      rescue NotSupportedByDriverError\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\">)\n      rescue *session.driver.invalid_element_errors\n        %(Obsolete #<Capybara::Node::Element>)\n      end\n\n      # @api private\n      def initial_cache\n        base.respond_to?(:initial_cache) ? base.initial_cache : {}\n      end\n\n      STYLE_SCRIPT = <<~JS\n        (function(){\n          var s = window.getComputedStyle(this);\n          var result = {};\n          for (var i = arguments.length; i--; ) {\n            var property_name = arguments[i];\n            result[property_name] = s.getPropertyValue(property_name);\n          }\n          return result;\n        }).apply(this, arguments)\n      JS\n\n    private\n\n      def perform_click_action(keys, wait: nil, **options)\n        raise ArgumentError, 'You must specify both x: and y: for a click offset' if nil ^ options[:x] ^ options[:y]\n\n        options[:offset] ||= :center if session_options.w3c_click_offset\n        synchronize(wait) { yield keys, options }\n        self\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "style", "signature": "def style(*styles)", "start_line": 86, "end_line": 99}, "metadata": {"module": "Capybara", "class_name": "Element", "class_signature": "class Element < < Base"}, "task_id": 26}
{"function_name": "scroll_to", "file_path": "capybara/lib/capybara/node/element.rb", "focal_code": "def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)\n        case pos_or_el_or_x\n        when Symbol\n          synchronize { base.scroll_to(nil, pos_or_el_or_x) } unless pos_or_el_or_x == :current\n        when Capybara::Node::Element\n          synchronize { base.scroll_to(pos_or_el_or_x.base, align) }\n        else\n          synchronize { base.scroll_to(nil, nil, [pos_or_el_or_x, y]) }\n        end\n        synchronize { base.scroll_by(*offset) } unless offset.nil?\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Element} represents a single element on the page. It is possible\n    # to interact with the contents of this element the same as with a document:\n    #\n    #     session = Capybara::Session.new(:rack_test, my_app)\n    #\n    #     bar = session.find('#bar')              # from Capybara::Node::Finders\n    #     bar.select('Baz', from: 'Quox')      # from Capybara::Node::Actions\n    #\n    # {Capybara::Node::Element} also has access to HTML attributes and other properties of the\n    # element:\n    #\n    #      bar.value\n    #      bar.text\n    #      bar[:title]\n    #\n    # @see Capybara::Node\n    #\n    class Element < Base\n      def initialize(session, base, query_scope, query)\n        super(session, base)\n        @query_scope = query_scope\n        @query = query\n        @allow_reload = false\n        @query_idx = nil\n      end\n\n      def allow_reload!(idx = nil)\n        @query_idx = idx\n        @allow_reload = true\n      end\n\n      ##\n      #\n      # @return [Object]    The native element from the driver, this allows access to driver specific methods\n      #\n      def native\n        synchronize { base.native }\n      end\n\n      ##\n      #\n      # Retrieve the text of the element. If {Capybara.configure ignore_hidden_elements}\n      # is `true`, which it is by default, then this will return only text\n      # which is visible. The exact semantics of this may differ between\n      # drivers, but generally any text within elements with `display:none` is\n      # ignored. This behaviour can be overridden by passing `:all` to this\n      # method.\n      #\n      # @param type [:all, :visible]  Whether to return only visible or all text\n      # @return [String]              The text of the element\n      #\n      def text(type = nil, normalize_ws: false)\n        type ||= :all unless session_options.ignore_hidden_elements || session_options.visible_text_only\n        txt = synchronize { type == :all ? base.all_text : base.visible_text }\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute.\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] attribute     The attribute to retrieve\n      # @return [String]               The value of the attribute\n      #\n      def [](attribute)\n        synchronize { base[attribute] }\n      end\n\n      ##\n      #\n      # Retrieve the given CSS styles.\n      #\n      #     element.style('color', 'font-size') # => Computed values of CSS 'color' and 'font-size' styles\n      #\n      # @param [Array<String>] styles   Names of the desired CSS properties\n      # @return [Hash]            Hash of the CSS property names to computed values\n      #\n      def style(*styles)\n        styles = styles.flatten.map(&:to_s)\n        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?\n\n        begin\n          synchronize { base.style(styles) }\n        rescue NotImplementedError => e\n          begin\n            evaluate_script(STYLE_SCRIPT, *styles)\n          rescue Capybara::NotSupportedByDriverError\n            raise e\n          end\n        end\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        synchronize { base.value }\n      end\n\n      ##\n      #\n      # Set the value of the form element to the given value.\n      #\n      # @param [String] value    The new value\n      # @param [Hash] options    Driver specific options for how to set the value. Take default values from {Capybara.configure default_set_options}.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def set(value, **options)\n        if ENV.fetch('CAPYBARA_THOROUGH', nil) && readonly?\n          raise Capybara::ReadOnlyElementError, \"Attempt to set readonly element with value: #{value}\"\n        end\n\n        options = session_options.default_set_options.to_h.merge(options)\n        synchronize { base.set(value, **options) }\n        self\n      end\n\n      ##\n      #\n      # Select this node if it is an option element inside a select tag.\n      #\n      # @!macro action_waiting_behavior\n      #   If the driver dynamic pages (JS) and the element is currently non-interactable, this method will\n      #   continuously retry the action until either the element becomes interactable or the maximum\n      #   wait time expires.\n      #\n      #   @param [false, Numeric] wait\n      #     Maximum time to wait for the action to succeed. Defaults to {Capybara.configure default_max_wait_time}.\n      # @return [Capybara::Node::Element]  The element\n      def select_option(wait: nil)\n        synchronize(wait) { base.select_option }\n        self\n      end\n\n      ##\n      #\n      # Unselect this node if it is an option element inside a multiple select tag.\n      #\n      # @macro action_waiting_behavior\n      # @return [Capybara::Node::Element]  The element\n      def unselect_option(wait: nil)\n        synchronize(wait) { base.unselect_option }\n        self\n      end\n\n      ##\n      #\n      # Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @!macro click_modifiers\n      #   Both x: and y: must be specified if an offset is wanted, if not specified the click will occur at the middle of the element.\n      #   @overload $0(*modifier_keys, wait: nil, **offset)\n      #     @param *modifier_keys [:alt, :control, :meta, :shift] ([]) Keys to be held down when clicking\n      #     @option options [Integer] x  X coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      #     @option options [Integer] y  Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Right Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def right_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.right_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Double Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @return [Capybara::Node::Element]  The element\n      def double_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.double_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Send Keystrokes to the Element.\n      #\n      # @overload send_keys(keys, ...)\n      #   @param keys [String, Symbol, Array<String,Symbol>]\n      #\n      # Examples:\n      #\n      #     element.send_keys \"foo\"                     #=> value: 'foo'\n      #     element.send_keys \"tet\", :left, \"s\"         #=> value: 'test'\n      #     element.send_keys [:control, 'a'], :space   #=> value: ' ' - assuming ctrl-a selects all contents\n      #\n      # Symbols supported for keys:\n      # * :cancel\n      # * :help\n      # * :backspace\n      # * :tab\n      # * :clear\n      # * :return\n      # * :enter\n      # * :shift\n      # * :control\n      # * :alt\n      # * :pause\n      # * :escape\n      # * :space\n      # * :page_up\n      # * :page_down\n      # * :end\n      # * :home\n      # * :left\n      # * :up\n      # * :right\n      # * :down\n      # * :insert\n      # * :delete\n      # * :semicolon\n      # * :equals\n      # * :numpad0\n      # * :numpad1\n      # * :numpad2\n      # * :numpad3\n      # * :numpad4\n      # * :numpad5\n      # * :numpad6\n      # * :numpad7\n      # * :numpad8\n      # * :numpad9\n      # * :multiply      - numeric keypad *\n      # * :add           - numeric keypad +\n      # * :separator     - numeric keypad 'separator' key ??\n      # * :subtract      - numeric keypad -\n      # * :decimal       - numeric keypad .\n      # * :divide        - numeric keypad /\n      # * :f1\n      # * :f2\n      # * :f3\n      # * :f4\n      # * :f5\n      # * :f6\n      # * :f7\n      # * :f8\n      # * :f9\n      # * :f10\n      # * :f11\n      # * :f12\n      # * :meta\n      # * :command      - alias of :meta\n      #\n      # @return [Capybara::Node::Element]  The element\n      def send_keys(*args)\n        synchronize { base.send_keys(*args) }\n        self\n      end\n\n      ##\n      #\n      # Hover on the Element.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def hover\n        synchronize { base.hover }\n        self\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        # Element type is immutable so cache it\n        @tag_name ||= initial_cache[:tag_name] || synchronize { base.tag_name }\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Not all drivers support CSS, so\n      # the result may be inaccurate.\n      #\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?\n        synchronize { base.visible? }\n      end\n\n      ##\n      #\n      # Whether or not the element is currently in the viewport and it (or descendants)\n      # would be considered clickable at the elements center point.\n      #\n      # @return [Boolean]     Whether the elements center is obscured.\n      #\n      def obscured?\n        synchronize { base.obscured? }\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        synchronize { base.checked? }\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        synchronize { base.selected? }\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      #\n      def disabled?\n        synchronize { base.disabled? }\n      end\n\n      ##\n      #\n      # Whether or not the element is readonly.\n      #\n      # @return [Boolean]     Whether the element is readonly\n      #\n      def readonly?\n        synchronize { base.readonly? }\n      end\n\n      ##\n      #\n      # Whether or not the element supports multiple results.\n      #\n      # @return [Boolean]     Whether the element supports multiple results.\n      #\n      def multiple?\n        synchronize { base.multiple? }\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found.\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        synchronize { base.path }\n      end\n\n      def rect\n        synchronize { base.rect }\n      end\n\n      ##\n      #\n      # Trigger any event on the current element, for example mouseover or focus\n      # events. Not supported with the Selenium driver, and SHOULDN'T BE USED IN TESTING unless you\n      # fully understand why you're using it, that it can allow actions a user could never\n      # perform, and that it may completely invalidate your test.\n      #\n      # @param [String] event       The name of the event to trigger\n      #\n      # @return [Capybara::Node::Element]  The element\n      def trigger(event)\n        synchronize { base.trigger(event) }\n        self\n      end\n\n      ##\n      #\n      # Drag the element to the given other element.\n      #\n      #     source = page.find('#foo')\n      #     target = page.find('#bar')\n      #     source.drag_to(target)\n      #\n      # @param [Capybara::Node::Element] node     The element to drag to\n      # @param [Hash] options  Driver specific options for dragging. May not be supported by all drivers.\n      # @option options [Numeric] :delay   (0.05) When using Chrome/Firefox with Selenium and HTML5 dragging this is the number\n      #                                    of seconds between each stage of the drag.\n      # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5\n      #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to\n      #                                    detect the correct method to use.\n      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.\n      #\n      #\n      # @return [Capybara::Node::Element]  The dragged element\n      def drag_to(node, **options)\n        synchronize { base.drag_to(node.base, **options) }\n        self\n      end\n\n      ##\n      #\n      # Drop items on the current element.\n      #\n      #     target = page.find('#foo')\n      #     target.drop('/some/path/file.csv')\n      #\n      # @overload drop(path, ...)\n      #   @param [String, #to_path] path Location of the file to drop on the element\n      #\n      # @overload drop(strings, ...)\n      #   @param [Hash] strings A hash of type to data to be dropped - `{ \"text/url\" => \"https://www.google.com\" }`\n      #\n      # @return [Capybara::Node::Element]  The element\n      def drop(*args)\n        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }\n        synchronize { base.drop(*options) }\n        self\n      end\n\n      ##\n      #\n      # Scroll the page or element.\n      #\n      # @overload scroll_to(position, offset: [0,0])\n      #   Scroll the page or element to its top, bottom or middle.\n      #   @param [:top, :bottom, :center, :current] position\n      #   @param [[Integer, Integer]] offset\n      #\n      # @overload scroll_to(element, align: :top)\n      #   Scroll the page or current element until the given element is aligned at the top, bottom, or center of it.\n      #   @param [Capybara::Node::Element] element   The element to be scrolled into view\n      #   @param [:top, :bottom, :center] align Where to align the element being scrolled into view with relation to the current page/element if possible\n      #\n      # @overload scroll_to(x,y)\n      #   @param [Integer] x    Horizontal scroll offset\n      #   @param [Integer] y    Vertical scroll offset\n      #\n      # @return [Capybara::Node::Element]  The element\n      def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)\n        case pos_or_el_or_x\n        when Symbol\n          synchronize { base.scroll_to(nil, pos_or_el_or_x) } unless pos_or_el_or_x == :current\n        when Capybara::Node::Element\n          synchronize { base.scroll_to(pos_or_el_or_x.base, align) }\n        else\n          synchronize { base.scroll_to(nil, nil, [pos_or_el_or_x, y]) }\n        end\n        synchronize { base.scroll_by(*offset) } unless offset.nil?\n        self\n      end\n\n      ##\n      #\n      # Return the shadow_root for the current element\n      #\n      # @return [Capybara::Node::Element]  The shadow root\n\n      def shadow_root\n        root = synchronize { base.shadow_root }\n        root && Capybara::Node::Element.new(session, root, nil, nil)\n      end\n\n      ##\n      #\n      # Execute the given JS in the context of the element not returning a result. This is useful for scripts that return\n      # complex objects, such as jQuery statements. {#execute_script} should be used over\n      # {#evaluate_script} whenever a result is not expected or needed. `this` in the script will refer to the element this is called on.\n      #\n      # @param [String] script   A string of JavaScript to execute\n      # @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 drivers\n      #\n      def execute_script(script, *args)\n        session.execute_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JS in the context of the element and return the result. Be careful when using this with\n      # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n      # be a better alternative. `this` in the script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_script(script, *args)\n        session.evaluate_script(<<~JS, self, *args)\n          (function(){\n            return #{script.strip}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JavaScript in the context of the element and obtain the result from a\n      # callback function which will be passed as the last argument to the script. `this` in the\n      # script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_async_script(script, *args)\n        session.evaluate_async_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Toggle the elements background color between white and black for a period of time.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def flash\n        execute_script(<<~JS, 100)\n          async function flash(el, delay){\n            var old_bg = el.style.backgroundColor;\n            var colors = [\"black\", \"white\"];\n            for(var i=0; i<20; i++){\n              el.style.backgroundColor = colors[i % colors.length];\n              await new Promise(resolve => setTimeout(resolve, delay));\n            }\n            el.style.backgroundColor = old_bg;\n          }\n          flash(this, arguments[0]);\n        JS\n\n        self\n      end\n\n      # @api private\n      def reload\n        return self unless @allow_reload\n\n        begin\n          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]\n          @base = reloaded.base if reloaded\n        rescue StandardError => e\n          raise e unless catch_error?(e)\n        end\n        self\n      end\n\n      ##\n      #\n      # A human-readable representation of the element.\n      #\n      # @return [String]  A string representation\n      def inspect\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\" path=\"#{base.path}\">)\n      rescue NotSupportedByDriverError\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\">)\n      rescue *session.driver.invalid_element_errors\n        %(Obsolete #<Capybara::Node::Element>)\n      end\n\n      # @api private\n      def initial_cache\n        base.respond_to?(:initial_cache) ? base.initial_cache : {}\n      end\n\n      STYLE_SCRIPT = <<~JS\n        (function(){\n          var s = window.getComputedStyle(this);\n          var result = {};\n          for (var i = arguments.length; i--; ) {\n            var property_name = arguments[i];\n            result[property_name] = s.getPropertyValue(property_name);\n          }\n          return result;\n        }).apply(this, arguments)\n      JS\n\n    private\n\n      def perform_click_action(keys, wait: nil, **options)\n        raise ArgumentError, 'You must specify both x: and y: for a click offset' if nil ^ options[:x] ^ options[:y]\n\n        options[:offset] ||= :center if session_options.w3c_click_offset\n        synchronize(wait) { yield keys, options }\n        self\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "scroll_to", "signature": "def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)", "start_line": 462, "end_line": 473}, "metadata": {"module": "Capybara", "class_name": "Element", "class_signature": "class Element < < Base"}, "task_id": 27}
{"function_name": "flash", "file_path": "capybara/lib/capybara/node/element.rb", "focal_code": "def flash\n        execute_script(<<~JS, 100)\n          async function flash(el, delay){\n            var old_bg = el.style.backgroundColor;\n            var colors = [\"black\", \"white\"];\n            for(var i=0; i<20; i++){\n              el.style.backgroundColor = colors[i % colors.length];\n              await new Promise(resolve => setTimeout(resolve, delay));\n            }\n            el.style.backgroundColor = old_bg;\n          }\n          flash(this, arguments[0]);\n        JS\n\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Element} represents a single element on the page. It is possible\n    # to interact with the contents of this element the same as with a document:\n    #\n    #     session = Capybara::Session.new(:rack_test, my_app)\n    #\n    #     bar = session.find('#bar')              # from Capybara::Node::Finders\n    #     bar.select('Baz', from: 'Quox')      # from Capybara::Node::Actions\n    #\n    # {Capybara::Node::Element} also has access to HTML attributes and other properties of the\n    # element:\n    #\n    #      bar.value\n    #      bar.text\n    #      bar[:title]\n    #\n    # @see Capybara::Node\n    #\n    class Element < Base\n      def initialize(session, base, query_scope, query)\n        super(session, base)\n        @query_scope = query_scope\n        @query = query\n        @allow_reload = false\n        @query_idx = nil\n      end\n\n      def allow_reload!(idx = nil)\n        @query_idx = idx\n        @allow_reload = true\n      end\n\n      ##\n      #\n      # @return [Object]    The native element from the driver, this allows access to driver specific methods\n      #\n      def native\n        synchronize { base.native }\n      end\n\n      ##\n      #\n      # Retrieve the text of the element. If {Capybara.configure ignore_hidden_elements}\n      # is `true`, which it is by default, then this will return only text\n      # which is visible. The exact semantics of this may differ between\n      # drivers, but generally any text within elements with `display:none` is\n      # ignored. This behaviour can be overridden by passing `:all` to this\n      # method.\n      #\n      # @param type [:all, :visible]  Whether to return only visible or all text\n      # @return [String]              The text of the element\n      #\n      def text(type = nil, normalize_ws: false)\n        type ||= :all unless session_options.ignore_hidden_elements || session_options.visible_text_only\n        txt = synchronize { type == :all ? base.all_text : base.visible_text }\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute.\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] attribute     The attribute to retrieve\n      # @return [String]               The value of the attribute\n      #\n      def [](attribute)\n        synchronize { base[attribute] }\n      end\n\n      ##\n      #\n      # Retrieve the given CSS styles.\n      #\n      #     element.style('color', 'font-size') # => Computed values of CSS 'color' and 'font-size' styles\n      #\n      # @param [Array<String>] styles   Names of the desired CSS properties\n      # @return [Hash]            Hash of the CSS property names to computed values\n      #\n      def style(*styles)\n        styles = styles.flatten.map(&:to_s)\n        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?\n\n        begin\n          synchronize { base.style(styles) }\n        rescue NotImplementedError => e\n          begin\n            evaluate_script(STYLE_SCRIPT, *styles)\n          rescue Capybara::NotSupportedByDriverError\n            raise e\n          end\n        end\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        synchronize { base.value }\n      end\n\n      ##\n      #\n      # Set the value of the form element to the given value.\n      #\n      # @param [String] value    The new value\n      # @param [Hash] options    Driver specific options for how to set the value. Take default values from {Capybara.configure default_set_options}.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def set(value, **options)\n        if ENV.fetch('CAPYBARA_THOROUGH', nil) && readonly?\n          raise Capybara::ReadOnlyElementError, \"Attempt to set readonly element with value: #{value}\"\n        end\n\n        options = session_options.default_set_options.to_h.merge(options)\n        synchronize { base.set(value, **options) }\n        self\n      end\n\n      ##\n      #\n      # Select this node if it is an option element inside a select tag.\n      #\n      # @!macro action_waiting_behavior\n      #   If the driver dynamic pages (JS) and the element is currently non-interactable, this method will\n      #   continuously retry the action until either the element becomes interactable or the maximum\n      #   wait time expires.\n      #\n      #   @param [false, Numeric] wait\n      #     Maximum time to wait for the action to succeed. Defaults to {Capybara.configure default_max_wait_time}.\n      # @return [Capybara::Node::Element]  The element\n      def select_option(wait: nil)\n        synchronize(wait) { base.select_option }\n        self\n      end\n\n      ##\n      #\n      # Unselect this node if it is an option element inside a multiple select tag.\n      #\n      # @macro action_waiting_behavior\n      # @return [Capybara::Node::Element]  The element\n      def unselect_option(wait: nil)\n        synchronize(wait) { base.unselect_option }\n        self\n      end\n\n      ##\n      #\n      # Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @!macro click_modifiers\n      #   Both x: and y: must be specified if an offset is wanted, if not specified the click will occur at the middle of the element.\n      #   @overload $0(*modifier_keys, wait: nil, **offset)\n      #     @param *modifier_keys [:alt, :control, :meta, :shift] ([]) Keys to be held down when clicking\n      #     @option options [Integer] x  X coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      #     @option options [Integer] y  Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Right Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def right_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.right_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Double Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @return [Capybara::Node::Element]  The element\n      def double_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.double_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Send Keystrokes to the Element.\n      #\n      # @overload send_keys(keys, ...)\n      #   @param keys [String, Symbol, Array<String,Symbol>]\n      #\n      # Examples:\n      #\n      #     element.send_keys \"foo\"                     #=> value: 'foo'\n      #     element.send_keys \"tet\", :left, \"s\"         #=> value: 'test'\n      #     element.send_keys [:control, 'a'], :space   #=> value: ' ' - assuming ctrl-a selects all contents\n      #\n      # Symbols supported for keys:\n      # * :cancel\n      # * :help\n      # * :backspace\n      # * :tab\n      # * :clear\n      # * :return\n      # * :enter\n      # * :shift\n      # * :control\n      # * :alt\n      # * :pause\n      # * :escape\n      # * :space\n      # * :page_up\n      # * :page_down\n      # * :end\n      # * :home\n      # * :left\n      # * :up\n      # * :right\n      # * :down\n      # * :insert\n      # * :delete\n      # * :semicolon\n      # * :equals\n      # * :numpad0\n      # * :numpad1\n      # * :numpad2\n      # * :numpad3\n      # * :numpad4\n      # * :numpad5\n      # * :numpad6\n      # * :numpad7\n      # * :numpad8\n      # * :numpad9\n      # * :multiply      - numeric keypad *\n      # * :add           - numeric keypad +\n      # * :separator     - numeric keypad 'separator' key ??\n      # * :subtract      - numeric keypad -\n      # * :decimal       - numeric keypad .\n      # * :divide        - numeric keypad /\n      # * :f1\n      # * :f2\n      # * :f3\n      # * :f4\n      # * :f5\n      # * :f6\n      # * :f7\n      # * :f8\n      # * :f9\n      # * :f10\n      # * :f11\n      # * :f12\n      # * :meta\n      # * :command      - alias of :meta\n      #\n      # @return [Capybara::Node::Element]  The element\n      def send_keys(*args)\n        synchronize { base.send_keys(*args) }\n        self\n      end\n\n      ##\n      #\n      # Hover on the Element.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def hover\n        synchronize { base.hover }\n        self\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        # Element type is immutable so cache it\n        @tag_name ||= initial_cache[:tag_name] || synchronize { base.tag_name }\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Not all drivers support CSS, so\n      # the result may be inaccurate.\n      #\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?\n        synchronize { base.visible? }\n      end\n\n      ##\n      #\n      # Whether or not the element is currently in the viewport and it (or descendants)\n      # would be considered clickable at the elements center point.\n      #\n      # @return [Boolean]     Whether the elements center is obscured.\n      #\n      def obscured?\n        synchronize { base.obscured? }\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        synchronize { base.checked? }\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        synchronize { base.selected? }\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      #\n      def disabled?\n        synchronize { base.disabled? }\n      end\n\n      ##\n      #\n      # Whether or not the element is readonly.\n      #\n      # @return [Boolean]     Whether the element is readonly\n      #\n      def readonly?\n        synchronize { base.readonly? }\n      end\n\n      ##\n      #\n      # Whether or not the element supports multiple results.\n      #\n      # @return [Boolean]     Whether the element supports multiple results.\n      #\n      def multiple?\n        synchronize { base.multiple? }\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found.\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        synchronize { base.path }\n      end\n\n      def rect\n        synchronize { base.rect }\n      end\n\n      ##\n      #\n      # Trigger any event on the current element, for example mouseover or focus\n      # events. Not supported with the Selenium driver, and SHOULDN'T BE USED IN TESTING unless you\n      # fully understand why you're using it, that it can allow actions a user could never\n      # perform, and that it may completely invalidate your test.\n      #\n      # @param [String] event       The name of the event to trigger\n      #\n      # @return [Capybara::Node::Element]  The element\n      def trigger(event)\n        synchronize { base.trigger(event) }\n        self\n      end\n\n      ##\n      #\n      # Drag the element to the given other element.\n      #\n      #     source = page.find('#foo')\n      #     target = page.find('#bar')\n      #     source.drag_to(target)\n      #\n      # @param [Capybara::Node::Element] node     The element to drag to\n      # @param [Hash] options  Driver specific options for dragging. May not be supported by all drivers.\n      # @option options [Numeric] :delay   (0.05) When using Chrome/Firefox with Selenium and HTML5 dragging this is the number\n      #                                    of seconds between each stage of the drag.\n      # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5\n      #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to\n      #                                    detect the correct method to use.\n      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.\n      #\n      #\n      # @return [Capybara::Node::Element]  The dragged element\n      def drag_to(node, **options)\n        synchronize { base.drag_to(node.base, **options) }\n        self\n      end\n\n      ##\n      #\n      # Drop items on the current element.\n      #\n      #     target = page.find('#foo')\n      #     target.drop('/some/path/file.csv')\n      #\n      # @overload drop(path, ...)\n      #   @param [String, #to_path] path Location of the file to drop on the element\n      #\n      # @overload drop(strings, ...)\n      #   @param [Hash] strings A hash of type to data to be dropped - `{ \"text/url\" => \"https://www.google.com\" }`\n      #\n      # @return [Capybara::Node::Element]  The element\n      def drop(*args)\n        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }\n        synchronize { base.drop(*options) }\n        self\n      end\n\n      ##\n      #\n      # Scroll the page or element.\n      #\n      # @overload scroll_to(position, offset: [0,0])\n      #   Scroll the page or element to its top, bottom or middle.\n      #   @param [:top, :bottom, :center, :current] position\n      #   @param [[Integer, Integer]] offset\n      #\n      # @overload scroll_to(element, align: :top)\n      #   Scroll the page or current element until the given element is aligned at the top, bottom, or center of it.\n      #   @param [Capybara::Node::Element] element   The element to be scrolled into view\n      #   @param [:top, :bottom, :center] align Where to align the element being scrolled into view with relation to the current page/element if possible\n      #\n      # @overload scroll_to(x,y)\n      #   @param [Integer] x    Horizontal scroll offset\n      #   @param [Integer] y    Vertical scroll offset\n      #\n      # @return [Capybara::Node::Element]  The element\n      def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)\n        case pos_or_el_or_x\n        when Symbol\n          synchronize { base.scroll_to(nil, pos_or_el_or_x) } unless pos_or_el_or_x == :current\n        when Capybara::Node::Element\n          synchronize { base.scroll_to(pos_or_el_or_x.base, align) }\n        else\n          synchronize { base.scroll_to(nil, nil, [pos_or_el_or_x, y]) }\n        end\n        synchronize { base.scroll_by(*offset) } unless offset.nil?\n        self\n      end\n\n      ##\n      #\n      # Return the shadow_root for the current element\n      #\n      # @return [Capybara::Node::Element]  The shadow root\n\n      def shadow_root\n        root = synchronize { base.shadow_root }\n        root && Capybara::Node::Element.new(session, root, nil, nil)\n      end\n\n      ##\n      #\n      # Execute the given JS in the context of the element not returning a result. This is useful for scripts that return\n      # complex objects, such as jQuery statements. {#execute_script} should be used over\n      # {#evaluate_script} whenever a result is not expected or needed. `this` in the script will refer to the element this is called on.\n      #\n      # @param [String] script   A string of JavaScript to execute\n      # @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 drivers\n      #\n      def execute_script(script, *args)\n        session.execute_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JS in the context of the element and return the result. Be careful when using this with\n      # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n      # be a better alternative. `this` in the script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_script(script, *args)\n        session.evaluate_script(<<~JS, self, *args)\n          (function(){\n            return #{script.strip}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JavaScript in the context of the element and obtain the result from a\n      # callback function which will be passed as the last argument to the script. `this` in the\n      # script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_async_script(script, *args)\n        session.evaluate_async_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Toggle the elements background color between white and black for a period of time.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def flash\n        execute_script(<<~JS, 100)\n          async function flash(el, delay){\n            var old_bg = el.style.backgroundColor;\n            var colors = [\"black\", \"white\"];\n            for(var i=0; i<20; i++){\n              el.style.backgroundColor = colors[i % colors.length];\n              await new Promise(resolve => setTimeout(resolve, delay));\n            }\n            el.style.backgroundColor = old_bg;\n          }\n          flash(this, arguments[0]);\n        JS\n\n        self\n      end\n\n      # @api private\n      def reload\n        return self unless @allow_reload\n\n        begin\n          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]\n          @base = reloaded.base if reloaded\n        rescue StandardError => e\n          raise e unless catch_error?(e)\n        end\n        self\n      end\n\n      ##\n      #\n      # A human-readable representation of the element.\n      #\n      # @return [String]  A string representation\n      def inspect\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\" path=\"#{base.path}\">)\n      rescue NotSupportedByDriverError\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\">)\n      rescue *session.driver.invalid_element_errors\n        %(Obsolete #<Capybara::Node::Element>)\n      end\n\n      # @api private\n      def initial_cache\n        base.respond_to?(:initial_cache) ? base.initial_cache : {}\n      end\n\n      STYLE_SCRIPT = <<~JS\n        (function(){\n          var s = window.getComputedStyle(this);\n          var result = {};\n          for (var i = arguments.length; i--; ) {\n            var property_name = arguments[i];\n            result[property_name] = s.getPropertyValue(property_name);\n          }\n          return result;\n        }).apply(this, arguments)\n      JS\n\n    private\n\n      def perform_click_action(keys, wait: nil, **options)\n        raise ArgumentError, 'You must specify both x: and y: for a click offset' if nil ^ options[:x] ^ options[:y]\n\n        options[:offset] ||= :center if session_options.w3c_click_offset\n        synchronize(wait) { yield keys, options }\n        self\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "flash", "signature": "def flash execute_script(<<~JS, 100)", "start_line": 542, "end_line": 557}, "metadata": {"module": "Capybara", "class_name": "Element", "class_signature": "class Element < < Base"}, "task_id": 28}
{"function_name": "reload", "file_path": "capybara/lib/capybara/node/element.rb", "focal_code": "def reload\n        return self unless @allow_reload\n\n        begin\n          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]\n          @base = reloaded.base if reloaded\n        rescue StandardError => e\n          raise e unless catch_error?(e)\n        end\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Element} represents a single element on the page. It is possible\n    # to interact with the contents of this element the same as with a document:\n    #\n    #     session = Capybara::Session.new(:rack_test, my_app)\n    #\n    #     bar = session.find('#bar')              # from Capybara::Node::Finders\n    #     bar.select('Baz', from: 'Quox')      # from Capybara::Node::Actions\n    #\n    # {Capybara::Node::Element} also has access to HTML attributes and other properties of the\n    # element:\n    #\n    #      bar.value\n    #      bar.text\n    #      bar[:title]\n    #\n    # @see Capybara::Node\n    #\n    class Element < Base\n      def initialize(session, base, query_scope, query)\n        super(session, base)\n        @query_scope = query_scope\n        @query = query\n        @allow_reload = false\n        @query_idx = nil\n      end\n\n      def allow_reload!(idx = nil)\n        @query_idx = idx\n        @allow_reload = true\n      end\n\n      ##\n      #\n      # @return [Object]    The native element from the driver, this allows access to driver specific methods\n      #\n      def native\n        synchronize { base.native }\n      end\n\n      ##\n      #\n      # Retrieve the text of the element. If {Capybara.configure ignore_hidden_elements}\n      # is `true`, which it is by default, then this will return only text\n      # which is visible. The exact semantics of this may differ between\n      # drivers, but generally any text within elements with `display:none` is\n      # ignored. This behaviour can be overridden by passing `:all` to this\n      # method.\n      #\n      # @param type [:all, :visible]  Whether to return only visible or all text\n      # @return [String]              The text of the element\n      #\n      def text(type = nil, normalize_ws: false)\n        type ||= :all unless session_options.ignore_hidden_elements || session_options.visible_text_only\n        txt = synchronize { type == :all ? base.all_text : base.visible_text }\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute.\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] attribute     The attribute to retrieve\n      # @return [String]               The value of the attribute\n      #\n      def [](attribute)\n        synchronize { base[attribute] }\n      end\n\n      ##\n      #\n      # Retrieve the given CSS styles.\n      #\n      #     element.style('color', 'font-size') # => Computed values of CSS 'color' and 'font-size' styles\n      #\n      # @param [Array<String>] styles   Names of the desired CSS properties\n      # @return [Hash]            Hash of the CSS property names to computed values\n      #\n      def style(*styles)\n        styles = styles.flatten.map(&:to_s)\n        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?\n\n        begin\n          synchronize { base.style(styles) }\n        rescue NotImplementedError => e\n          begin\n            evaluate_script(STYLE_SCRIPT, *styles)\n          rescue Capybara::NotSupportedByDriverError\n            raise e\n          end\n        end\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        synchronize { base.value }\n      end\n\n      ##\n      #\n      # Set the value of the form element to the given value.\n      #\n      # @param [String] value    The new value\n      # @param [Hash] options    Driver specific options for how to set the value. Take default values from {Capybara.configure default_set_options}.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def set(value, **options)\n        if ENV.fetch('CAPYBARA_THOROUGH', nil) && readonly?\n          raise Capybara::ReadOnlyElementError, \"Attempt to set readonly element with value: #{value}\"\n        end\n\n        options = session_options.default_set_options.to_h.merge(options)\n        synchronize { base.set(value, **options) }\n        self\n      end\n\n      ##\n      #\n      # Select this node if it is an option element inside a select tag.\n      #\n      # @!macro action_waiting_behavior\n      #   If the driver dynamic pages (JS) and the element is currently non-interactable, this method will\n      #   continuously retry the action until either the element becomes interactable or the maximum\n      #   wait time expires.\n      #\n      #   @param [false, Numeric] wait\n      #     Maximum time to wait for the action to succeed. Defaults to {Capybara.configure default_max_wait_time}.\n      # @return [Capybara::Node::Element]  The element\n      def select_option(wait: nil)\n        synchronize(wait) { base.select_option }\n        self\n      end\n\n      ##\n      #\n      # Unselect this node if it is an option element inside a multiple select tag.\n      #\n      # @macro action_waiting_behavior\n      # @return [Capybara::Node::Element]  The element\n      def unselect_option(wait: nil)\n        synchronize(wait) { base.unselect_option }\n        self\n      end\n\n      ##\n      #\n      # Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @!macro click_modifiers\n      #   Both x: and y: must be specified if an offset is wanted, if not specified the click will occur at the middle of the element.\n      #   @overload $0(*modifier_keys, wait: nil, **offset)\n      #     @param *modifier_keys [:alt, :control, :meta, :shift] ([]) Keys to be held down when clicking\n      #     @option options [Integer] x  X coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      #     @option options [Integer] y  Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the\n      #       offset will be from the element center, otherwise it will be from the top left corner of the element\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Right Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)\n      # @return [Capybara::Node::Element]  The element\n      def right_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.right_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Double Click the Element.\n      #\n      # @macro action_waiting_behavior\n      # @macro click_modifiers\n      # @return [Capybara::Node::Element]  The element\n      def double_click(*keys, **options)\n        perform_click_action(keys, **options) do |k, opts|\n          base.double_click(k, **opts)\n        end\n      end\n\n      ##\n      #\n      # Send Keystrokes to the Element.\n      #\n      # @overload send_keys(keys, ...)\n      #   @param keys [String, Symbol, Array<String,Symbol>]\n      #\n      # Examples:\n      #\n      #     element.send_keys \"foo\"                     #=> value: 'foo'\n      #     element.send_keys \"tet\", :left, \"s\"         #=> value: 'test'\n      #     element.send_keys [:control, 'a'], :space   #=> value: ' ' - assuming ctrl-a selects all contents\n      #\n      # Symbols supported for keys:\n      # * :cancel\n      # * :help\n      # * :backspace\n      # * :tab\n      # * :clear\n      # * :return\n      # * :enter\n      # * :shift\n      # * :control\n      # * :alt\n      # * :pause\n      # * :escape\n      # * :space\n      # * :page_up\n      # * :page_down\n      # * :end\n      # * :home\n      # * :left\n      # * :up\n      # * :right\n      # * :down\n      # * :insert\n      # * :delete\n      # * :semicolon\n      # * :equals\n      # * :numpad0\n      # * :numpad1\n      # * :numpad2\n      # * :numpad3\n      # * :numpad4\n      # * :numpad5\n      # * :numpad6\n      # * :numpad7\n      # * :numpad8\n      # * :numpad9\n      # * :multiply      - numeric keypad *\n      # * :add           - numeric keypad +\n      # * :separator     - numeric keypad 'separator' key ??\n      # * :subtract      - numeric keypad -\n      # * :decimal       - numeric keypad .\n      # * :divide        - numeric keypad /\n      # * :f1\n      # * :f2\n      # * :f3\n      # * :f4\n      # * :f5\n      # * :f6\n      # * :f7\n      # * :f8\n      # * :f9\n      # * :f10\n      # * :f11\n      # * :f12\n      # * :meta\n      # * :command      - alias of :meta\n      #\n      # @return [Capybara::Node::Element]  The element\n      def send_keys(*args)\n        synchronize { base.send_keys(*args) }\n        self\n      end\n\n      ##\n      #\n      # Hover on the Element.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def hover\n        synchronize { base.hover }\n        self\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        # Element type is immutable so cache it\n        @tag_name ||= initial_cache[:tag_name] || synchronize { base.tag_name }\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Not all drivers support CSS, so\n      # the result may be inaccurate.\n      #\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?\n        synchronize { base.visible? }\n      end\n\n      ##\n      #\n      # Whether or not the element is currently in the viewport and it (or descendants)\n      # would be considered clickable at the elements center point.\n      #\n      # @return [Boolean]     Whether the elements center is obscured.\n      #\n      def obscured?\n        synchronize { base.obscured? }\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        synchronize { base.checked? }\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        synchronize { base.selected? }\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      #\n      def disabled?\n        synchronize { base.disabled? }\n      end\n\n      ##\n      #\n      # Whether or not the element is readonly.\n      #\n      # @return [Boolean]     Whether the element is readonly\n      #\n      def readonly?\n        synchronize { base.readonly? }\n      end\n\n      ##\n      #\n      # Whether or not the element supports multiple results.\n      #\n      # @return [Boolean]     Whether the element supports multiple results.\n      #\n      def multiple?\n        synchronize { base.multiple? }\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found.\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        synchronize { base.path }\n      end\n\n      def rect\n        synchronize { base.rect }\n      end\n\n      ##\n      #\n      # Trigger any event on the current element, for example mouseover or focus\n      # events. Not supported with the Selenium driver, and SHOULDN'T BE USED IN TESTING unless you\n      # fully understand why you're using it, that it can allow actions a user could never\n      # perform, and that it may completely invalidate your test.\n      #\n      # @param [String] event       The name of the event to trigger\n      #\n      # @return [Capybara::Node::Element]  The element\n      def trigger(event)\n        synchronize { base.trigger(event) }\n        self\n      end\n\n      ##\n      #\n      # Drag the element to the given other element.\n      #\n      #     source = page.find('#foo')\n      #     target = page.find('#bar')\n      #     source.drag_to(target)\n      #\n      # @param [Capybara::Node::Element] node     The element to drag to\n      # @param [Hash] options  Driver specific options for dragging. May not be supported by all drivers.\n      # @option options [Numeric] :delay   (0.05) When using Chrome/Firefox with Selenium and HTML5 dragging this is the number\n      #                                    of seconds between each stage of the drag.\n      # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5\n      #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to\n      #                                    detect the correct method to use.\n      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.\n      #\n      #\n      # @return [Capybara::Node::Element]  The dragged element\n      def drag_to(node, **options)\n        synchronize { base.drag_to(node.base, **options) }\n        self\n      end\n\n      ##\n      #\n      # Drop items on the current element.\n      #\n      #     target = page.find('#foo')\n      #     target.drop('/some/path/file.csv')\n      #\n      # @overload drop(path, ...)\n      #   @param [String, #to_path] path Location of the file to drop on the element\n      #\n      # @overload drop(strings, ...)\n      #   @param [Hash] strings A hash of type to data to be dropped - `{ \"text/url\" => \"https://www.google.com\" }`\n      #\n      # @return [Capybara::Node::Element]  The element\n      def drop(*args)\n        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }\n        synchronize { base.drop(*options) }\n        self\n      end\n\n      ##\n      #\n      # Scroll the page or element.\n      #\n      # @overload scroll_to(position, offset: [0,0])\n      #   Scroll the page or element to its top, bottom or middle.\n      #   @param [:top, :bottom, :center, :current] position\n      #   @param [[Integer, Integer]] offset\n      #\n      # @overload scroll_to(element, align: :top)\n      #   Scroll the page or current element until the given element is aligned at the top, bottom, or center of it.\n      #   @param [Capybara::Node::Element] element   The element to be scrolled into view\n      #   @param [:top, :bottom, :center] align Where to align the element being scrolled into view with relation to the current page/element if possible\n      #\n      # @overload scroll_to(x,y)\n      #   @param [Integer] x    Horizontal scroll offset\n      #   @param [Integer] y    Vertical scroll offset\n      #\n      # @return [Capybara::Node::Element]  The element\n      def scroll_to(pos_or_el_or_x, y = nil, align: :top, offset: nil)\n        case pos_or_el_or_x\n        when Symbol\n          synchronize { base.scroll_to(nil, pos_or_el_or_x) } unless pos_or_el_or_x == :current\n        when Capybara::Node::Element\n          synchronize { base.scroll_to(pos_or_el_or_x.base, align) }\n        else\n          synchronize { base.scroll_to(nil, nil, [pos_or_el_or_x, y]) }\n        end\n        synchronize { base.scroll_by(*offset) } unless offset.nil?\n        self\n      end\n\n      ##\n      #\n      # Return the shadow_root for the current element\n      #\n      # @return [Capybara::Node::Element]  The shadow root\n\n      def shadow_root\n        root = synchronize { base.shadow_root }\n        root && Capybara::Node::Element.new(session, root, nil, nil)\n      end\n\n      ##\n      #\n      # Execute the given JS in the context of the element not returning a result. This is useful for scripts that return\n      # complex objects, such as jQuery statements. {#execute_script} should be used over\n      # {#evaluate_script} whenever a result is not expected or needed. `this` in the script will refer to the element this is called on.\n      #\n      # @param [String] script   A string of JavaScript to execute\n      # @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 drivers\n      #\n      def execute_script(script, *args)\n        session.execute_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JS in the context of the element and return the result. Be careful when using this with\n      # scripts that return complex objects, such as jQuery statements. {#execute_script} might\n      # be a better alternative. `this` in the script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_script(script, *args)\n        session.evaluate_script(<<~JS, self, *args)\n          (function(){\n            return #{script.strip}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Evaluate the given JavaScript in the context of the element and obtain the result from a\n      # callback function which will be passed as the last argument to the script. `this` in the\n      # script will refer to the element this is called on.\n      #\n      # @param  [String] script   A string of JavaScript to evaluate\n      # @return [Object]          The result of the evaluated JavaScript (may be driver specific)\n      #\n      def evaluate_async_script(script, *args)\n        session.evaluate_async_script(<<~JS, self, *args)\n          (function (){\n            #{script}\n          }).apply(arguments[0], Array.prototype.slice.call(arguments,1));\n        JS\n      end\n\n      ##\n      #\n      # Toggle the elements background color between white and black for a period of time.\n      #\n      # @return [Capybara::Node::Element]  The element\n      def flash\n        execute_script(<<~JS, 100)\n          async function flash(el, delay){\n            var old_bg = el.style.backgroundColor;\n            var colors = [\"black\", \"white\"];\n            for(var i=0; i<20; i++){\n              el.style.backgroundColor = colors[i % colors.length];\n              await new Promise(resolve => setTimeout(resolve, delay));\n            }\n            el.style.backgroundColor = old_bg;\n          }\n          flash(this, arguments[0]);\n        JS\n\n        self\n      end\n\n      # @api private\n      def reload\n        return self unless @allow_reload\n\n        begin\n          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]\n          @base = reloaded.base if reloaded\n        rescue StandardError => e\n          raise e unless catch_error?(e)\n        end\n        self\n      end\n\n      ##\n      #\n      # A human-readable representation of the element.\n      #\n      # @return [String]  A string representation\n      def inspect\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\" path=\"#{base.path}\">)\n      rescue NotSupportedByDriverError\n        %(#<Capybara::Node::Element tag=\"#{base.tag_name}\">)\n      rescue *session.driver.invalid_element_errors\n        %(Obsolete #<Capybara::Node::Element>)\n      end\n\n      # @api private\n      def initial_cache\n        base.respond_to?(:initial_cache) ? base.initial_cache : {}\n      end\n\n      STYLE_SCRIPT = <<~JS\n        (function(){\n          var s = window.getComputedStyle(this);\n          var result = {};\n          for (var i = arguments.length; i--; ) {\n            var property_name = arguments[i];\n            result[property_name] = s.getPropertyValue(property_name);\n          }\n          return result;\n        }).apply(this, arguments)\n      JS\n\n    private\n\n      def perform_click_action(keys, wait: nil, **options)\n        raise ArgumentError, 'You must specify both x: and y: for a click offset' if nil ^ options[:x] ^ options[:y]\n\n        options[:offset] ||= :center if session_options.w3c_click_offset\n        synchronize(wait) { yield keys, options }\n        self\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "reload", "signature": "def reload return self unless @allow_reload", "start_line": 560, "end_line": 570}, "metadata": {"module": "Capybara", "class_name": "Element", "class_signature": "class Element < < Base"}, "task_id": 29}
{"function_name": "find", "file_path": "capybara/lib/capybara/node/finders.rb", "focal_code": "def find(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        count_options = options.slice(*Capybara::Queries::BaseQuery::COUNT_KEYS)\n        unless count_options.empty?\n          Capybara::Helpers.warn(\n            \"'find' does not support count options (#{count_options}) ignoring. \" \\\n            \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n          )\n        end\n        synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Finders\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments. {#find} will raise an error if the element\n      # is not found.\n      #\n      #     page.find('#foo').find('.bar')\n      #     page.find(:xpath, './/div[contains(., \"bar\")]')\n      #     page.find('li', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #all)\n      #\n      # @macro waiting_behavior\n      #\n      # @!macro system_filters\n      #   @option options [String, Regexp] text      Only find elements which contain this text or match this regexp\n      #   @option options [String, Regexp, String] exact_text\n      #     When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.\n      #     Defaults to {Capybara.configure exact_text}.\n      #   @option options [Boolean] normalize_ws\n      #     Whether the `text`/`exact_text` options are compared against element text with whitespace normalized or as returned by the driver.\n      #     Defaults to {Capybara.configure default_normalize_ws}.\n      #   @option options [Boolean, Symbol] visible\n      #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.\n      #       * true - only finds visible elements.\n      #       * false - finds invisible _and_ visible elements.\n      #       * :all - same as false; finds visible and invisible elements.\n      #       * :hidden - only finds invisible elements.\n      #       * :visible - same as true; only finds visible elements.\n      #   @option options [Boolean] obscured  Only find elements with the specified obscured state:\n      #                                       * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.\n      #                                       * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.\n      #   @option options [String, Regexp]  id           Only find elements with an id that matches the value passed\n      #   @option options [String, Array<String>, Regexp] class  Only find elements with matching class/classes.\n      #                                            * Absence of a class can be checked by prefixing the class name with `!`\n      #                                            * If you need to check for existence of a class name that starts with `!` then prefix with `!!`\n      #\n      #                                                class:['a', '!b', '!!!c'] # limit to elements with class 'a' and '!c' but not class 'b'\n      #\n      #   @option options [String, Regexp, Hash] style  Only find elements with matching style. String and Regexp will be checked against text of the elements `style` attribute, while a Hash will be compared against the elements full style\n      #   @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially. Defaults to {Capybara.configure exact}.\n      #   @option options [Symbol] match        The matching strategy to use. Defaults to {Capybara.configure match}.\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def find(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        count_options = options.slice(*Capybara::Queries::BaseQuery::COUNT_KEYS)\n        unless count_options.empty?\n          Capybara::Helpers.warn(\n            \"'find' does not support count options (#{count_options}) ignoring. \" \\\n            \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n          )\n        end\n        synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on.\n      # {#ancestor} will raise an error if the element is not found.\n      #\n      # {#ancestor} takes the same options as {#find}.\n      #\n      #     element.ancestor('#foo').find('.bar')\n      #     element.ancestor(:xpath, './/div[contains(., \"bar\")]')\n      #     element.ancestor('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def ancestor(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on.\n      # {#sibling} will raise an error if the element is not found.\n      #\n      # {#sibling} takes the same options as {#find}.\n      #\n      #     element.sibling('#foo').find('.bar')\n      #     element.sibling(:xpath, './/div[contains(., \"bar\")]')\n      #     element.sibling('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def sibling(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a form field on the page. The field can be found by its name, id or label text.\n      #\n      # @overload find_field([locator], **options)\n      #   @param [String] locator             name, id, {Capybara.configure test_id} attribute, placeholder or text of associated label element\n      #\n      #   @macro waiting_behavior\n      #\n      #\n      #   @option options [Boolean] checked       Match checked field?\n      #   @option options [Boolean] unchecked     Match unchecked field?\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled field?\n      #                                                       * true - only finds a disabled field\n      #                                                       * false - only finds an enabled field\n      #                                                       * :all - finds either an enabled or disabled field\n      #   @option options [Boolean] readonly      Match readonly field?\n      #   @option options [String, Regexp] with   Value of field to match on\n      #   @option options [String] type           Type of field to match on\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id     Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_field(locator = nil, **options, &optional_filter_block)\n        find(:field, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a link on the page. The link can be found by its id or text.\n      #\n      # @overload find_link([locator], **options)\n      #   @param [String] locator            id, {Capybara.configure test_id} attribute, title, text, or alt of enclosed img element\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [String,Regexp,nil] href    Value to match against the links href, if `nil` finds link placeholders (`<a>` elements with no href attribute), if `false` ignores the href\n      #   @option options [String, Regexp] id         Match links with the id provided\n      #   @option options [String] title              Match links with the title provided\n      #   @option options [String] alt                Match links with a contained img element whose alt matches\n      #   @option options [String, Boolean] download  Match links with the download provided\n      #   @option options [String] target             Match links with the target provided\n      #   @option options [String, Array<String>, Regexp] class    Match links that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_link(locator = nil, **options, &optional_filter_block)\n        find(:link, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a button on the page.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title.\n      # `<button>` elements can also be found by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload find_button([locator], **options)\n      #   @param [String] locator            id, name, {Capybara.configure test_id} attribute, value, title, text content, alt of image\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled button?\n      #                                                       * true - only finds a disabled button\n      #                                                       * false - only finds an enabled button\n      #                                                       * :all - finds either an enabled or disabled button\n      #   @option options [String, Regexp] id                 Match buttons with the id provided\n      #   @option options [String] name                       Match buttons with the name provided\n      #   @option options [String] title                      Match buttons with the title provided\n      #   @option options [String] value                      Match buttons with the value provided\n      #   @option options [String, Array<String>, Regexp] class    Match buttons that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_button(locator = nil, **options, &optional_filter_block)\n        find(:button, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a element on the page, given its id.\n      #\n      # @macro waiting_behavior\n      #\n      # @param [String] id                  id of element\n      #\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_by_id(id, **options, &optional_filter_block)\n        find(:id, id, **options, &optional_filter_block)\n      end\n\n      ##\n      # @!method all([kind = Capybara.default_selector], locator = nil, **options)\n      #\n      # Find all elements on the page matching the given selector\n      # and options.\n      #\n      # Both XPath and CSS expressions are supported, but Capybara\n      # does not try to automatically distinguish between them. The\n      # following statements are equivalent:\n      #\n      #     page.all(:css, 'a#person_123')\n      #     page.all(:xpath, './/a[@id=\"person_123\"]')\n      #\n      # If the type of selector is left out, Capybara uses\n      # {Capybara.configure default_selector}. It's set to `:css` by default.\n      #\n      #     page.all(\"a#person_123\")\n      #\n      #     Capybara.default_selector = :xpath\n      #     page.all('.//a[@id=\"person_123\"]')\n      #\n      # The set of found elements can further be restricted by specifying\n      # options. It's possible to select elements by their text or visibility:\n      #\n      #     page.all('a', text: 'Home')\n      #     page.all('#menu li', visible: true)\n      #\n      # By default Capybara's waiting behavior will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to be available and then return an empty result if none\n      # are available. It is possible to set expectations on the number of results located and\n      # Capybara will raise an exception if the number of elements located don't satisfy the\n      # specified conditions. The expectations can be set using:\n      #\n      #     page.assert_selector('p#foo', count: 4)\n      #     page.assert_selector('p#foo', maximum: 10)\n      #     page.assert_selector('p#foo', minimum: 1)\n      #     page.assert_selector('p#foo', between: 1..10)\n      #\n      # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.). Defaults to {Capybara.configure default_selector}.\n      # @param [String] locator                    The locator for the specified selector\n      # @macro system_filters\n      # @macro waiting_behavior\n      # @option options [Integer] count            Exact number of matches that are expected to be found\n      # @option options [Integer] maximum          Maximum number of matches that are expected to be found\n      # @option options [Integer] minimum          Minimum number of matches that are expected to be found\n      # @option options [Range]   between          Number of matches found must be within the given range\n      # @option options [Boolean] allow_reload     Beta feature - May be removed in any version.\n      #   When `true` allows elements to be reloaded if they become stale. This is an advanced behavior and should only be used\n      #   if you fully understand the potential ramifications. The results can be confusing on dynamic pages. Defaults to `false`\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options)\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)\n      #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results\n      #   @yieldreturn [Boolean]                     Should the element be considered in the results?\n      # @return [Capybara::Result]                   A collection of found elements\n      # @raise [Capybara::ExpectationNotMet]         The number of elements found doesn't match the specified conditions\n      def all(*args, allow_reload: false, **options, &optional_filter_block)\n        minimum_specified = options_include_minimum?(options)\n        options = { minimum: 1 }.merge(options) unless minimum_specified\n        options[:session_options] = session_options\n        query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n        result = nil\n        begin\n          synchronize(query.wait) do\n            result = query.resolve_for(self)\n            result.allow_reload! if allow_reload\n            raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?\n\n            result\n          end\n        rescue Capybara::ExpectationNotMet\n          raise if minimum_specified || (result.compare_count == 1)\n\n          Result.new([], nil)\n        end\n      end\n      alias_method :find_all, :all\n\n      ##\n      #\n      # Find the first element on the page matching the given selector\n      # and options. By default {#first} will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to appear and then raise an error if no matching\n      # element is found, or `nil` if the provided count options allow for empty results.\n      #\n      # @overload first([kind], locator, options)\n      #   @param [Symbol] kind                       The type of selector\n      #   @param [String] locator                    The selector\n      #   @param [Hash] options                      Additional options; see {#all}\n      # @return [Capybara::Node::Element]            The found element or nil\n      # @raise  [Capybara::ElementNotFound]          If element(s) matching the provided options can't be found before time expires\n      #\n      def first(*args, **options, &optional_filter_block)\n        options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)\n        all(*args, **options, &optional_filter_block).first\n      end\n\n    private\n\n      def synced_resolve(query)\n        synchronize(query.wait) do\n          if prefer_exact?(query)\n            result = query.resolve_for(self, true)\n            result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?\n          else\n            result = query.resolve_for(self)\n          end\n\n          if ambiguous?(query, result)\n            raise Capybara::Ambiguous, \"Ambiguous match, found #{result.size} elements matching #{query.applied_description}\"\n          end\n          raise Capybara::ElementNotFound, \"Unable to find #{query.applied_description}\" if result.empty?\n\n          result.first\n        end.tap(&:allow_reload!)\n      end\n\n      def ambiguous?(query, result)\n        %i[one smart].include?(query.match) && (result.size > 1)\n      end\n\n      def prefer_exact?(query)\n        %i[smart prefer_exact].include?(query.match)\n      end\n\n      def options_include_minimum?(opts)\n        %i[count minimum between].any? { |key| opts.key?(key) }\n      end\n\n      def parent\n        first(:xpath, './parent::*', minimum: 0)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find", "signature": "def find(*args, **options, &optional_filter_block)", "start_line": 51, "end_line": 61}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 30}
{"function_name": "all", "file_path": "capybara/lib/capybara/node/finders.rb", "focal_code": "def all(*args, allow_reload: false, **options, &optional_filter_block)\n        minimum_specified = options_include_minimum?(options)\n        options = { minimum: 1 }.merge(options) unless minimum_specified\n        options[:session_options] = session_options\n        query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n        result = nil\n        begin\n          synchronize(query.wait) do\n            result = query.resolve_for(self)\n            result.allow_reload! if allow_reload\n            raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?\n\n            result\n          end\n        rescue Capybara::ExpectationNotMet\n          raise if minimum_specified || (result.compare_count == 1)\n\n          Result.new([], nil)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Finders\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments. {#find} will raise an error if the element\n      # is not found.\n      #\n      #     page.find('#foo').find('.bar')\n      #     page.find(:xpath, './/div[contains(., \"bar\")]')\n      #     page.find('li', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #all)\n      #\n      # @macro waiting_behavior\n      #\n      # @!macro system_filters\n      #   @option options [String, Regexp] text      Only find elements which contain this text or match this regexp\n      #   @option options [String, Regexp, String] exact_text\n      #     When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.\n      #     Defaults to {Capybara.configure exact_text}.\n      #   @option options [Boolean] normalize_ws\n      #     Whether the `text`/`exact_text` options are compared against element text with whitespace normalized or as returned by the driver.\n      #     Defaults to {Capybara.configure default_normalize_ws}.\n      #   @option options [Boolean, Symbol] visible\n      #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.\n      #       * true - only finds visible elements.\n      #       * false - finds invisible _and_ visible elements.\n      #       * :all - same as false; finds visible and invisible elements.\n      #       * :hidden - only finds invisible elements.\n      #       * :visible - same as true; only finds visible elements.\n      #   @option options [Boolean] obscured  Only find elements with the specified obscured state:\n      #                                       * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.\n      #                                       * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.\n      #   @option options [String, Regexp]  id           Only find elements with an id that matches the value passed\n      #   @option options [String, Array<String>, Regexp] class  Only find elements with matching class/classes.\n      #                                            * Absence of a class can be checked by prefixing the class name with `!`\n      #                                            * If you need to check for existence of a class name that starts with `!` then prefix with `!!`\n      #\n      #                                                class:['a', '!b', '!!!c'] # limit to elements with class 'a' and '!c' but not class 'b'\n      #\n      #   @option options [String, Regexp, Hash] style  Only find elements with matching style. String and Regexp will be checked against text of the elements `style` attribute, while a Hash will be compared against the elements full style\n      #   @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially. Defaults to {Capybara.configure exact}.\n      #   @option options [Symbol] match        The matching strategy to use. Defaults to {Capybara.configure match}.\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def find(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        count_options = options.slice(*Capybara::Queries::BaseQuery::COUNT_KEYS)\n        unless count_options.empty?\n          Capybara::Helpers.warn(\n            \"'find' does not support count options (#{count_options}) ignoring. \" \\\n            \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n          )\n        end\n        synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on.\n      # {#ancestor} will raise an error if the element is not found.\n      #\n      # {#ancestor} takes the same options as {#find}.\n      #\n      #     element.ancestor('#foo').find('.bar')\n      #     element.ancestor(:xpath, './/div[contains(., \"bar\")]')\n      #     element.ancestor('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def ancestor(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on.\n      # {#sibling} will raise an error if the element is not found.\n      #\n      # {#sibling} takes the same options as {#find}.\n      #\n      #     element.sibling('#foo').find('.bar')\n      #     element.sibling(:xpath, './/div[contains(., \"bar\")]')\n      #     element.sibling('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def sibling(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a form field on the page. The field can be found by its name, id or label text.\n      #\n      # @overload find_field([locator], **options)\n      #   @param [String] locator             name, id, {Capybara.configure test_id} attribute, placeholder or text of associated label element\n      #\n      #   @macro waiting_behavior\n      #\n      #\n      #   @option options [Boolean] checked       Match checked field?\n      #   @option options [Boolean] unchecked     Match unchecked field?\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled field?\n      #                                                       * true - only finds a disabled field\n      #                                                       * false - only finds an enabled field\n      #                                                       * :all - finds either an enabled or disabled field\n      #   @option options [Boolean] readonly      Match readonly field?\n      #   @option options [String, Regexp] with   Value of field to match on\n      #   @option options [String] type           Type of field to match on\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id     Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_field(locator = nil, **options, &optional_filter_block)\n        find(:field, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a link on the page. The link can be found by its id or text.\n      #\n      # @overload find_link([locator], **options)\n      #   @param [String] locator            id, {Capybara.configure test_id} attribute, title, text, or alt of enclosed img element\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [String,Regexp,nil] href    Value to match against the links href, if `nil` finds link placeholders (`<a>` elements with no href attribute), if `false` ignores the href\n      #   @option options [String, Regexp] id         Match links with the id provided\n      #   @option options [String] title              Match links with the title provided\n      #   @option options [String] alt                Match links with a contained img element whose alt matches\n      #   @option options [String, Boolean] download  Match links with the download provided\n      #   @option options [String] target             Match links with the target provided\n      #   @option options [String, Array<String>, Regexp] class    Match links that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_link(locator = nil, **options, &optional_filter_block)\n        find(:link, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a button on the page.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title.\n      # `<button>` elements can also be found by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload find_button([locator], **options)\n      #   @param [String] locator            id, name, {Capybara.configure test_id} attribute, value, title, text content, alt of image\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled button?\n      #                                                       * true - only finds a disabled button\n      #                                                       * false - only finds an enabled button\n      #                                                       * :all - finds either an enabled or disabled button\n      #   @option options [String, Regexp] id                 Match buttons with the id provided\n      #   @option options [String] name                       Match buttons with the name provided\n      #   @option options [String] title                      Match buttons with the title provided\n      #   @option options [String] value                      Match buttons with the value provided\n      #   @option options [String, Array<String>, Regexp] class    Match buttons that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_button(locator = nil, **options, &optional_filter_block)\n        find(:button, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a element on the page, given its id.\n      #\n      # @macro waiting_behavior\n      #\n      # @param [String] id                  id of element\n      #\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_by_id(id, **options, &optional_filter_block)\n        find(:id, id, **options, &optional_filter_block)\n      end\n\n      ##\n      # @!method all([kind = Capybara.default_selector], locator = nil, **options)\n      #\n      # Find all elements on the page matching the given selector\n      # and options.\n      #\n      # Both XPath and CSS expressions are supported, but Capybara\n      # does not try to automatically distinguish between them. The\n      # following statements are equivalent:\n      #\n      #     page.all(:css, 'a#person_123')\n      #     page.all(:xpath, './/a[@id=\"person_123\"]')\n      #\n      # If the type of selector is left out, Capybara uses\n      # {Capybara.configure default_selector}. It's set to `:css` by default.\n      #\n      #     page.all(\"a#person_123\")\n      #\n      #     Capybara.default_selector = :xpath\n      #     page.all('.//a[@id=\"person_123\"]')\n      #\n      # The set of found elements can further be restricted by specifying\n      # options. It's possible to select elements by their text or visibility:\n      #\n      #     page.all('a', text: 'Home')\n      #     page.all('#menu li', visible: true)\n      #\n      # By default Capybara's waiting behavior will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to be available and then return an empty result if none\n      # are available. It is possible to set expectations on the number of results located and\n      # Capybara will raise an exception if the number of elements located don't satisfy the\n      # specified conditions. The expectations can be set using:\n      #\n      #     page.assert_selector('p#foo', count: 4)\n      #     page.assert_selector('p#foo', maximum: 10)\n      #     page.assert_selector('p#foo', minimum: 1)\n      #     page.assert_selector('p#foo', between: 1..10)\n      #\n      # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.). Defaults to {Capybara.configure default_selector}.\n      # @param [String] locator                    The locator for the specified selector\n      # @macro system_filters\n      # @macro waiting_behavior\n      # @option options [Integer] count            Exact number of matches that are expected to be found\n      # @option options [Integer] maximum          Maximum number of matches that are expected to be found\n      # @option options [Integer] minimum          Minimum number of matches that are expected to be found\n      # @option options [Range]   between          Number of matches found must be within the given range\n      # @option options [Boolean] allow_reload     Beta feature - May be removed in any version.\n      #   When `true` allows elements to be reloaded if they become stale. This is an advanced behavior and should only be used\n      #   if you fully understand the potential ramifications. The results can be confusing on dynamic pages. Defaults to `false`\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options)\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)\n      #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results\n      #   @yieldreturn [Boolean]                     Should the element be considered in the results?\n      # @return [Capybara::Result]                   A collection of found elements\n      # @raise [Capybara::ExpectationNotMet]         The number of elements found doesn't match the specified conditions\n      def all(*args, allow_reload: false, **options, &optional_filter_block)\n        minimum_specified = options_include_minimum?(options)\n        options = { minimum: 1 }.merge(options) unless minimum_specified\n        options[:session_options] = session_options\n        query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n        result = nil\n        begin\n          synchronize(query.wait) do\n            result = query.resolve_for(self)\n            result.allow_reload! if allow_reload\n            raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?\n\n            result\n          end\n        rescue Capybara::ExpectationNotMet\n          raise if minimum_specified || (result.compare_count == 1)\n\n          Result.new([], nil)\n        end\n      end\n      alias_method :find_all, :all\n\n      ##\n      #\n      # Find the first element on the page matching the given selector\n      # and options. By default {#first} will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to appear and then raise an error if no matching\n      # element is found, or `nil` if the provided count options allow for empty results.\n      #\n      # @overload first([kind], locator, options)\n      #   @param [Symbol] kind                       The type of selector\n      #   @param [String] locator                    The selector\n      #   @param [Hash] options                      Additional options; see {#all}\n      # @return [Capybara::Node::Element]            The found element or nil\n      # @raise  [Capybara::ElementNotFound]          If element(s) matching the provided options can't be found before time expires\n      #\n      def first(*args, **options, &optional_filter_block)\n        options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)\n        all(*args, **options, &optional_filter_block).first\n      end\n\n    private\n\n      def synced_resolve(query)\n        synchronize(query.wait) do\n          if prefer_exact?(query)\n            result = query.resolve_for(self, true)\n            result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?\n          else\n            result = query.resolve_for(self)\n          end\n\n          if ambiguous?(query, result)\n            raise Capybara::Ambiguous, \"Ambiguous match, found #{result.size} elements matching #{query.applied_description}\"\n          end\n          raise Capybara::ElementNotFound, \"Unable to find #{query.applied_description}\" if result.empty?\n\n          result.first\n        end.tap(&:allow_reload!)\n      end\n\n      def ambiguous?(query, result)\n        %i[one smart].include?(query.match) && (result.size > 1)\n      end\n\n      def prefer_exact?(query)\n        %i[smart prefer_exact].include?(query.match)\n      end\n\n      def options_include_minimum?(opts)\n        %i[count minimum between].any? { |key| opts.key?(key) }\n      end\n\n      def parent\n        first(:xpath, './parent::*', minimum: 0)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "all", "signature": "def all(*args, allow_reload: false, **options, &optional_filter_block)", "start_line": 257, "end_line": 276}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 31}
{"function_name": "synced_resolve", "file_path": "capybara/lib/capybara/node/finders.rb", "focal_code": "def synced_resolve(query)\n        synchronize(query.wait) do\n          if prefer_exact?(query)\n            result = query.resolve_for(self, true)\n            result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?\n          else\n            result = query.resolve_for(self)\n          end\n\n          if ambiguous?(query, result)\n            raise Capybara::Ambiguous, \"Ambiguous match, found #{result.size} elements matching #{query.applied_description}\"\n          end\n          raise Capybara::ElementNotFound, \"Unable to find #{query.applied_description}\" if result.empty?\n\n          result.first\n        end.tap(&:allow_reload!)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Finders\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments. {#find} will raise an error if the element\n      # is not found.\n      #\n      #     page.find('#foo').find('.bar')\n      #     page.find(:xpath, './/div[contains(., \"bar\")]')\n      #     page.find('li', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #all)\n      #\n      # @macro waiting_behavior\n      #\n      # @!macro system_filters\n      #   @option options [String, Regexp] text      Only find elements which contain this text or match this regexp\n      #   @option options [String, Regexp, String] exact_text\n      #     When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.\n      #     Defaults to {Capybara.configure exact_text}.\n      #   @option options [Boolean] normalize_ws\n      #     Whether the `text`/`exact_text` options are compared against element text with whitespace normalized or as returned by the driver.\n      #     Defaults to {Capybara.configure default_normalize_ws}.\n      #   @option options [Boolean, Symbol] visible\n      #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.\n      #       * true - only finds visible elements.\n      #       * false - finds invisible _and_ visible elements.\n      #       * :all - same as false; finds visible and invisible elements.\n      #       * :hidden - only finds invisible elements.\n      #       * :visible - same as true; only finds visible elements.\n      #   @option options [Boolean] obscured  Only find elements with the specified obscured state:\n      #                                       * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.\n      #                                       * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.\n      #   @option options [String, Regexp]  id           Only find elements with an id that matches the value passed\n      #   @option options [String, Array<String>, Regexp] class  Only find elements with matching class/classes.\n      #                                            * Absence of a class can be checked by prefixing the class name with `!`\n      #                                            * If you need to check for existence of a class name that starts with `!` then prefix with `!!`\n      #\n      #                                                class:['a', '!b', '!!!c'] # limit to elements with class 'a' and '!c' but not class 'b'\n      #\n      #   @option options [String, Regexp, Hash] style  Only find elements with matching style. String and Regexp will be checked against text of the elements `style` attribute, while a Hash will be compared against the elements full style\n      #   @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially. Defaults to {Capybara.configure exact}.\n      #   @option options [Symbol] match        The matching strategy to use. Defaults to {Capybara.configure match}.\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def find(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        count_options = options.slice(*Capybara::Queries::BaseQuery::COUNT_KEYS)\n        unless count_options.empty?\n          Capybara::Helpers.warn(\n            \"'find' does not support count options (#{count_options}) ignoring. \" \\\n            \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n          )\n        end\n        synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on.\n      # {#ancestor} will raise an error if the element is not found.\n      #\n      # {#ancestor} takes the same options as {#find}.\n      #\n      #     element.ancestor('#foo').find('.bar')\n      #     element.ancestor(:xpath, './/div[contains(., \"bar\")]')\n      #     element.ancestor('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def ancestor(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on.\n      # {#sibling} will raise an error if the element is not found.\n      #\n      # {#sibling} takes the same options as {#find}.\n      #\n      #     element.sibling('#foo').find('.bar')\n      #     element.sibling(:xpath, './/div[contains(., \"bar\")]')\n      #     element.sibling('ul', text: 'Quox').click_link('Delete')\n      #\n      # @param (see #find)\n      #\n      # @macro waiting_behavior\n      #\n      # @return [Capybara::Node::Element]      The found element\n      # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires\n      #\n      def sibling(*args, **options, &optional_filter_block)\n        options[:session_options] = session_options\n        synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a form field on the page. The field can be found by its name, id or label text.\n      #\n      # @overload find_field([locator], **options)\n      #   @param [String] locator             name, id, {Capybara.configure test_id} attribute, placeholder or text of associated label element\n      #\n      #   @macro waiting_behavior\n      #\n      #\n      #   @option options [Boolean] checked       Match checked field?\n      #   @option options [Boolean] unchecked     Match unchecked field?\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled field?\n      #                                                       * true - only finds a disabled field\n      #                                                       * false - only finds an enabled field\n      #                                                       * :all - finds either an enabled or disabled field\n      #   @option options [Boolean] readonly      Match readonly field?\n      #   @option options [String, Regexp] with   Value of field to match on\n      #   @option options [String] type           Type of field to match on\n      #   @option options [Boolean] multiple      Match fields that can have multiple values?\n      #   @option options [String, Regexp] id     Match fields that match the id attribute\n      #   @option options [String] name           Match fields that match the name attribute\n      #   @option options [String] placeholder    Match fields that match the placeholder attribute\n      #   @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_field(locator = nil, **options, &optional_filter_block)\n        find(:field, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a link on the page. The link can be found by its id or text.\n      #\n      # @overload find_link([locator], **options)\n      #   @param [String] locator            id, {Capybara.configure test_id} attribute, title, text, or alt of enclosed img element\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [String,Regexp,nil] href    Value to match against the links href, if `nil` finds link placeholders (`<a>` elements with no href attribute), if `false` ignores the href\n      #   @option options [String, Regexp] id         Match links with the id provided\n      #   @option options [String] title              Match links with the title provided\n      #   @option options [String] alt                Match links with a contained img element whose alt matches\n      #   @option options [String, Boolean] download  Match links with the download provided\n      #   @option options [String] target             Match links with the target provided\n      #   @option options [String, Array<String>, Regexp] class    Match links that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_link(locator = nil, **options, &optional_filter_block)\n        find(:link, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a button on the page.\n      # This can be any `<input>` element of type submit, reset, image, button or it can be a\n      # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title.\n      # `<button>` elements can also be found by their text content, and image `<input>` elements by their alt attribute.\n      #\n      # @overload find_button([locator], **options)\n      #   @param [String] locator            id, name, {Capybara.configure test_id} attribute, value, title, text content, alt of image\n      #\n      #   @macro waiting_behavior\n      #\n      #   @option options [Boolean, Symbol] disabled (false)  Match disabled button?\n      #                                                       * true - only finds a disabled button\n      #                                                       * false - only finds an enabled button\n      #                                                       * :all - finds either an enabled or disabled button\n      #   @option options [String, Regexp] id                 Match buttons with the id provided\n      #   @option options [String] name                       Match buttons with the name provided\n      #   @option options [String] title                      Match buttons with the title provided\n      #   @option options [String] value                      Match buttons with the value provided\n      #   @option options [String, Array<String>, Regexp] class    Match buttons that match the class(es) provided\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_button(locator = nil, **options, &optional_filter_block)\n        find(:button, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Find a element on the page, given its id.\n      #\n      # @macro waiting_behavior\n      #\n      # @param [String] id                  id of element\n      #\n      # @return [Capybara::Node::Element]   The found element\n      #\n      def find_by_id(id, **options, &optional_filter_block)\n        find(:id, id, **options, &optional_filter_block)\n      end\n\n      ##\n      # @!method all([kind = Capybara.default_selector], locator = nil, **options)\n      #\n      # Find all elements on the page matching the given selector\n      # and options.\n      #\n      # Both XPath and CSS expressions are supported, but Capybara\n      # does not try to automatically distinguish between them. The\n      # following statements are equivalent:\n      #\n      #     page.all(:css, 'a#person_123')\n      #     page.all(:xpath, './/a[@id=\"person_123\"]')\n      #\n      # If the type of selector is left out, Capybara uses\n      # {Capybara.configure default_selector}. It's set to `:css` by default.\n      #\n      #     page.all(\"a#person_123\")\n      #\n      #     Capybara.default_selector = :xpath\n      #     page.all('.//a[@id=\"person_123\"]')\n      #\n      # The set of found elements can further be restricted by specifying\n      # options. It's possible to select elements by their text or visibility:\n      #\n      #     page.all('a', text: 'Home')\n      #     page.all('#menu li', visible: true)\n      #\n      # By default Capybara's waiting behavior will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to be available and then return an empty result if none\n      # are available. It is possible to set expectations on the number of results located and\n      # Capybara will raise an exception if the number of elements located don't satisfy the\n      # specified conditions. The expectations can be set using:\n      #\n      #     page.assert_selector('p#foo', count: 4)\n      #     page.assert_selector('p#foo', maximum: 10)\n      #     page.assert_selector('p#foo', minimum: 1)\n      #     page.assert_selector('p#foo', between: 1..10)\n      #\n      # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.). Defaults to {Capybara.configure default_selector}.\n      # @param [String] locator                    The locator for the specified selector\n      # @macro system_filters\n      # @macro waiting_behavior\n      # @option options [Integer] count            Exact number of matches that are expected to be found\n      # @option options [Integer] maximum          Maximum number of matches that are expected to be found\n      # @option options [Integer] minimum          Minimum number of matches that are expected to be found\n      # @option options [Range]   between          Number of matches found must be within the given range\n      # @option options [Boolean] allow_reload     Beta feature - May be removed in any version.\n      #   When `true` allows elements to be reloaded if they become stale. This is an advanced behavior and should only be used\n      #   if you fully understand the potential ramifications. The results can be confusing on dynamic pages. Defaults to `false`\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options)\n      # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)\n      #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results\n      #   @yieldreturn [Boolean]                     Should the element be considered in the results?\n      # @return [Capybara::Result]                   A collection of found elements\n      # @raise [Capybara::ExpectationNotMet]         The number of elements found doesn't match the specified conditions\n      def all(*args, allow_reload: false, **options, &optional_filter_block)\n        minimum_specified = options_include_minimum?(options)\n        options = { minimum: 1 }.merge(options) unless minimum_specified\n        options[:session_options] = session_options\n        query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)\n        result = nil\n        begin\n          synchronize(query.wait) do\n            result = query.resolve_for(self)\n            result.allow_reload! if allow_reload\n            raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?\n\n            result\n          end\n        rescue Capybara::ExpectationNotMet\n          raise if minimum_specified || (result.compare_count == 1)\n\n          Result.new([], nil)\n        end\n      end\n      alias_method :find_all, :all\n\n      ##\n      #\n      # Find the first element on the page matching the given selector\n      # and options. By default {#first} will wait up to {Capybara.configure default_max_wait_time}\n      # seconds for matching elements to appear and then raise an error if no matching\n      # element is found, or `nil` if the provided count options allow for empty results.\n      #\n      # @overload first([kind], locator, options)\n      #   @param [Symbol] kind                       The type of selector\n      #   @param [String] locator                    The selector\n      #   @param [Hash] options                      Additional options; see {#all}\n      # @return [Capybara::Node::Element]            The found element or nil\n      # @raise  [Capybara::ElementNotFound]          If element(s) matching the provided options can't be found before time expires\n      #\n      def first(*args, **options, &optional_filter_block)\n        options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)\n        all(*args, **options, &optional_filter_block).first\n      end\n\n    private\n\n      def synced_resolve(query)\n        synchronize(query.wait) do\n          if prefer_exact?(query)\n            result = query.resolve_for(self, true)\n            result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?\n          else\n            result = query.resolve_for(self)\n          end\n\n          if ambiguous?(query, result)\n            raise Capybara::Ambiguous, \"Ambiguous match, found #{result.size} elements matching #{query.applied_description}\"\n          end\n          raise Capybara::ElementNotFound, \"Unable to find #{query.applied_description}\" if result.empty?\n\n          result.first\n        end.tap(&:allow_reload!)\n      end\n\n      def ambiguous?(query, result)\n        %i[one smart].include?(query.match) && (result.size > 1)\n      end\n\n      def prefer_exact?(query)\n        %i[smart prefer_exact].include?(query.match)\n      end\n\n      def options_include_minimum?(opts)\n        %i[count minimum between].any? { |key| opts.key?(key) }\n      end\n\n      def parent\n        first(:xpath, './parent::*', minimum: 0)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "synced_resolve", "signature": "def synced_resolve(query)", "start_line": 300, "end_line": 316}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 32}
{"function_name": "assert_any_of_selectors", "file_path": "capybara/lib/capybara/node/matchers.rb", "focal_code": "def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block)\n        wait = session_options.default_max_wait_time if wait.nil?\n        selector = extract_selector(args)\n        synchronize(wait) do\n          res = args.map do |locator|\n            assert_selector(selector, locator, options, &optional_filter_block)\n            break nil\n          rescue Capybara::ExpectationNotMet => e\n            e.message\n          end\n          raise Capybara::ExpectationNotMet, res.join(' or ') if res\n\n          true\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    module Matchers\n      ##\n      #\n      # Checks if a given selector is on the page or a descendant of the current node.\n      #\n      #     page.has_selector?('p#foo')\n      #     page.has_selector?(:xpath, './/p[@id=\"foo\"]')\n      #     page.has_selector?(:foo)\n      #\n      # By default it will check if the expression occurs at least once,\n      # but a different number can be specified.\n      #\n      #     page.has_selector?('p.foo', count: 4)\n      #\n      # This will check if the expression occurs exactly 4 times.\n      #\n      # It also accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      #     page.has_selector?('li', text: 'Horse', visible: true)\n      #\n      # {#has_selector?} can also accept XPath expressions generated by the\n      # XPath gem:\n      #\n      #     page.has_selector?(:xpath, XPath.descendant(:p))\n      #\n      # @param (see Capybara::Node::Finders#all)\n      # @option options [Integer] :count (nil)     Number of matching elements that should exist\n      # @option options [Integer] :minimum (nil)   Minimum number of matching elements that should exist\n      # @option options [Integer] :maximum (nil)   Maximum number of matching elements that should exist\n      # @option options [Range]   :between (nil)   Range of number of matching elements that should exist\n      # @return [Boolean]                       If the expression exists\n      #\n      def has_selector?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_selector(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Checks if a given selector is not on the page or a descendant of the current node.\n      # Usage is identical to {#has_selector?}.\n      #\n      # @param (see #has_selector?)\n      # @return [Boolean]\n      #\n      def has_no_selector?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_no_selector(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Checks if a an element has the specified CSS styles.\n      #\n      #     element.matches_style?( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )\n      #\n      # @param styles [Hash]\n      # @return [Boolean]                       If the styles match\n      #\n      def matches_style?(styles = nil, **options)\n        styles, options = options, {} if styles.nil?\n        make_predicate(options) { assert_matches_style(styles, **options) }\n      end\n\n      ##\n      # @deprecated Use {#matches_style?} instead.\n      #\n      def has_style?(styles = nil, **options)\n        Capybara::Helpers.warn \"DEPRECATED: has_style? is deprecated, please use matches_style? : #{Capybara::Helpers.filter_backtrace(caller)}\"\n        matches_style?(styles, **options)\n      end\n\n      ##\n      #\n      # Asserts that a given selector is on the page or a descendant of the current node.\n      #\n      #     page.assert_selector('p#foo')\n      #     page.assert_selector(:xpath, './/p[@id=\"foo\"]')\n      #     page.assert_selector(:foo)\n      #\n      # By default it will check if the expression occurs at least once,\n      # but a different number can be specified.\n      #\n      #     page.assert_selector('p#foo', count: 4)\n      #\n      # This will check if the expression occurs exactly 4 times. See\n      # {Capybara::Node::Finders#all} for other available result size options.\n      #\n      # If a `:count` of 0 is specified, it will behave like {#assert_no_selector};\n      # however, use of that method is preferred over this one.\n      #\n      # It also accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      #     page.assert_selector('li', text: 'Horse', visible: true)\n      #\n      # {#assert_selector} can also accept XPath expressions generated by the\n      # XPath gem:\n      #\n      #     page.assert_selector(:xpath, XPath.descendant(:p))\n      #\n      # @param (see Capybara::Node::Finders#all)\n      # @option options [Integer] :count (nil)    Number of times the expression should occur\n      # @raise [Capybara::ExpectationNotMet]      If the selector does not exist\n      #\n      def assert_selector(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block) do |result, query|\n          unless result.matches_count? && (result.any? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.failure_message\n          end\n        end\n      end\n\n      ##\n      #\n      # Asserts that an element has the specified CSS styles.\n      #\n      #     element.assert_matches_style( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )\n      #\n      # @param styles [Hash]\n      # @raise [Capybara::ExpectationNotMet]    If the element doesn't have the specified styles\n      #\n      def assert_matches_style(styles = nil, **options)\n        styles, options = options, {} if styles.nil?\n        query_args, query_opts = _set_query_session_options(styles, options)\n        query = Capybara::Queries::StyleQuery.new(*query_args, **query_opts)\n        synchronize(query.wait) do\n          raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)\n        end\n        true\n      end\n\n      ##\n      # @deprecated Use {#assert_matches_style} instead.\n      #\n      def assert_style(styles = nil, **options)\n        warn 'assert_style is deprecated, please use assert_matches_style instead'\n        assert_matches_style(styles, **options)\n      end\n\n      # Asserts that all of the provided selectors are present on the given page\n      # or descendants of the current node.  If options are provided, the assertion\n      # will check that each locator is present with those options as well (other than `:wait`).\n      #\n      #     page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)\n      #     page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')\n      #\n      # It accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      # The `:wait` option applies to all of the selectors as a group, so all of the locators must be present\n      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.\n      #\n      # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, **options)\n      #\n      def assert_all_of_selectors(*args, **options, &optional_filter_block)\n        _verify_multiple(*args, **options) do |selector, locator, opts|\n          assert_selector(selector, locator, opts, &optional_filter_block)\n        end\n      end\n\n      # Asserts that none of the provided selectors are present on the given page\n      # or descendants of the current node. If options are provided, the assertion\n      # will check that each locator is not present with those options as well (other than `:wait`).\n      #\n      #     page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)\n      #     page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')\n      #\n      # It accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      # The `:wait` option applies to all of the selectors as a group, so none of the locators must be present\n      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.\n      #\n      # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, **options)\n      #\n      def assert_none_of_selectors(*args, **options, &optional_filter_block)\n        _verify_multiple(*args, **options) do |selector, locator, opts|\n          assert_no_selector(selector, locator, opts, &optional_filter_block)\n        end\n      end\n\n      # Asserts that any of the provided selectors are present on the given page\n      # or descendants of the current node. If options are provided, the assertion\n      # will check that each locator is present with those options as well (other than `:wait`).\n      #\n      #     page.assert_any_of_selectors(:custom, 'Tom', 'Joe', visible: all)\n      #     page.assert_any_of_selectors(:css, '#my_div', 'a.not_clicked')\n      #\n      # It accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      # The `:wait` option applies to all of the selectors as a group, so any of the locators must be present\n      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.\n      #\n      # @overload assert_any_of_selectors([kind = Capybara.default_selector], *locators, **options)\n      #\n      def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block)\n        wait = session_options.default_max_wait_time if wait.nil?\n        selector = extract_selector(args)\n        synchronize(wait) do\n          res = args.map do |locator|\n            assert_selector(selector, locator, options, &optional_filter_block)\n            break nil\n          rescue Capybara::ExpectationNotMet => e\n            e.message\n          end\n          raise Capybara::ExpectationNotMet, res.join(' or ') if res\n\n          true\n        end\n      end\n\n      ##\n      #\n      # Asserts that a given selector is not on the page or a descendant of the current node.\n      # Usage is identical to {#assert_selector}.\n      #\n      # Query options such as `:count`, `:minimum`, `:maximum`, and `:between` are\n      # considered to be an integral part of the selector. This will return\n      # `true`, for example, if a page contains 4 anchors but the query expects 5:\n      #\n      #     page.assert_no_selector('a', minimum: 1) # Found, raises Capybara::ExpectationNotMet\n      #     page.assert_no_selector('a', count: 4)   # Found, raises Capybara::ExpectationNotMet\n      #     page.assert_no_selector('a', count: 5)   # Not Found, returns true\n      #\n      # @param (see #assert_selector)\n      # @raise [Capybara::ExpectationNotMet]      If the selector exists\n      #\n      def assert_no_selector(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block) do |result, query|\n          if result.matches_count? && (!result.empty? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.negative_failure_message\n          end\n        end\n      end\n\n      ##\n      #\n      # Checks if a given XPath expression is on the page or a descendant of the current node.\n      #\n      #     page.has_xpath?('.//p[@id=\"foo\"]')\n      #\n      # By default it will check if the expression occurs at least once,\n      # but a different number can be specified.\n      #\n      #     page.has_xpath?('.//p[@id=\"foo\"]', count: 4)\n      #\n      # This will check if the expression occurs exactly 4 times.\n      #\n      # It also accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      #     page.has_xpath?('.//li', text: 'Horse', visible: true)\n      #\n      # {#has_xpath?} can also accept XPath expressions generated by the\n      # XPath gem:\n      #\n      #     xpath = XPath.generate { |x| x.descendant(:p) }\n      #     page.has_xpath?(xpath)\n      #\n      # @param [String] path                      An XPath expression\n      # @param options                            (see Capybara::Node::Finders#all)\n      # @option options [Integer] :count (nil)    Number of times the expression should occur\n      # @return [Boolean]                         If the expression exists\n      #\n      def has_xpath?(path, **options, &optional_filter_block)\n        has_selector?(:xpath, path, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if a given XPath expression is not on the page or a descendant of the current node.\n      # Usage is identical to {#has_xpath?}.\n      #\n      # @param (see #has_xpath?)\n      # @return [Boolean]\n      #\n      def has_no_xpath?(path, **options, &optional_filter_block)\n        has_no_selector?(:xpath, path, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if a given CSS selector is on the page or a descendant of the current node.\n      #\n      #     page.has_css?('p#foo')\n      #\n      # By default it will check if the selector occurs at least once,\n      # but a different number can be specified.\n      #\n      #     page.has_css?('p#foo', count: 4)\n      #\n      # This will check if the selector occurs exactly 4 times.\n      #\n      # It also accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      #     page.has_css?('li', text: 'Horse', visible: true)\n      #\n      # @param [String] path                      A CSS selector\n      # @param options                            (see Capybara::Node::Finders#all)\n      # @option options [Integer] :count (nil)    Number of times the selector should occur\n      # @return [Boolean]                         If the selector exists\n      #\n      def has_css?(path, **options, &optional_filter_block)\n        has_selector?(:css, path, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if a given CSS selector is not on the page or a descendant of the current node.\n      # Usage is identical to {#has_css?}.\n      #\n      # @param (see #has_css?)\n      # @return [Boolean]\n      #\n      def has_no_css?(path, **options, &optional_filter_block)\n        has_no_selector?(:css, path, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a element with the given\n      # local name.\n      #\n      # @param [String] locator           The local name of a element to check for\n      # @option options [String, Regexp]  The attributes values of matching elements\n      # @return [Boolean]                 Whether it exists\n      #\n      def has_element?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:element, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no element with the given\n      # local name.\n      #\n      # @param (see #has_element?)\n      # @return [Boolean]            Whether it doesn't exist\n      #\n      def has_no_element?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:element, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a link with the given\n      # text or id.\n      #\n      # @param [String] locator           The text or id of a link to check for\n      # @option options [String, Regexp] :href    The value the href attribute must be\n      # @return [Boolean]                 Whether it exists\n      #\n      def has_link?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:link, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no link with the given\n      # text or id.\n      #\n      # @param (see #has_link?)\n      # @return [Boolean]            Whether it doesn't exist\n      #\n      def has_no_link?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:link, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a button with the given\n      # text, value or id.\n      #\n      # @param [String] locator      The text, value or id of a button to check for\n      # @return [Boolean]            Whether it exists\n      #\n      def has_button?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:button, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no button with the given\n      # text, value or id.\n      #\n      # @param [String] locator      The text, value or id of a button to check for\n      # @return [Boolean]            Whether it doesn't exist\n      #\n      def has_no_button?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:button, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a form field with the given\n      # label, name or id.\n      #\n      # For text fields and other textual fields, such as textareas and\n      # HTML5 email/url/etc. fields, it's possible to specify a `:with`\n      # option to specify the text the field should contain:\n      #\n      #     page.has_field?('Name', with: 'Jonas')\n      #\n      # It is also possible to filter by the field type attribute:\n      #\n      #     page.has_field?('Email', type: 'email')\n      #\n      # NOTE: 'textarea' and 'select' are valid type values, matching the associated tag names.\n      #\n      # @param [String] locator                  The label, name or id of a field to check for\n      # @option options [String, Regexp] :with   The text content of the field or a Regexp to match\n      # @option options [String] :type           The type attribute of the field\n      # @return [Boolean]                        Whether it exists\n      #\n      def has_field?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:field, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no form field with the given\n      # label, name or id. See {#has_field?}.\n      #\n      # @param [String] locator                  The label, name or id of a field to check for\n      # @option options [String, Regexp] :with   The text content of the field or a Regexp to match\n      # @option options [String] :type           The type attribute of the field\n      # @return [Boolean]                        Whether it doesn't exist\n      #\n      def has_no_field?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:field, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a radio button or\n      # checkbox with the given label, value, id, or {Capybara.configure test_id} attribute that is currently\n      # checked.\n      #\n      # @param [String] locator           The label, name or id of a checked field\n      # @return [Boolean]                 Whether it exists\n      #\n      def has_checked_field?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no radio button or\n      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently\n      # checked.\n      #\n      # @param [String] locator           The label, name or id of a checked field\n      # @return [Boolean]                 Whether it doesn't exist\n      #\n      def has_no_checked_field?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a radio button or\n      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently\n      # unchecked.\n      #\n      # @param [String] locator           The label, name or id of an unchecked field\n      # @return [Boolean]                 Whether it exists\n      #\n      def has_unchecked_field?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no radio button or\n      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently\n      # unchecked.\n      #\n      # @param [String] locator           The label, name or id of an unchecked field\n      # @return [Boolean]                 Whether it doesn't exist\n      #\n      def has_no_unchecked_field?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a select field with the\n      # given label, name or id.\n      #\n      # It can be specified which option should currently be selected:\n      #\n      #     page.has_select?('Language', selected: 'German')\n      #\n      # For multiple select boxes, several options may be specified:\n      #\n      #     page.has_select?('Language', selected: ['English', 'German'])\n      #\n      # It's also possible to check if the exact set of options exists for\n      # this select box:\n      #\n      #     page.has_select?('Language', options: ['English', 'German', 'Spanish'])\n      #\n      # You can also check for a partial set of options:\n      #\n      #     page.has_select?('Language', with_options: ['English', 'German'])\n      #\n      # @param [String] locator                         The label, name or id of a select box\n      # @option options [Array] :options                Options which should be contained in this select box\n      # @option options [Array] :with_options           Partial set of options which should be contained in this select box\n      # @option options [String, Array] :selected       Options which should be selected\n      # @option options [String, Array] :with_selected  Partial set of options which should minimally be selected\n      # @return [Boolean]                               Whether it exists\n      #\n      def has_select?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:select, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no select field with the\n      # given label, name or id. See {#has_select?}.\n      #\n      # @param (see #has_select?)\n      # @return [Boolean]     Whether it doesn't exist\n      #\n      def has_no_select?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:select, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has a table with the given id\n      # or caption:\n      #\n      #    page.has_table?('People')\n      #\n      # @param [String] locator  The id or caption of a table\n      # @option options [Array<Array<String>>] :rows\n      #   Text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)\n      # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_rows\n      #   Partial set of text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)\n      # @option options [Array<Array<String>>] :cols\n      #   Text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)\n      # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_cols\n      #   Partial set of text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)\n      # @return [Boolean]        Whether it exists\n      #\n      def has_table?(locator = nil, **options, &optional_filter_block)\n        has_selector?(:table, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the page or current node has no table with the given id\n      # or caption. See {#has_table?}.\n      #\n      # @param (see #has_table?)\n      # @return [Boolean]       Whether it doesn't exist\n      #\n      def has_no_table?(locator = nil, **options, &optional_filter_block)\n        has_no_selector?(:table, locator, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Asserts that the current node matches a given selector.\n      #\n      #     node.assert_matches_selector('p#foo')\n      #     node.assert_matches_selector(:xpath, '//p[@id=\"foo\"]')\n      #     node.assert_matches_selector(:foo)\n      #\n      # It also accepts all options that {Capybara::Node::Finders#all} accepts,\n      # such as `:text` and `:visible`.\n      #\n      #     node.assert_matches_selector('li', text: 'Horse', visible: true)\n      #\n      # @param (see Capybara::Node::Finders#all)\n      # @raise [Capybara::ExpectationNotMet]      If the selector does not match\n      #\n      def assert_matches_selector(*args, &optional_filter_block)\n        _verify_match_result(args, optional_filter_block) do |result|\n          raise Capybara::ExpectationNotMet, 'Item does not match the provided selector' unless result.include? self\n        end\n      end\n\n      ##\n      #\n      # Asserts that the current node does not match a given selector.\n      # Usage is identical to {#assert_matches_selector}.\n      #\n      # @param (see #assert_matches_selector)\n      # @raise [Capybara::ExpectationNotMet]      If the selector matches\n      #\n      def assert_not_matches_selector(*args, &optional_filter_block)\n        _verify_match_result(args, optional_filter_block) do |result|\n          raise Capybara::ExpectationNotMet, 'Item matched the provided selector' if result.include? self\n        end\n      end\n\n      ##\n      #\n      # Checks if the current node matches given selector.\n      #\n      # @param (see #has_selector?)\n      # @return [Boolean]\n      #\n      def matches_selector?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_matches_selector(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Checks if the current node matches given XPath expression.\n      #\n      # @param [String, XPath::Expression] xpath The XPath expression to match against the current code\n      # @return [Boolean]\n      #\n      def matches_xpath?(xpath, **options, &optional_filter_block)\n        matches_selector?(:xpath, xpath, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the current node matches given CSS selector.\n      #\n      # @param [String] css The CSS selector to match against the current code\n      # @return [Boolean]\n      #\n      def matches_css?(css, **options, &optional_filter_block)\n        matches_selector?(:css, css, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the current node does not match given selector.\n      # Usage is identical to {#has_selector?}.\n      #\n      # @param (see #has_selector?)\n      # @return [Boolean]\n      #\n      def not_matches_selector?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_not_matches_selector(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Checks if the current node does not match given XPath expression.\n      #\n      # @param [String, XPath::Expression] xpath The XPath expression to match against the current code\n      # @return [Boolean]\n      #\n      def not_matches_xpath?(xpath, **options, &optional_filter_block)\n        not_matches_selector?(:xpath, xpath, **options, &optional_filter_block)\n      end\n\n      ##\n      #\n      # Checks if the current node does not match given CSS selector.\n      #\n      # @param [String] css The CSS selector to match against the current code\n      # @return [Boolean]\n      #\n      def not_matches_css?(css, **options, &optional_filter_block)\n        not_matches_selector?(:css, css, **options, &optional_filter_block)\n      end\n\n      ##\n      # Asserts that the page or current node has the given text content,\n      # ignoring any HTML tags.\n      #\n      # @!macro text_query_params\n      #   @overload $0(type, text, **options)\n      #     @param [:all, :visible] type               Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of {Capybara.configure ignore_hidden_elements}, which defaults to `true`, corresponding to `:visible`.\n      #     @param [String, Regexp] text               The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.\n      #     @option options [Integer] :count (nil)     Number of times the text is expected to occur\n      #     @option options [Integer] :minimum (nil)   Minimum number of times the text is expected to occur\n      #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur\n      #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs\n      #     @option options [Numeric] :wait            Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.\n      #     @option options [Boolean] :exact           Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.\n      #     @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space\n      #   @overload $0(text, **options)\n      #     @param [String, Regexp] text               The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.\n      #     @option options [Integer] :count (nil)     Number of times the text is expected to occur\n      #     @option options [Integer] :minimum (nil)   Minimum number of times the text is expected to occur\n      #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur\n      #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs\n      #     @option options [Numeric] :wait            Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.\n      #     @option options [Boolean] :exact           Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.\n      #     @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space\n      # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time\n      # @return [true]\n      #\n      def assert_text(type_or_text, *args, **opts)\n        _verify_text(type_or_text, *args, **opts) do |count, query|\n          unless query.matches_count?(count) && (count.positive? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, query.failure_message\n          end\n        end\n      end\n\n      ##\n      # Asserts that the page or current node doesn't have the given text content,\n      # ignoring any HTML tags.\n      #\n      # @macro text_query_params\n      # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time\n      # @return [true]\n      #\n      def assert_no_text(type_or_text, *args, **opts)\n        _verify_text(type_or_text, *args, **opts) do |count, query|\n          if query.matches_count?(count) && (count.positive? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, query.negative_failure_message\n          end\n        end\n      end\n\n      ##\n      # Checks if the page or current node has the given text content,\n      # ignoring any HTML tags.\n      #\n      # By default it will check if the text occurs at least once,\n      # but a different number can be specified.\n      #\n      #     page.has_text?('lorem ipsum', between: 2..4)\n      #\n      # This will check if the text occurs from 2 to 4 times.\n      #\n      # @macro text_query_params\n      # @return [Boolean]                            Whether it exists\n      #\n      def has_text?(*args, **options)\n        make_predicate(options) { assert_text(*args, **options) }\n      end\n      alias_method :has_content?, :has_text?\n\n      ##\n      # Checks if the page or current node does not have the given text\n      # content, ignoring any HTML tags and normalizing whitespace.\n      #\n      # @macro text_query_params\n      # @return [Boolean]  Whether it doesn't exist\n      #\n      def has_no_text?(*args, **options)\n        make_predicate(options) { assert_no_text(*args, **options) }\n      end\n      alias_method :has_no_content?, :has_no_text?\n\n      ##\n      #\n      # Asserts that a given selector matches an ancestor of the current node.\n      #\n      #     element.assert_ancestor('p#foo')\n      #\n      # Accepts the same options as {#assert_selector}\n      #\n      # @param (see Capybara::Node::Finders#find)\n      # @raise [Capybara::ExpectationNotMet]      If the selector does not exist\n      #\n      def assert_ancestor(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|\n          unless result.matches_count? && (result.any? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.failure_message\n          end\n        end\n      end\n\n      def assert_no_ancestor(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|\n          if result.matches_count? && (!result.empty? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.negative_failure_message\n          end\n        end\n      end\n\n      ##\n      #\n      # Predicate version of {#assert_ancestor}\n      #\n      def has_ancestor?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_ancestor(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Predicate version of {#assert_no_ancestor}\n      #\n      def has_no_ancestor?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_no_ancestor(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Asserts that a given selector matches a sibling of the current node.\n      #\n      #     element.assert_sibling('p#foo')\n      #\n      # Accepts the same options as {#assert_selector}\n      #\n      # @param (see Capybara::Node::Finders#find)\n      # @raise [Capybara::ExpectationNotMet]      If the selector does not exist\n      #\n      def assert_sibling(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|\n          unless result.matches_count? && (result.any? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.failure_message\n          end\n        end\n      end\n\n      def assert_no_sibling(*args, &optional_filter_block)\n        _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|\n          if result.matches_count? && (!result.empty? || query.expects_none?)\n            raise Capybara::ExpectationNotMet, result.negative_failure_message\n          end\n        end\n      end\n\n      ##\n      #\n      # Predicate version of {#assert_sibling}\n      #\n      def has_sibling?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_sibling(*args, options, &optional_filter_block) }\n      end\n\n      ##\n      #\n      # Predicate version of {#assert_no_sibling}\n      #\n      def has_no_sibling?(*args, **options, &optional_filter_block)\n        make_predicate(options) { assert_no_sibling(*args, options, &optional_filter_block) }\n      end\n\n      def ==(other)\n        eql?(other) || (other.respond_to?(:base) && base == other.base)\n      end\n\n    private\n\n      def extract_selector(args)\n        args.first.is_a?(Symbol) ? args.shift : session_options.default_selector\n      end\n\n      def _verify_multiple(*args, wait: nil, **options)\n        wait = session_options.default_max_wait_time if wait.nil?\n        selector = extract_selector(args)\n        synchronize(wait) do\n          args.each { |locator| yield(selector, locator, options) }\n        end\n      end\n\n      def _verify_selector_result(query_args, optional_filter_block, query_type = Capybara::Queries::SelectorQuery)\n        # query_args, query_opts = if query_args[0].is_a? Symbol\n        #   a,o = _set_query_session_options(*query_args.slice(2..))\n        #   [query_args.slice(0..1).concat(a), o]\n        # else\n        #   _set_query_session_options(*query_args)\n        # end\n        query_args, query_opts = _set_query_session_options(*query_args)\n        query = query_type.new(*query_args, **query_opts, &optional_filter_block)\n        synchronize(query.wait) do\n          yield query.resolve_for(self), query\n        end\n        true\n      end\n\n      def _verify_match_result(query_args, optional_filter_block)\n        query_args, query_opts = _set_query_session_options(*query_args)\n        query = Capybara::Queries::MatchQuery.new(*query_args, **query_opts, &optional_filter_block)\n        synchronize(query.wait) do\n          yield query.resolve_for(parent || session&.document || query_scope)\n        end\n        true\n      end\n\n      def _verify_text(type = nil, expected_text, **query_options) # rubocop:disable Style/OptionalArguments\n        query_options[:session_options] = session_options\n        query = Capybara::Queries::TextQuery.new(type, expected_text, **query_options)\n        synchronize(query.wait) do\n          yield query.resolve_for(self), query\n        end\n        true\n      end\n\n      def _set_query_session_options(*query_args)\n        query_args, query_options = query_args.dup, {}\n        # query_options = query_args.pop if query_options.empty? && query_args.last.is_a?(Hash)\n        query_options = query_args.pop if query_args.last.is_a?(Hash)\n        query_options[:session_options] = session_options\n        [query_args, query_options]\n      end\n\n      def make_predicate(options)\n        options[:wait] = 0 unless options.key?(:wait) || session_options.predicates_wait\n        yield\n      rescue Capybara::ExpectationNotMet\n        false\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "assert_any_of_selectors", "signature": "def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block)", "start_line": 201, "end_line": 215}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 33}
{"function_name": "[]", "file_path": "capybara/lib/capybara/node/simple.rb", "focal_code": "def [](name)\n        attr_name = name.to_s\n        if attr_name == 'value'\n          value\n        elsif (tag_name == 'input') && (native[:type] == 'checkbox') && (attr_name == 'checked')\n          native['checked'] == 'checked'\n        else\n          native[attr_name]\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Simple} is a simpler version of {Capybara::Node::Base} which\n    # includes only {Capybara::Node::Finders} and {Capybara::Node::Matchers} and does\n    # not include {Capybara::Node::Actions}. This type of node is returned when\n    # using {Capybara.string}.\n    #\n    # It is useful in that it does not require a session, an application or a driver,\n    # but can still use Capybara's finders and matchers on any string that contains HTML.\n    #\n    class Simple\n      include Capybara::Node::Finders\n      include Capybara::Node::Matchers\n      include Capybara::Node::DocumentMatchers\n\n      attr_reader :native\n\n      def initialize(native)\n        native = Capybara::HTML(native) if native.is_a?(String)\n        @native = native\n      end\n\n      ##\n      #\n      # @return [String]    The text of the element\n      #\n      def text(_type = nil, normalize_ws: false)\n        txt = native.text\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] name  The attribute name to retrieve\n      # @return [String]       The value of the attribute\n      #\n      def [](name)\n        attr_name = name.to_s\n        if attr_name == 'value'\n          value\n        elsif (tag_name == 'input') && (native[:type] == 'checkbox') && (attr_name == 'checked')\n          native['checked'] == 'checked'\n        else\n          native[attr_name]\n        end\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        native.node_name\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        native.path\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        if tag_name == 'textarea'\n          native['_capybara_raw_value']\n        elsif tag_name == 'select'\n          selected_options = find_xpath('.//option[@selected]')\n          if multiple?\n            selected_options.map(&method(:option_value))\n          else\n            option_value(selected_options.first || find_xpath('.//option').first)\n          end\n        elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])\n          native[:value] || 'on'\n        else\n          native[:value]\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Does not support CSS, so\n      # the result may be inaccurate.\n      #\n      # @param  [Boolean] check_ancestors  Whether to inherit visibility from ancestors\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter\n        return false if (tag_name == 'input') && (native[:type] == 'hidden')\n        return false if tag_name == 'template'\n\n        if check_ancestors\n          !find_xpath(VISIBILITY_XPATH)\n        else\n          # No need for an xpath if only checking the current element\n          !(native.key?('hidden') ||\n            /display:\\s?none/.match?(native[:style] || '') ||\n            %w[script head style].include?(tag_name))\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        native.has_attribute?('checked')\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      def disabled?\n        native.has_attribute?('disabled') &&\n          %w[button input select textarea optgroup option menuitem fieldset].include?(tag_name)\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        native.has_attribute?('selected')\n      end\n\n      def multiple?\n        native.has_attribute?('multiple')\n      end\n\n      def readonly?\n        native.has_attribute?('readonly')\n      end\n\n      def synchronize(_seconds = nil)\n        yield # simple nodes don't need to wait\n      end\n\n      def allow_reload!(*)\n        # no op\n      end\n\n      ##\n      #\n      # @return [String]     The title of the document\n      def title\n        native.title\n      end\n\n      def inspect\n        %(#<Capybara::Node::Simple tag=\"#{tag_name}\" path=\"#{path}\">)\n      end\n\n      # @api private\n      def find_css(css, **_options)\n        native.css(css)\n      end\n\n      # @api private\n      def find_xpath(xpath, **_options)\n        native.xpath(xpath)\n      end\n\n      # @api private\n      def session_options\n        Capybara.session_options\n      end\n\n      # @api private\n      def initial_cache\n        {}\n      end\n\n      def ==(other)\n        eql?(other) || (other.respond_to?(:native) && native == other.native)\n      end\n\n    private\n\n      def option_value(option)\n        return nil if option.nil?\n\n        option[:value] || option.content\n      end\n\n      VISIBILITY_XPATH = XPath.generate do |x|\n        x.ancestor_or_self[\n          x.attr(:style)[x.contains('display:none') | x.contains('display: none')] |\n          x.attr(:hidden) |\n          x.qname.one_of('script', 'head') |\n          (~x.self(:summary) & XPath.parent(:details)[!XPath.attr(:open)])\n        ].boolean\n      end.to_s.freeze\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "[]", "signature": "def [](name)", "start_line": 45, "end_line": 54}, "metadata": {"module": "Capybara", "class_name": "Simple", "class_signature": "class Simple"}, "task_id": 34}
{"function_name": "value", "file_path": "capybara/lib/capybara/node/simple.rb", "focal_code": "def value\n        if tag_name == 'textarea'\n          native['_capybara_raw_value']\n        elsif tag_name == 'select'\n          selected_options = find_xpath('.//option[@selected]')\n          if multiple?\n            selected_options.map(&method(:option_value))\n          else\n            option_value(selected_options.first || find_xpath('.//option').first)\n          end\n        elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])\n          native[:value] || 'on'\n        else\n          native[:value]\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Simple} is a simpler version of {Capybara::Node::Base} which\n    # includes only {Capybara::Node::Finders} and {Capybara::Node::Matchers} and does\n    # not include {Capybara::Node::Actions}. This type of node is returned when\n    # using {Capybara.string}.\n    #\n    # It is useful in that it does not require a session, an application or a driver,\n    # but can still use Capybara's finders and matchers on any string that contains HTML.\n    #\n    class Simple\n      include Capybara::Node::Finders\n      include Capybara::Node::Matchers\n      include Capybara::Node::DocumentMatchers\n\n      attr_reader :native\n\n      def initialize(native)\n        native = Capybara::HTML(native) if native.is_a?(String)\n        @native = native\n      end\n\n      ##\n      #\n      # @return [String]    The text of the element\n      #\n      def text(_type = nil, normalize_ws: false)\n        txt = native.text\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] name  The attribute name to retrieve\n      # @return [String]       The value of the attribute\n      #\n      def [](name)\n        attr_name = name.to_s\n        if attr_name == 'value'\n          value\n        elsif (tag_name == 'input') && (native[:type] == 'checkbox') && (attr_name == 'checked')\n          native['checked'] == 'checked'\n        else\n          native[attr_name]\n        end\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        native.node_name\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        native.path\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        if tag_name == 'textarea'\n          native['_capybara_raw_value']\n        elsif tag_name == 'select'\n          selected_options = find_xpath('.//option[@selected]')\n          if multiple?\n            selected_options.map(&method(:option_value))\n          else\n            option_value(selected_options.first || find_xpath('.//option').first)\n          end\n        elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])\n          native[:value] || 'on'\n        else\n          native[:value]\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Does not support CSS, so\n      # the result may be inaccurate.\n      #\n      # @param  [Boolean] check_ancestors  Whether to inherit visibility from ancestors\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter\n        return false if (tag_name == 'input') && (native[:type] == 'hidden')\n        return false if tag_name == 'template'\n\n        if check_ancestors\n          !find_xpath(VISIBILITY_XPATH)\n        else\n          # No need for an xpath if only checking the current element\n          !(native.key?('hidden') ||\n            /display:\\s?none/.match?(native[:style] || '') ||\n            %w[script head style].include?(tag_name))\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        native.has_attribute?('checked')\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      def disabled?\n        native.has_attribute?('disabled') &&\n          %w[button input select textarea optgroup option menuitem fieldset].include?(tag_name)\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        native.has_attribute?('selected')\n      end\n\n      def multiple?\n        native.has_attribute?('multiple')\n      end\n\n      def readonly?\n        native.has_attribute?('readonly')\n      end\n\n      def synchronize(_seconds = nil)\n        yield # simple nodes don't need to wait\n      end\n\n      def allow_reload!(*)\n        # no op\n      end\n\n      ##\n      #\n      # @return [String]     The title of the document\n      def title\n        native.title\n      end\n\n      def inspect\n        %(#<Capybara::Node::Simple tag=\"#{tag_name}\" path=\"#{path}\">)\n      end\n\n      # @api private\n      def find_css(css, **_options)\n        native.css(css)\n      end\n\n      # @api private\n      def find_xpath(xpath, **_options)\n        native.xpath(xpath)\n      end\n\n      # @api private\n      def session_options\n        Capybara.session_options\n      end\n\n      # @api private\n      def initial_cache\n        {}\n      end\n\n      def ==(other)\n        eql?(other) || (other.respond_to?(:native) && native == other.native)\n      end\n\n    private\n\n      def option_value(option)\n        return nil if option.nil?\n\n        option[:value] || option.content\n      end\n\n      VISIBILITY_XPATH = XPath.generate do |x|\n        x.ancestor_or_self[\n          x.attr(:style)[x.contains('display:none') | x.contains('display: none')] |\n          x.attr(:hidden) |\n          x.qname.one_of('script', 'head') |\n          (~x.self(:summary) & XPath.parent(:details)[!XPath.attr(:open)])\n        ].boolean\n      end.to_s.freeze\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "value", "signature": "def value if tag_name == 'textarea'", "start_line": 78, "end_line": 93}, "metadata": {"module": "Capybara", "class_name": "Simple", "class_signature": "class Simple"}, "task_id": 35}
{"function_name": "visible?", "file_path": "capybara/lib/capybara/node/simple.rb", "focal_code": "def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter\n        return false if (tag_name == 'input') && (native[:type] == 'hidden')\n        return false if tag_name == 'template'\n\n        if check_ancestors\n          !find_xpath(VISIBILITY_XPATH)\n        else\n          # No need for an xpath if only checking the current element\n          !(native.key?('hidden') ||\n            /display:\\s?none/.match?(native[:style] || '') ||\n            %w[script head style].include?(tag_name))\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Node\n    ##\n    #\n    # A {Capybara::Node::Simple} is a simpler version of {Capybara::Node::Base} which\n    # includes only {Capybara::Node::Finders} and {Capybara::Node::Matchers} and does\n    # not include {Capybara::Node::Actions}. This type of node is returned when\n    # using {Capybara.string}.\n    #\n    # It is useful in that it does not require a session, an application or a driver,\n    # but can still use Capybara's finders and matchers on any string that contains HTML.\n    #\n    class Simple\n      include Capybara::Node::Finders\n      include Capybara::Node::Matchers\n      include Capybara::Node::DocumentMatchers\n\n      attr_reader :native\n\n      def initialize(native)\n        native = Capybara::HTML(native) if native.is_a?(String)\n        @native = native\n      end\n\n      ##\n      #\n      # @return [String]    The text of the element\n      #\n      def text(_type = nil, normalize_ws: false)\n        txt = native.text\n        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt\n      end\n\n      ##\n      #\n      # Retrieve the given attribute\n      #\n      #     element[:title] # => HTML title attribute\n      #\n      # @param  [Symbol] name  The attribute name to retrieve\n      # @return [String]       The value of the attribute\n      #\n      def [](name)\n        attr_name = name.to_s\n        if attr_name == 'value'\n          value\n        elsif (tag_name == 'input') && (native[:type] == 'checkbox') && (attr_name == 'checked')\n          native['checked'] == 'checked'\n        else\n          native[attr_name]\n        end\n      end\n\n      ##\n      #\n      # @return [String]      The tag name of the element\n      #\n      def tag_name\n        native.node_name\n      end\n\n      ##\n      #\n      # An XPath expression describing where on the page the element can be found\n      #\n      # @return [String]      An XPath expression\n      #\n      def path\n        native.path\n      end\n\n      ##\n      #\n      # @return [String]    The value of the form element\n      #\n      def value\n        if tag_name == 'textarea'\n          native['_capybara_raw_value']\n        elsif tag_name == 'select'\n          selected_options = find_xpath('.//option[@selected]')\n          if multiple?\n            selected_options.map(&method(:option_value))\n          else\n            option_value(selected_options.first || find_xpath('.//option').first)\n          end\n        elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])\n          native[:value] || 'on'\n        else\n          native[:value]\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is visible. Does not support CSS, so\n      # the result may be inaccurate.\n      #\n      # @param  [Boolean] check_ancestors  Whether to inherit visibility from ancestors\n      # @return [Boolean]     Whether the element is visible\n      #\n      def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter\n        return false if (tag_name == 'input') && (native[:type] == 'hidden')\n        return false if tag_name == 'template'\n\n        if check_ancestors\n          !find_xpath(VISIBILITY_XPATH)\n        else\n          # No need for an xpath if only checking the current element\n          !(native.key?('hidden') ||\n            /display:\\s?none/.match?(native[:style] || '') ||\n            %w[script head style].include?(tag_name))\n        end\n      end\n\n      ##\n      #\n      # Whether or not the element is checked.\n      #\n      # @return [Boolean]     Whether the element is checked\n      #\n      def checked?\n        native.has_attribute?('checked')\n      end\n\n      ##\n      #\n      # Whether or not the element is disabled.\n      #\n      # @return [Boolean]     Whether the element is disabled\n      def disabled?\n        native.has_attribute?('disabled') &&\n          %w[button input select textarea optgroup option menuitem fieldset].include?(tag_name)\n      end\n\n      ##\n      #\n      # Whether or not the element is selected.\n      #\n      # @return [Boolean]     Whether the element is selected\n      #\n      def selected?\n        native.has_attribute?('selected')\n      end\n\n      def multiple?\n        native.has_attribute?('multiple')\n      end\n\n      def readonly?\n        native.has_attribute?('readonly')\n      end\n\n      def synchronize(_seconds = nil)\n        yield # simple nodes don't need to wait\n      end\n\n      def allow_reload!(*)\n        # no op\n      end\n\n      ##\n      #\n      # @return [String]     The title of the document\n      def title\n        native.title\n      end\n\n      def inspect\n        %(#<Capybara::Node::Simple tag=\"#{tag_name}\" path=\"#{path}\">)\n      end\n\n      # @api private\n      def find_css(css, **_options)\n        native.css(css)\n      end\n\n      # @api private\n      def find_xpath(xpath, **_options)\n        native.xpath(xpath)\n      end\n\n      # @api private\n      def session_options\n        Capybara.session_options\n      end\n\n      # @api private\n      def initial_cache\n        {}\n      end\n\n      def ==(other)\n        eql?(other) || (other.respond_to?(:native) && native == other.native)\n      end\n\n    private\n\n      def option_value(option)\n        return nil if option.nil?\n\n        option[:value] || option.content\n      end\n\n      VISIBILITY_XPATH = XPath.generate do |x|\n        x.ancestor_or_self[\n          x.attr(:style)[x.contains('display:none') | x.contains('display: none')] |\n          x.attr(:hidden) |\n          x.qname.one_of('script', 'head') |\n          (~x.self(:summary) & XPath.parent(:details)[!XPath.attr(:open)])\n        ].boolean\n      end.to_s.freeze\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "visible?", "signature": "def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 103, "end_line": 115}, "metadata": {"module": "Capybara", "class_name": "Simple", "class_signature": "class Simple"}, "task_id": 36}
{"function_name": "resolve_for", "file_path": "capybara/lib/capybara/queries/ancestor_query.rb", "focal_code": "def resolve_for(node, exact = nil)\n        @child_node = node\n\n        node.synchronize do\n          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')\n          match_results = super(scope, exact)\n          ancestors = node.find_xpath(XPath.ancestor.to_s)\n                          .map(&method(:to_element))\n                          .select { |el| match_results.include?(el) }\n          Capybara::Result.new(ordered_results(ancestors), self)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Queries\n    class AncestorQuery < Capybara::Queries::SelectorQuery\n      # @api private\n      def resolve_for(node, exact = nil)\n        @child_node = node\n\n        node.synchronize do\n          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')\n          match_results = super(scope, exact)\n          ancestors = node.find_xpath(XPath.ancestor.to_s)\n                          .map(&method(:to_element))\n                          .select { |el| match_results.include?(el) }\n          Capybara::Result.new(ordered_results(ancestors), self)\n        end\n      end\n\n      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        child_query = @child_node&.instance_variable_get(:@query)\n        desc = super\n        desc += \" that is an ancestor of #{child_query.description}\" if child_query\n        desc\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "resolve_for", "signature": "def resolve_for(node, exact = nil)", "start_line": 7, "end_line": 18}, "metadata": {"module": "Capybara", "class_name": "AncestorQuery", "class_signature": "class AncestorQuery < < Capybara::Queries::SelectorQuery"}, "task_id": 37}
{"function_name": "count_message", "file_path": "capybara/lib/capybara/queries/base_query.rb", "focal_code": "def count_message\n        message = +''\n        count, between, maximum, minimum = options.values_at(:count, :between, :maximum, :minimum)\n        if count\n          message << \" #{occurrences count}\"\n        elsif between\n          message << \" between #{between.begin ? between.first : 1} and \" \\\n                     \"#{between.end ? between.last : 'infinite'} times\"\n        elsif maximum\n          message << \" at most #{occurrences maximum}\"\n        elsif minimum\n          message << \" at least #{occurrences minimum}\"\n        end\n        message\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  # @api private\n  module Queries\n    class BaseQuery\n      COUNT_KEYS = %i[count minimum maximum between].freeze\n\n      attr_reader :options\n      attr_writer :session_options\n\n      def initialize(options)\n        @session_options = options.delete(:session_options)\n      end\n\n      def session_options\n        @session_options || Capybara.session_options\n      end\n\n      def wait\n        self.class.wait(options, session_options.default_max_wait_time)\n      end\n\n      def self.wait(options, default = Capybara.default_max_wait_time)\n        # if no value or nil for the :wait option is passed it should default to the default\n        wait = options.fetch(:wait, nil)\n        wait = default if wait.nil?\n        wait || 0\n      end\n\n      ##\n      #\n      # Checks if a count of 0 is valid for the query\n      # Returns false if query does not have any count options specified.\n      #\n      def expects_none?\n        count_specified? ? matches_count?(0) : false\n      end\n\n      ##\n      #\n      # Checks if the given count matches the query count options.\n      # Defaults to true if no count options are specified. If multiple\n      # count options exist, it tests that all conditions are met;\n      # however, if :count is specified, all other options are ignored.\n      #\n      # @param [Integer] count     The actual number. Should be coercible via Integer()\n      #\n      def matches_count?(count)\n        return (Integer(options[:count]) == count) if options[:count]\n        return false if options[:maximum] && (Integer(options[:maximum]) < count)\n        return false if options[:minimum] && (Integer(options[:minimum]) > count)\n        return false if options[:between] && !options[:between].include?(count)\n\n        true\n      end\n\n      ##\n      #\n      # Generates a failure message from the query description and count options.\n      #\n      def failure_message\n        \"expected to find #{description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{description}\" << count_message\n      end\n\n    private\n\n      def count_specified?\n        COUNT_KEYS.any? { |key| options.key? key }\n      end\n\n      def count_message\n        message = +''\n        count, between, maximum, minimum = options.values_at(:count, :between, :maximum, :minimum)\n        if count\n          message << \" #{occurrences count}\"\n        elsif between\n          message << \" between #{between.begin ? between.first : 1} and \" \\\n                     \"#{between.end ? between.last : 'infinite'} times\"\n        elsif maximum\n          message << \" at most #{occurrences maximum}\"\n        elsif minimum\n          message << \" at least #{occurrences minimum}\"\n        end\n        message\n      end\n\n      def occurrences(count)\n        \"#{count} #{Capybara::Helpers.declension('time', 'times', count)}\"\n      end\n\n      def assert_valid_keys\n        invalid_keys = @options.keys - valid_keys\n        return if invalid_keys.empty?\n\n        invalid_names = invalid_keys.map(&:inspect).join(', ')\n        valid_names = valid_keys.map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "count_message", "signature": "def count_message message = +''", "start_line": 76, "end_line": 90}, "metadata": {"module": "Capybara", "class_name": "BaseQuery", "class_signature": "class BaseQuery"}, "task_id": 38}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/queries/current_path_query.rb", "focal_code": "def initialize(expected_path, **options, &optional_filter_block)\n        super(options)\n        @expected_path = expected_path\n        @options = {\n          url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || '').hostname.nil?,\n          ignore_query: false\n        }.merge(options)\n        @filter_block = optional_filter_block\n        assert_valid_keys\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'addressable/uri'\n\nmodule Capybara\n  # @api private\n  module Queries\n    class CurrentPathQuery < BaseQuery\n      def initialize(expected_path, **options, &optional_filter_block)\n        super(options)\n        @expected_path = expected_path\n        @options = {\n          url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || '').hostname.nil?,\n          ignore_query: false\n        }.merge(options)\n        @filter_block = optional_filter_block\n        assert_valid_keys\n      end\n\n      def resolves_for?(session)\n        uri = ::Addressable::URI.parse(session.current_url)\n        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).then do |u|\n          options[:url] ? u&.to_s : u&.request_uri\n        end\n\n        res = if @expected_path.is_a? Regexp\n          @actual_path.to_s.match?(@expected_path)\n        else\n          ::Addressable::URI.parse(@expected_path) == ::Addressable::URI.parse(@actual_path)\n        end\n\n        res && matches_filter_block?(uri)\n      end\n\n      def failure_message\n        failure_message_helper\n      end\n\n      def negative_failure_message\n        failure_message_helper(' not')\n      end\n\n    private\n\n      def matches_filter_block?(url)\n        return true unless @filter_block\n\n        @filter_block.call(url)\n      end\n\n      def failure_message_helper(negated = '')\n        verb = @expected_path.is_a?(Regexp) ? 'match' : 'equal'\n        \"expected #{@actual_path.inspect}#{negated} to #{verb} #{@expected_path.inspect}\"\n      end\n\n      def valid_keys\n        %i[wait url ignore_query]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(expected_path, **options, &optional_filter_block)", "start_line": 9, "end_line": 18}, "metadata": {"module": "Capybara", "class_name": "CurrentPathQuery", "class_signature": "class CurrentPathQuery < < BaseQuery"}, "task_id": 39}
{"function_name": "resolves_for?", "file_path": "capybara/lib/capybara/queries/current_path_query.rb", "focal_code": "def resolves_for?(session)\n        uri = ::Addressable::URI.parse(session.current_url)\n        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).then do |u|\n          options[:url] ? u&.to_s : u&.request_uri\n        end\n\n        res = if @expected_path.is_a? Regexp\n          @actual_path.to_s.match?(@expected_path)\n        else\n          ::Addressable::URI.parse(@expected_path) == ::Addressable::URI.parse(@actual_path)\n        end\n\n        res && matches_filter_block?(uri)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'addressable/uri'\n\nmodule Capybara\n  # @api private\n  module Queries\n    class CurrentPathQuery < BaseQuery\n      def initialize(expected_path, **options, &optional_filter_block)\n        super(options)\n        @expected_path = expected_path\n        @options = {\n          url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || '').hostname.nil?,\n          ignore_query: false\n        }.merge(options)\n        @filter_block = optional_filter_block\n        assert_valid_keys\n      end\n\n      def resolves_for?(session)\n        uri = ::Addressable::URI.parse(session.current_url)\n        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).then do |u|\n          options[:url] ? u&.to_s : u&.request_uri\n        end\n\n        res = if @expected_path.is_a? Regexp\n          @actual_path.to_s.match?(@expected_path)\n        else\n          ::Addressable::URI.parse(@expected_path) == ::Addressable::URI.parse(@actual_path)\n        end\n\n        res && matches_filter_block?(uri)\n      end\n\n      def failure_message\n        failure_message_helper\n      end\n\n      def negative_failure_message\n        failure_message_helper(' not')\n      end\n\n    private\n\n      def matches_filter_block?(url)\n        return true unless @filter_block\n\n        @filter_block.call(url)\n      end\n\n      def failure_message_helper(negated = '')\n        verb = @expected_path.is_a?(Regexp) ? 'match' : 'equal'\n        \"expected #{@actual_path.inspect}#{negated} to #{verb} #{@expected_path.inspect}\"\n      end\n\n      def valid_keys\n        %i[wait url ignore_query]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "resolves_for?", "signature": "def resolves_for?(session)", "start_line": 20, "end_line": 33}, "metadata": {"module": "Capybara", "class_name": "CurrentPathQuery", "class_signature": "class CurrentPathQuery < < BaseQuery"}, "task_id": 40}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(*args, session_options:, enable_aria_label: session_options.enable_aria_label, enable_aria_role: session_options.enable_aria_role, test_id: session_options.test_id, selector_format: nil, order: nil, **options, &filter_block)", "start_line": 15, "end_line": 59}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 41}
{"function_name": "description", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "description", "signature": "def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 64, "end_line": 112}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 42}
{"function_name": "matches_filters?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_filters?", "signature": "def matches_filters?(node, node_filter_errors = [])", "start_line": 118, "end_line": 128}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 43}
{"function_name": "resolve_for", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "resolve_for", "signature": "def resolve_for(node, exact = nil)", "start_line": 160, "end_line": 170}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 44}
{"function_name": "xpath_text_conditions", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "xpath_text_conditions", "signature": "def xpath_text_conditions case (text = matching_text)", "start_line": 201, "end_line": 212}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 45}
{"function_name": "find_nodes_by_selector_format", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_nodes_by_selector_format", "signature": "def find_nodes_by_selector_format(node, exact)", "start_line": 242, "end_line": 265}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 46}
{"function_name": "matches_node_filters?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_node_filters?", "signature": "def matches_node_filters?(node, errors)", "start_line": 279, "end_line": 302}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 47}
{"function_name": "assert_valid_keys", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "assert_valid_keys", "signature": "def assert_valid_keys unless VALID_MATCH.include?(match)", "start_line": 345, "end_line": 361}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 48}
{"function_name": "apply_expression_filters", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "apply_expression_filters", "signature": "def apply_expression_filters(expression)", "start_line": 391, "end_line": 410}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 49}
{"function_name": "matches_system_filters?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_system_filters?", "signature": "def matches_system_filters?(node)", "start_line": 444, "end_line": 454}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 50}
{"function_name": "matches_spatial_filters?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_spatial_filters?", "signature": "def matches_spatial_filters?(node)", "start_line": 456, "end_line": 490}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 51}
{"function_name": "matches_class_filter?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_class_filter?", "signature": "def matches_class_filter?(node)", "start_line": 498, "end_line": 509}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 52}
{"function_name": "matches_style_filter?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_style_filter?", "signature": "def matches_style_filter?(node)", "start_line": 526, "end_line": 535}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 53}
{"function_name": "matches_style?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_style?", "signature": "def matches_style?(node, styles)", "start_line": 537, "end_line": 546}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 54}
{"function_name": "matches_visibility_filters?", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches_visibility_filters?", "signature": "def matches_visibility_filters?(node)", "start_line": 566, "end_line": 589}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 55}
{"function_name": "distance", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "distance", "signature": "def distance(other)", "start_line": 638, "end_line": 651}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 56}
{"function_name": "distance_segment_segment", "file_path": "capybara/lib/capybara/queries/selector_query.rb", "focal_code": "def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'matrix'\n\nmodule Capybara\n  module Queries\n    class SelectorQuery < Queries::BaseQuery\n      attr_reader :expression, :selector, :locator, :options\n\n      SPATIAL_KEYS = %i[above below left_of right_of near].freeze\n      VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +\n                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]\n      VALID_MATCH = %i[first smart prefer_exact one].freeze\n\n      def initialize(*args,\n                     session_options:,\n                     enable_aria_label: session_options.enable_aria_label,\n                     enable_aria_role: session_options.enable_aria_role,\n                     test_id: session_options.test_id,\n                     selector_format: nil,\n                     order: nil,\n                     **options,\n                     &filter_block)\n        @resolved_node = nil\n        @resolved_count = 0\n        @options = options.dup\n        @order = order\n        @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }\n\n        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])\n          Capybara::Helpers.warn(\n            \"Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring\"\n          )\n        end\n\n        super(@options)\n        self.session_options = session_options\n\n        @selector = Selector.new(\n          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),\n          config: {\n            enable_aria_label: enable_aria_label,\n            enable_aria_role: enable_aria_role,\n            test_id: test_id\n          },\n          format: selector_format\n        )\n\n        @locator = args.shift\n        @filter_block = filter_block\n\n        raise ArgumentError, \"Unused parameters passed to #{self.class.name} : #{args}\" unless args.empty?\n\n        @expression = selector.call(@locator, **@options)\n\n        warn_exact_usage\n\n        assert_valid_keys\n      end\n\n      def name; selector.name; end\n      def label; selector.label || selector.name; end\n\n      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = +''\n        show_for = show_for_stage(only_applied)\n\n        if show_for[:any]\n          desc << 'visible ' if visible == :visible\n          desc << 'non-visible ' if visible == :hidden\n        end\n\n        desc << label.to_s\n        desc << \" #{locator.inspect}\" unless locator.nil?\n\n        if show_for[:any]\n          desc << \" with#{' exact' if exact_text == true} text #{options[:text].inspect}\" if options[:text]\n          desc << \" with exact text #{exact_text}\" if exact_text.is_a?(String)\n        end\n\n        desc << \" with id #{options[:id]}\" if options[:id]\n        desc << \" with classes [#{Array(options[:class]).join(',')}]\" if options[:class]\n        desc << ' that is focused' if options[:focused]\n        desc << ' that is not focused' if options[:focused] == false\n\n        desc << case options[:style]\n        when String\n          \" with style attribute #{options[:style].inspect}\"\n        when Regexp\n          \" with style attribute matching #{options[:style].inspect}\"\n        when Hash\n          \" with styles #{options[:style].inspect}\"\n        else ''\n        end\n\n        %i[above below left_of right_of near].each do |spatial_filter|\n          if options[spatial_filter] && show_for[:spatial]\n            desc << \" #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}\" # rubocop:disable Style/RescueModifier\n          end\n        end\n\n        desc << selector.description(node_filters: show_for[:node], **options)\n\n        desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]\n\n        desc << \" within #{@resolved_node.inspect}\" if describe_within?\n        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?\n          desc << \"\\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. \" \\\n                  \"Please see the documentation for acceptable locator values.\\n\\n\"\n        end\n        desc\n      end\n\n      def applied_description\n        description(true)\n      end\n\n      def matches_filters?(node, node_filter_errors = [])\n        return true if (@resolved_node&.== node) && options[:allow_self]\n\n        matches_locator_filter?(node) &&\n          matches_system_filters?(node) &&\n          matches_spatial_filters?(node) &&\n          matches_node_filters?(node, node_filter_errors) &&\n          matches_filter_block?(node)\n      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])\n        false\n      end\n\n      def visible\n        case (vis = options.fetch(:visible) { default_visibility })\n        when true then :visible\n        when false then :all\n        else vis\n        end\n      end\n\n      def exact?\n        supports_exact? ? options.fetch(:exact, session_options.exact) : false\n      end\n\n      def match\n        options.fetch(:match, session_options.match)\n      end\n\n      def xpath(exact = nil)\n        exact = exact? if exact.nil?\n        expr = apply_expression_filters(@expression)\n        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)\n        expr = filtered_expression(expr)\n        expr = \"(#{expr})[#{xpath_text_conditions}]\" if try_text_match_in_expression?\n        expr\n      end\n\n      def css\n        filtered_expression(apply_expression_filters(@expression))\n      end\n\n      # @api private\n      def resolve_for(node, exact = nil)\n        applied_filters.clear\n        @filter_cache.clear\n        @resolved_node = node\n        @resolved_count += 1\n\n        node.synchronize do\n          children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))\n          Capybara::Result.new(ordered_results(children), self)\n        end\n      end\n\n      # @api private\n      def supports_exact?\n        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?\n\n        @selector.supports_exact?\n      end\n\n      def failure_message\n        \"expected to find #{applied_description}\" << count_message\n      end\n\n      def negative_failure_message\n        \"expected not to find #{applied_description}\" << count_message\n      end\n\n    private\n\n      def selector_format\n        @selector.format\n      end\n\n      def matching_text\n        options[:text] || options[:exact_text]\n      end\n\n      def text_fragments\n        (text = matching_text).is_a?(String) ? text.split : []\n      end\n\n      def xpath_text_conditions\n        case (text = matching_text)\n        when String\n          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)\n        when Regexp\n          condition = XPath.current\n          condition = condition.uppercase if text.casefold?\n          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|\n            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)\n          end.reduce(:|)\n        end\n      end\n\n      def try_text_match_in_expression?\n        first_try? &&\n          matching_text &&\n          @resolved_node.is_a?(Capybara::Node::Base) &&\n          @resolved_node.session&.driver&.wait?\n      end\n\n      def first_try?\n        @resolved_count == 1\n      end\n\n      def show_for_stage(only_applied)\n        lambda do |stage = :any|\n          !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))\n        end\n      end\n\n      def applied_filters\n        @applied_filters ||= []\n      end\n\n      def find_selector(locator)\n        case locator\n        when Symbol then Selector[locator]\n        else Selector.for(locator)\n        end || Selector[session_options.default_selector]\n      end\n\n      def find_nodes_by_selector_format(node, exact)\n        hints = {}\n        hints[:uses_visibility] = true unless visible == :all\n        hints[:texts] = text_fragments unless selector_format == :xpath\n        hints[:styles] = options[:style] if use_default_style_filter?\n        hints[:position] = true if use_spatial_filter?\n\n        case selector_format\n        when :css\n          if node.method(:find_css).arity == 1\n            node.find_css(css)\n          else\n            node.find_css(css, **hints)\n          end\n        when :xpath\n          if node.method(:find_xpath).arity == 1\n            node.find_xpath(xpath(exact))\n          else\n            node.find_xpath(xpath(exact), **hints)\n          end\n        else\n          raise ArgumentError, \"Unknown format: #{selector_format}\"\n        end\n      end\n\n      def to_element(node)\n        if @resolved_node.is_a?(Capybara::Node::Base)\n          Capybara::Node::Element.new(@resolved_node.session, node, @resolved_node, self)\n        else\n          Capybara::Node::Simple.new(node)\n        end\n      end\n\n      def valid_keys\n        (VALID_KEYS + custom_keys).uniq\n      end\n\n      def matches_node_filters?(node, errors)\n        applied_filters << :node\n\n        unapplied_options = options.keys - valid_keys\n        @selector.with_filter_errors(errors) do\n          node_filters.all? do |filter_name, filter|\n            next true unless apply_filter?(filter)\n\n            if filter.matcher?\n              unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|\n                unapplied_options.delete(option_name)\n                filter.matches?(node, option_name, options[option_name], @selector)\n              end\n            elsif options.key?(filter_name)\n              unapplied_options.delete(filter_name)\n              filter.matches?(node, filter_name, options[filter_name], @selector)\n            elsif filter.default?\n              filter.matches?(node, filter_name, filter.default, @selector)\n            else\n              true\n            end\n          end\n        end\n      end\n\n      def matches_filter_block?(node)\n        return true unless @filter_block\n\n        if node.respond_to?(:session)\n          node.session.using_wait_time(0) { @filter_block.call(node) }\n        else\n          @filter_block.call(node)\n        end\n      end\n\n      def filter_set(name)\n        ::Capybara::Selector::FilterSet[name]\n      end\n\n      def node_filters\n        if options.key?(:filter_set)\n          filter_set(options[:filter_set])\n        else\n          @selector\n        end.node_filters\n      end\n\n      def expression_filters\n        filters = @selector.expression_filters\n        filters.merge filter_set(options[:filter_set]).expression_filters if options.key?(:filter_set)\n        filters\n      end\n\n      def ordered_results(results)\n        case @order\n        when :reverse\n          results.reverse\n        else\n          results\n        end\n      end\n\n      def custom_keys\n        @custom_keys ||= node_filters.keys + expression_filters.keys\n      end\n\n      def assert_valid_keys\n        unless VALID_MATCH.include?(match)\n          raise ArgumentError, \"Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}\"\n        end\n\n        unhandled_options = @options.keys.reject do |option_name|\n          valid_keys.include?(option_name) ||\n            expression_filters.any? { |_name, ef| ef.handles_option? option_name } ||\n            node_filters.any? { |_name, nf| nf.handles_option? option_name }\n        end\n\n        return if unhandled_options.empty?\n\n        invalid_names = unhandled_options.map(&:inspect).join(', ')\n        valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')\n        raise ArgumentError, \"Invalid option(s) #{invalid_names}, should be one of #{valid_names}\"\n      end\n\n      def filtered_expression(expr)\n        conditions = {}\n        conditions[:id] = options[:id] if use_default_id_filter?\n        conditions[:class] = options[:class] if use_default_class_filter?\n        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)\n        builder(expr).add_attribute_conditions(**conditions)\n      end\n\n      def use_default_id_filter?\n        options.key?(:id) && !custom_keys.include?(:id)\n      end\n\n      def use_default_class_filter?\n        options.key?(:class) && !custom_keys.include?(:class)\n      end\n\n      def use_default_style_filter?\n        options.key?(:style) && !custom_keys.include?(:style)\n      end\n\n      def use_default_focused_filter?\n        options.key?(:focused) && !custom_keys.include?(:focused)\n      end\n\n      def use_spatial_filter?\n        options.values_at(*SPATIAL_KEYS).compact.any?\n      end\n\n      def apply_expression_filters(expression)\n        unapplied_options = options.keys - valid_keys\n        expression_filters.inject(expression) do |expr, (name, ef)|\n          next expr unless apply_filter?(ef)\n\n          if ef.matcher?\n            unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|\n              unapplied_options.delete(option_name)\n              ef.apply_filter(memo, option_name, options[option_name], @selector)\n            end\n          elsif options.key?(name)\n            unapplied_options.delete(name)\n            ef.apply_filter(expr, name, options[name], @selector)\n          elsif ef.default?\n            ef.apply_filter(expr, name, ef.default, @selector)\n          else\n            expr\n          end\n        end\n      end\n\n      def warn_exact_usage\n        return unless options.key?(:exact) && !supports_exact?\n\n        warn \"The :exact option only has an effect on queries using the XPath#is method. Using it with the query \\\"#{expression}\\\" has no effect.\"\n      end\n\n      def exact_text\n        options.fetch(:exact_text, session_options.exact_text)\n      end\n\n      def describe_within?\n        @resolved_node && !document?(@resolved_node) && !simple_root?(@resolved_node)\n      end\n\n      def document?(node)\n        node.is_a?(::Capybara::Node::Document)\n      end\n\n      def simple_root?(node)\n        node.is_a?(::Capybara::Node::Simple) && node.path == '/'\n      end\n\n      def apply_filter?(filter)\n        filter.format.nil? || (filter.format == selector_format)\n      end\n\n      def matches_locator_filter?(node)\n        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)\n\n        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)\n      end\n\n      def matches_system_filters?(node)\n        applied_filters << :system\n\n        matches_visibility_filters?(node) &&\n          matches_id_filter?(node) &&\n          matches_class_filter?(node) &&\n          matches_style_filter?(node) &&\n          matches_focused_filter?(node) &&\n          matches_text_filter?(node) &&\n          matches_exact_text_filter?(node)\n      end\n\n      def matches_spatial_filters?(node)\n        applied_filters << :spatial\n        return true unless use_spatial_filter?\n\n        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)\n\n        if options[:above]\n          el_rect = rect_cache(options[:above])\n          return false unless node_rect.above? el_rect\n        end\n\n        if options[:below]\n          el_rect = rect_cache(options[:below])\n          return false unless node_rect.below? el_rect\n        end\n\n        if options[:left_of]\n          el_rect = rect_cache(options[:left_of])\n          return false unless node_rect.left_of? el_rect\n        end\n\n        if options[:right_of]\n          el_rect = rect_cache(options[:right_of])\n          return false unless node_rect.right_of? el_rect\n        end\n\n        if options[:near]\n          return false if node == options[:near]\n\n          el_rect = rect_cache(options[:near])\n          return false unless node_rect.near? el_rect\n        end\n\n        true\n      end\n\n      def matches_id_filter?(node)\n        return true unless use_default_id_filter? && options[:id].is_a?(Regexp)\n\n        options[:id].match? node[:id]\n      end\n\n      def matches_class_filter?(node)\n        return true unless use_default_class_filter? && need_to_process_classes?\n\n        if options[:class].is_a? Regexp\n          options[:class].match? node[:class]\n        else\n          classes = (node[:class] || '').split\n          options[:class].select { |c| c.is_a? Regexp }.all? do |r|\n            classes.any? { |cls| r.match? cls }\n          end\n        end\n      end\n\n      def matches_focused_filter?(node)\n        return true unless use_default_focused_filter?\n\n        (node == node.session.active_element) == options[:focused]\n      end\n\n      def need_to_process_classes?\n        case options[:class]\n        when Regexp then true\n        when Array then options[:class].any?(Regexp)\n        else\n          false\n        end\n      end\n\n      def matches_style_filter?(node)\n        case options[:style]\n        when String, nil\n          true\n        when Regexp\n          options[:style].match? node[:style]\n        when Hash\n          matches_style?(node, options[:style])\n        end\n      end\n\n      def matches_style?(node, styles)\n        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)\n        styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style.to_s]\n          else\n            @actual_styles[style.to_s] == value\n          end\n        end\n      end\n\n      def matches_text_filter?(node)\n        value = options[:text]\n        return true unless value\n        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)\n\n        regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)\n        matches_text_regexp?(node, regexp)\n      end\n\n      def matches_exact_text_filter?(node)\n        case exact_text\n        when String, Regexp\n          matches_text_exactly?(node, exact_text)\n        else\n          true\n        end\n      end\n\n      def matches_visibility_filters?(node)\n        obscured = options[:obscured]\n        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false\n\n        vis = case visible\n        when :visible\n          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)\n        when :hidden\n          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test\n          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)\n          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)\n        else\n          true\n        end\n\n        vis && case obscured\n               when true\n                 node.obscured?\n               when false\n                 !node.obscured?\n               else\n                 true\n               end\n      end\n\n      def matches_text_exactly?(node, value)\n        regexp = value.is_a?(Regexp) ? value : /\\A#{Regexp.escape(value.to_s)}\\z/\n        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }\n      end\n\n      def normalize_ws\n        options.fetch(:normalize_ws, session_options.default_normalize_ws)\n      end\n\n      def matches_text_regexp(node, regexp)\n        text_visible = visible\n        text_visible = :all if text_visible == :hidden\n        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)\n      end\n\n      def matches_text_regexp?(node, regexp)\n        !matches_text_regexp(node, regexp).nil?\n      end\n\n      def default_visibility\n        @selector.default_visibility(session_options.ignore_hidden_elements, options)\n      end\n\n      def builder(expr)\n        selector.builder(expr)\n      end\n\n      def position_cache(key)\n        @filter_cache[key][:position] ||= key.rect\n      end\n\n      def rect_cache(key)\n        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))\n      end\n\n      class Rectangle\n        attr_reader :top, :bottom, :left, :right\n\n        def initialize(position)\n          # rubocop:disable Style/RescueModifier\n          @top = position['top'] rescue position['y']\n          @bottom = position['bottom'] rescue (@top + position['height'])\n          @left = position['left'] rescue position['x']\n          @right = position['right'] rescue (@left + position['width'])\n          # rubocop:enable Style/RescueModifier\n        end\n\n        def distance(other)\n          distance = Float::INFINITY\n\n          line_segments.each do |ls1|\n            other.line_segments.each do |ls2|\n              distance = [\n                distance,\n                distance_segment_segment(*ls1, *ls2)\n              ].min\n            end\n          end\n\n          distance\n        end\n\n        def above?(other)\n          bottom <= other.top\n        end\n\n        def below?(other)\n          top >= other.bottom\n        end\n\n        def left_of?(other)\n          right <= other.left\n        end\n\n        def right_of?(other)\n          left >= other.right\n        end\n\n        def near?(other)\n          distance(other) <= 50\n        end\n\n      protected\n\n        def line_segments\n          [\n            [Vector[top, left], Vector[top, right]],\n            [Vector[top, right], Vector[bottom, left]],\n            [Vector[bottom, left], Vector[bottom, right]],\n            [Vector[bottom, right], Vector[top, left]]\n          ]\n        end\n\n      private\n\n        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)\n          # See http://geomalgorithms.com/a07-_distance.html\n          # rubocop:disable Naming/VariableName\n          u = l1p2 - l1p1\n          v = l2p2 - l2p1\n          w = l1p1 - l2p1\n\n          a = u.dot u\n          b = u.dot v\n          c = v.dot v\n\n          d = u.dot w\n          e = v.dot w\n          cap_d = (a * c) - (b**2)\n          sD = tD = cap_d\n\n          # compute the line parameters of the two closest points\n          if cap_d < Float::EPSILON # the lines are almost parallel\n            sN = 0.0 # force using point P0 on segment S1\n            sD = 1.0 # to prevent possible division by 0.0 later\n            tN = e\n            tD = c\n          else # get the closest points on the infinite lines\n            sN = (b * e) - (c * d)\n            tN = (a * e) - (b * d)\n            if sN.negative? # sc < 0 => the s=0 edge is visible\n              sN = 0\n              tN = e\n              tD = c\n            elsif sN > sD # sc > 1 => the s=1 edge is visible\n              sN = sD\n              tN = e + b\n              tD = c\n            end\n          end\n\n          if tN.negative? # tc < 0 => the t=0 edge is visible\n            tN = 0\n            # recompute sc for this edge\n            if (-d).negative?\n              sN = 0.0\n            elsif -d > a\n              sN = sD\n            else\n              sN = -d\n              sD = a\n            end\n          elsif tN > tD # tc > 1 => the t=1 edge is visible\n            tN = tD\n            # recompute sc for this edge\n            if (-d + b).negative?\n              sN = 0.0\n            elsif (-d + b) > a\n              sN = sD\n            else\n              sN = (-d + b)\n              sD = a\n            end\n          end\n\n          # finally do the division to get sc and tc\n          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD\n          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD\n\n          # difference of the two closest points\n          dP = w + (u * sc) - (v * tc)\n\n          Math.sqrt(dP.dot(dP))\n          # rubocop:enable Naming/VariableName\n        end\n      end\n\n      private_constant :Rectangle\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "distance_segment_segment", "signature": "def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)", "start_line": 686, "end_line": 755}, "metadata": {"module": "Capybara", "class_name": "SelectorQuery", "class_signature": "class SelectorQuery < < Queries::BaseQuery"}, "task_id": 57}
{"function_name": "resolve_for", "file_path": "capybara/lib/capybara/queries/sibling_query.rb", "focal_code": "def resolve_for(node, exact = nil)\n        @sibling_node = node\n        node.synchronize do\n          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')\n          match_results = super(scope, exact)\n          siblings = node.find_xpath((XPath.preceding_sibling + XPath.following_sibling).to_s)\n                         .map(&method(:to_element))\n                         .select { |el| match_results.include?(el) }\n          Capybara::Result.new(ordered_results(siblings), self)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Queries\n    class SiblingQuery < SelectorQuery\n      # @api private\n      def resolve_for(node, exact = nil)\n        @sibling_node = node\n        node.synchronize do\n          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')\n          match_results = super(scope, exact)\n          siblings = node.find_xpath((XPath.preceding_sibling + XPath.following_sibling).to_s)\n                         .map(&method(:to_element))\n                         .select { |el| match_results.include?(el) }\n          Capybara::Result.new(ordered_results(siblings), self)\n        end\n      end\n\n      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter\n        desc = super\n        sibling_query = @sibling_node&.instance_variable_get(:@query)\n        desc += \" that is a sibling of #{sibling_query.description}\" if sibling_query\n        desc\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "resolve_for", "signature": "def resolve_for(node, exact = nil)", "start_line": 7, "end_line": 17}, "metadata": {"module": "Capybara", "class_name": "SiblingQuery", "class_signature": "class SiblingQuery < < SelectorQuery"}, "task_id": 58}
{"function_name": "resolves_for?", "file_path": "capybara/lib/capybara/queries/style_query.rb", "focal_code": "def resolves_for?(node)\n        @node = node\n        @actual_styles = node.style(*@expected_styles.keys)\n        @expected_styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style]\n          else\n            @actual_styles[style] == value\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  # @api private\n  module Queries\n    class StyleQuery < BaseQuery\n      def initialize(expected_styles, session_options:, **options)\n        @expected_styles = stringify_keys(expected_styles)\n        @options = options\n        @actual_styles = {}\n        super(@options)\n        self.session_options = session_options\n\n        assert_valid_keys\n      end\n\n      def resolves_for?(node)\n        @node = node\n        @actual_styles = node.style(*@expected_styles.keys)\n        @expected_styles.all? do |style, value|\n          if value.is_a? Regexp\n            value.match? @actual_styles[style]\n          else\n            @actual_styles[style] == value\n          end\n        end\n      end\n\n      def failure_message\n        \"Expected node to have styles #{@expected_styles.inspect}. \" \\\n          \"Actual styles were #{@actual_styles.inspect}\"\n      end\n\n    private\n\n      def stringify_keys(hsh)\n        hsh.transform_keys(&:to_s)\n      end\n\n      def valid_keys\n        %i[wait]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "resolves_for?", "signature": "def resolves_for?(node)", "start_line": 17, "end_line": 27}, "metadata": {"module": "Capybara", "class_name": "StyleQuery", "class_signature": "class StyleQuery < < BaseQuery"}, "task_id": 59}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/queries/text_query.rb", "focal_code": "def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments\n        @type = type.nil? ? default_type : type\n        raise ArgumentError, \"#{@type} is not a valid type for a text query\" unless valid_types.include?(@type)\n\n        @options = options\n        super(@options)\n        self.session_options = session_options\n\n        if expected_text.nil? && !exact?\n          warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. ' \\\n               \"Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}\"\n        end\n\n        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s\n\n        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)\n\n        assert_valid_keys\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  # @api private\n  module Queries\n    class TextQuery < BaseQuery\n      def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments\n        @type = type.nil? ? default_type : type\n        raise ArgumentError, \"#{@type} is not a valid type for a text query\" unless valid_types.include?(@type)\n\n        @options = options\n        super(@options)\n        self.session_options = session_options\n\n        if expected_text.nil? && !exact?\n          warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. ' \\\n               \"Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}\"\n        end\n\n        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s\n\n        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)\n\n        assert_valid_keys\n      end\n\n      def resolve_for(node)\n        @node = node\n        @actual_text = text\n        @count = @actual_text.scan(@search_regexp).size\n      end\n\n      def failure_message\n        super << build_message(true)\n      end\n\n      def negative_failure_message\n        super << build_message(false)\n      end\n\n      def description\n        if @expected_text.is_a?(Regexp)\n          \"text matching #{@expected_text.inspect}\"\n        else\n          \"#{'exact ' if exact?}text #{@expected_text.inspect}\"\n        end\n      end\n\n    private\n\n      def exact?\n        options.fetch(:exact, session_options.exact_text)\n      end\n\n      def build_message(report_on_invisible)\n        message = +''\n        unless (COUNT_KEYS & @options.keys).empty?\n          message << \" but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}\"\n        end\n        message << \" in #{@actual_text.inspect}\"\n\n        details_message = []\n        details_message << case_insensitive_message if @node && check_case_insensitive?\n        details_message << invisible_message if @node && check_visible_text? && report_on_invisible\n        details_message.compact!\n\n        message << \". (However, #{details_message.join(' and ')}.)\" unless details_message.empty?\n        message\n      end\n\n      def case_insensitive_message\n        insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, options: Regexp::IGNORECASE)\n        insensitive_count = @actual_text.scan(insensitive_regexp).size\n        return if insensitive_count == @count\n\n        \"it was found #{occurrences insensitive_count} using a case insensitive search\"\n      end\n\n      def invisible_message\n        invisible_text = text(query_type: :all)\n        invisible_count = invisible_text.scan(@search_regexp).size\n        return if invisible_count == @count\n\n        \"it was found #{occurrences invisible_count} including non-visible text\"\n      rescue StandardError\n        # An error getting the non-visible text (if element goes out of scope) should not affect the response\n        nil\n      end\n\n      def valid_keys\n        COUNT_KEYS + %i[wait exact normalize_ws]\n      end\n\n      def valid_types\n        %i[all visible]\n      end\n\n      def check_visible_text?\n        @type == :visible\n      end\n\n      def check_case_insensitive?\n        !@expected_text.is_a?(Regexp)\n      end\n\n      def text(node: @node, query_type: @type)\n        normalize_ws = options.fetch(:normalize_ws, session_options.default_normalize_ws)\n        node.text(query_type, normalize_ws: normalize_ws)\n      end\n\n      def default_type\n        Capybara.ignore_hidden_elements || Capybara.visible_text_only ? :visible : :all\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments", "start_line": 7, "end_line": 25}, "metadata": {"module": "Capybara", "class_name": "TextQuery", "class_signature": "class TextQuery < < BaseQuery"}, "task_id": 60}
{"function_name": "build_message", "file_path": "capybara/lib/capybara/queries/text_query.rb", "focal_code": "def build_message(report_on_invisible)\n        message = +''\n        unless (COUNT_KEYS & @options.keys).empty?\n          message << \" but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}\"\n        end\n        message << \" in #{@actual_text.inspect}\"\n\n        details_message = []\n        details_message << case_insensitive_message if @node && check_case_insensitive?\n        details_message << invisible_message if @node && check_visible_text? && report_on_invisible\n        details_message.compact!\n\n        message << \". (However, #{details_message.join(' and ')}.)\" unless details_message.empty?\n        message\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  # @api private\n  module Queries\n    class TextQuery < BaseQuery\n      def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments\n        @type = type.nil? ? default_type : type\n        raise ArgumentError, \"#{@type} is not a valid type for a text query\" unless valid_types.include?(@type)\n\n        @options = options\n        super(@options)\n        self.session_options = session_options\n\n        if expected_text.nil? && !exact?\n          warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. ' \\\n               \"Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}\"\n        end\n\n        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s\n\n        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)\n\n        assert_valid_keys\n      end\n\n      def resolve_for(node)\n        @node = node\n        @actual_text = text\n        @count = @actual_text.scan(@search_regexp).size\n      end\n\n      def failure_message\n        super << build_message(true)\n      end\n\n      def negative_failure_message\n        super << build_message(false)\n      end\n\n      def description\n        if @expected_text.is_a?(Regexp)\n          \"text matching #{@expected_text.inspect}\"\n        else\n          \"#{'exact ' if exact?}text #{@expected_text.inspect}\"\n        end\n      end\n\n    private\n\n      def exact?\n        options.fetch(:exact, session_options.exact_text)\n      end\n\n      def build_message(report_on_invisible)\n        message = +''\n        unless (COUNT_KEYS & @options.keys).empty?\n          message << \" but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}\"\n        end\n        message << \" in #{@actual_text.inspect}\"\n\n        details_message = []\n        details_message << case_insensitive_message if @node && check_case_insensitive?\n        details_message << invisible_message if @node && check_visible_text? && report_on_invisible\n        details_message.compact!\n\n        message << \". (However, #{details_message.join(' and ')}.)\" unless details_message.empty?\n        message\n      end\n\n      def case_insensitive_message\n        insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, options: Regexp::IGNORECASE)\n        insensitive_count = @actual_text.scan(insensitive_regexp).size\n        return if insensitive_count == @count\n\n        \"it was found #{occurrences insensitive_count} using a case insensitive search\"\n      end\n\n      def invisible_message\n        invisible_text = text(query_type: :all)\n        invisible_count = invisible_text.scan(@search_regexp).size\n        return if invisible_count == @count\n\n        \"it was found #{occurrences invisible_count} including non-visible text\"\n      rescue StandardError\n        # An error getting the non-visible text (if element goes out of scope) should not affect the response\n        nil\n      end\n\n      def valid_keys\n        COUNT_KEYS + %i[wait exact normalize_ws]\n      end\n\n      def valid_types\n        %i[all visible]\n      end\n\n      def check_visible_text?\n        @type == :visible\n      end\n\n      def check_case_insensitive?\n        !@expected_text.is_a?(Regexp)\n      end\n\n      def text(node: @node, query_type: @type)\n        normalize_ws = options.fetch(:normalize_ws, session_options.default_normalize_ws)\n        node.text(query_type, normalize_ws: normalize_ws)\n      end\n\n      def default_type\n        Capybara.ignore_hidden_elements || Capybara.visible_text_only ? :visible : :all\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "build_message", "signature": "def build_message(report_on_invisible)", "start_line": 55, "end_line": 69}, "metadata": {"module": "Capybara", "class_name": "TextQuery", "class_signature": "class TextQuery < < BaseQuery"}, "task_id": 61}
{"function_name": "submit", "file_path": "capybara/lib/capybara/rack_test/browser.rb", "focal_code": "def submit(method, path, attributes, content_type: nil)\n    path = request_path if path.nil? || path.empty?\n    uri = build_uri(path)\n    uri.query = '' if method.to_s.casecmp('get').zero?\n    env = { 'HTTP_REFERER' => referer_url }\n    env['CONTENT_TYPE'] = content_type if content_type\n    process_and_follow_redirects(\n      method,\n      uri.to_s,\n      attributes,\n      env\n    )\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Browser\n  include ::Rack::Test::Methods\n\n  attr_reader :driver\n  attr_accessor :current_host\n\n  def initialize(driver)\n    @driver = driver\n    @current_fragment = nil\n  end\n\n  def app\n    driver.app\n  end\n\n  def options\n    driver.options\n  end\n\n  def visit(path, **attributes)\n    @new_visit_request = true\n    reset_cache!\n    reset_host!\n    process_and_follow_redirects(:get, path, attributes)\n  end\n\n  def refresh\n    reset_cache!\n    request(last_request.fullpath, last_request.env)\n  end\n\n  def submit(method, path, attributes, content_type: nil)\n    path = request_path if path.nil? || path.empty?\n    uri = build_uri(path)\n    uri.query = '' if method.to_s.casecmp('get').zero?\n    env = { 'HTTP_REFERER' => referer_url }\n    env['CONTENT_TYPE'] = content_type if content_type\n    process_and_follow_redirects(\n      method,\n      uri.to_s,\n      attributes,\n      env\n    )\n  end\n\n  def follow(method, path, **attributes)\n    return if fragment_or_script?(path)\n\n    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)\n  end\n\n  def process_and_follow_redirects(method, path, attributes = {}, env = {})\n    @current_fragment = build_uri(path).fragment\n    process(method, path, attributes, env)\n    return unless driver.follow_redirects?\n\n    driver.redirect_limit.times do\n      if last_response.redirect?\n        if [307, 308].include? last_response.status\n          process(last_request.request_method, last_response['Location'], last_request.params, env)\n        else\n          process(:get, last_response['Location'], {}, env)\n        end\n      end\n    end\n\n    if last_response.redirect? # rubocop:disable Style/GuardClause\n      raise Capybara::InfiniteRedirectError, \"redirected more than #{driver.redirect_limit} times, check for infinite redirects.\"\n    end\n  end\n\n  def process(method, path, attributes = {}, env = {})\n    method = method.downcase\n    new_uri = build_uri(path)\n    @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)\n    @current_fragment = new_uri.fragment || @current_fragment\n    reset_cache!\n    @new_visit_request = false\n    send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))\n  end\n\n  def build_uri(path)\n    uri = URI.parse(path)\n    base_uri = base_relative_uri_for(uri)\n\n    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')\n\n    if base_uri.absolute?\n      base_uri.merge(uri)\n    else\n      uri.scheme ||= @current_scheme\n      uri.host ||= @current_host\n      uri.port ||= @current_port unless uri.default_port == @current_port\n      uri\n    end\n  end\n\n  def current_url\n    uri = build_uri(last_request.url)\n    uri.fragment = @current_fragment if @current_fragment\n    uri.to_s\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def reset_host!\n    uri = URI.parse(driver.session_options.app_host || driver.session_options.default_host)\n    @current_scheme, @current_host, @current_port = uri.select(:scheme, :host, :port)\n  end\n\n  def reset_cache!\n    @dom = nil\n  end\n\n  def dom\n    @dom ||= Capybara::HTML(html)\n  end\n\n  def find(format, selector)\n    if format == :css\n      dom.css(selector, Capybara::RackTest::CSSHandlers.new)\n    else\n      dom.xpath(selector)\n    end.map { |node| Capybara::RackTest::Node.new(self, node) }\n  end\n\n  def html\n    last_response.body\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def title\n    dom.title\n  end\n\n  def last_request\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\n  def last_response\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\nprotected\n\n  def base_href\n    find(:css, 'head > base').first&.[](:href).to_s\n  end\n\n  def base_relative_uri_for(uri)\n    base_uri = URI.parse(base_href)\n    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|\n      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?\n      c.path = '/' if c.path.empty?\n    end\n\n    if [current_uri, base_uri].any?(&:absolute?)\n      current_uri.merge(base_uri)\n    else\n      base_uri.path = current_uri.path if base_uri.path.empty?\n      base_uri\n    end\n  end\n\n  def build_rack_mock_session\n    reset_host! unless current_host\n    Rack::MockSession.new(app, current_host)\n  end\n\n  def request_path\n    last_request.path\n  rescue Rack::Test::Error\n    '/'\n  end\n\n  def safe_last_request\n    last_request\n  rescue Rack::Test::Error\n    nil\n  end\n\nprivate\n\n  def fragment_or_script?(path)\n    path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')\n  end\n\n  def referer_url\n    build_uri(last_request.url).to_s\n  rescue Rack::Test::Error\n    ''\n  end\nend\n", "language": "Ruby", "function_component": {"name": "submit", "signature": "def submit(method, path, attributes, content_type: nil)", "start_line": 34, "end_line": 46}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Browser", "class_signature": "class Capybara::RackTest::Browser"}, "task_id": 62}
{"function_name": "process_and_follow_redirects", "file_path": "capybara/lib/capybara/rack_test/browser.rb", "focal_code": "def process_and_follow_redirects(method, path, attributes = {}, env = {})\n    @current_fragment = build_uri(path).fragment\n    process(method, path, attributes, env)\n    return unless driver.follow_redirects?\n\n    driver.redirect_limit.times do\n      if last_response.redirect?\n        if [307, 308].include? last_response.status\n          process(last_request.request_method, last_response['Location'], last_request.params, env)\n        else\n          process(:get, last_response['Location'], {}, env)\n        end\n      end\n    end\n\n    if last_response.redirect? # rubocop:disable Style/GuardClause\n      raise Capybara::InfiniteRedirectError, \"redirected more than #{driver.redirect_limit} times, check for infinite redirects.\"\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Browser\n  include ::Rack::Test::Methods\n\n  attr_reader :driver\n  attr_accessor :current_host\n\n  def initialize(driver)\n    @driver = driver\n    @current_fragment = nil\n  end\n\n  def app\n    driver.app\n  end\n\n  def options\n    driver.options\n  end\n\n  def visit(path, **attributes)\n    @new_visit_request = true\n    reset_cache!\n    reset_host!\n    process_and_follow_redirects(:get, path, attributes)\n  end\n\n  def refresh\n    reset_cache!\n    request(last_request.fullpath, last_request.env)\n  end\n\n  def submit(method, path, attributes, content_type: nil)\n    path = request_path if path.nil? || path.empty?\n    uri = build_uri(path)\n    uri.query = '' if method.to_s.casecmp('get').zero?\n    env = { 'HTTP_REFERER' => referer_url }\n    env['CONTENT_TYPE'] = content_type if content_type\n    process_and_follow_redirects(\n      method,\n      uri.to_s,\n      attributes,\n      env\n    )\n  end\n\n  def follow(method, path, **attributes)\n    return if fragment_or_script?(path)\n\n    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)\n  end\n\n  def process_and_follow_redirects(method, path, attributes = {}, env = {})\n    @current_fragment = build_uri(path).fragment\n    process(method, path, attributes, env)\n    return unless driver.follow_redirects?\n\n    driver.redirect_limit.times do\n      if last_response.redirect?\n        if [307, 308].include? last_response.status\n          process(last_request.request_method, last_response['Location'], last_request.params, env)\n        else\n          process(:get, last_response['Location'], {}, env)\n        end\n      end\n    end\n\n    if last_response.redirect? # rubocop:disable Style/GuardClause\n      raise Capybara::InfiniteRedirectError, \"redirected more than #{driver.redirect_limit} times, check for infinite redirects.\"\n    end\n  end\n\n  def process(method, path, attributes = {}, env = {})\n    method = method.downcase\n    new_uri = build_uri(path)\n    @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)\n    @current_fragment = new_uri.fragment || @current_fragment\n    reset_cache!\n    @new_visit_request = false\n    send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))\n  end\n\n  def build_uri(path)\n    uri = URI.parse(path)\n    base_uri = base_relative_uri_for(uri)\n\n    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')\n\n    if base_uri.absolute?\n      base_uri.merge(uri)\n    else\n      uri.scheme ||= @current_scheme\n      uri.host ||= @current_host\n      uri.port ||= @current_port unless uri.default_port == @current_port\n      uri\n    end\n  end\n\n  def current_url\n    uri = build_uri(last_request.url)\n    uri.fragment = @current_fragment if @current_fragment\n    uri.to_s\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def reset_host!\n    uri = URI.parse(driver.session_options.app_host || driver.session_options.default_host)\n    @current_scheme, @current_host, @current_port = uri.select(:scheme, :host, :port)\n  end\n\n  def reset_cache!\n    @dom = nil\n  end\n\n  def dom\n    @dom ||= Capybara::HTML(html)\n  end\n\n  def find(format, selector)\n    if format == :css\n      dom.css(selector, Capybara::RackTest::CSSHandlers.new)\n    else\n      dom.xpath(selector)\n    end.map { |node| Capybara::RackTest::Node.new(self, node) }\n  end\n\n  def html\n    last_response.body\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def title\n    dom.title\n  end\n\n  def last_request\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\n  def last_response\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\nprotected\n\n  def base_href\n    find(:css, 'head > base').first&.[](:href).to_s\n  end\n\n  def base_relative_uri_for(uri)\n    base_uri = URI.parse(base_href)\n    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|\n      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?\n      c.path = '/' if c.path.empty?\n    end\n\n    if [current_uri, base_uri].any?(&:absolute?)\n      current_uri.merge(base_uri)\n    else\n      base_uri.path = current_uri.path if base_uri.path.empty?\n      base_uri\n    end\n  end\n\n  def build_rack_mock_session\n    reset_host! unless current_host\n    Rack::MockSession.new(app, current_host)\n  end\n\n  def request_path\n    last_request.path\n  rescue Rack::Test::Error\n    '/'\n  end\n\n  def safe_last_request\n    last_request\n  rescue Rack::Test::Error\n    nil\n  end\n\nprivate\n\n  def fragment_or_script?(path)\n    path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')\n  end\n\n  def referer_url\n    build_uri(last_request.url).to_s\n  rescue Rack::Test::Error\n    ''\n  end\nend\n", "language": "Ruby", "function_component": {"name": "process_and_follow_redirects", "signature": "def process_and_follow_redirects(method, path, attributes = {}, env = {})", "start_line": 54, "end_line": 72}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Browser", "class_signature": "class Capybara::RackTest::Browser"}, "task_id": 63}
{"function_name": "build_uri", "file_path": "capybara/lib/capybara/rack_test/browser.rb", "focal_code": "def build_uri(path)\n    uri = URI.parse(path)\n    base_uri = base_relative_uri_for(uri)\n\n    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')\n\n    if base_uri.absolute?\n      base_uri.merge(uri)\n    else\n      uri.scheme ||= @current_scheme\n      uri.host ||= @current_host\n      uri.port ||= @current_port unless uri.default_port == @current_port\n      uri\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Browser\n  include ::Rack::Test::Methods\n\n  attr_reader :driver\n  attr_accessor :current_host\n\n  def initialize(driver)\n    @driver = driver\n    @current_fragment = nil\n  end\n\n  def app\n    driver.app\n  end\n\n  def options\n    driver.options\n  end\n\n  def visit(path, **attributes)\n    @new_visit_request = true\n    reset_cache!\n    reset_host!\n    process_and_follow_redirects(:get, path, attributes)\n  end\n\n  def refresh\n    reset_cache!\n    request(last_request.fullpath, last_request.env)\n  end\n\n  def submit(method, path, attributes, content_type: nil)\n    path = request_path if path.nil? || path.empty?\n    uri = build_uri(path)\n    uri.query = '' if method.to_s.casecmp('get').zero?\n    env = { 'HTTP_REFERER' => referer_url }\n    env['CONTENT_TYPE'] = content_type if content_type\n    process_and_follow_redirects(\n      method,\n      uri.to_s,\n      attributes,\n      env\n    )\n  end\n\n  def follow(method, path, **attributes)\n    return if fragment_or_script?(path)\n\n    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)\n  end\n\n  def process_and_follow_redirects(method, path, attributes = {}, env = {})\n    @current_fragment = build_uri(path).fragment\n    process(method, path, attributes, env)\n    return unless driver.follow_redirects?\n\n    driver.redirect_limit.times do\n      if last_response.redirect?\n        if [307, 308].include? last_response.status\n          process(last_request.request_method, last_response['Location'], last_request.params, env)\n        else\n          process(:get, last_response['Location'], {}, env)\n        end\n      end\n    end\n\n    if last_response.redirect? # rubocop:disable Style/GuardClause\n      raise Capybara::InfiniteRedirectError, \"redirected more than #{driver.redirect_limit} times, check for infinite redirects.\"\n    end\n  end\n\n  def process(method, path, attributes = {}, env = {})\n    method = method.downcase\n    new_uri = build_uri(path)\n    @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)\n    @current_fragment = new_uri.fragment || @current_fragment\n    reset_cache!\n    @new_visit_request = false\n    send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))\n  end\n\n  def build_uri(path)\n    uri = URI.parse(path)\n    base_uri = base_relative_uri_for(uri)\n\n    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')\n\n    if base_uri.absolute?\n      base_uri.merge(uri)\n    else\n      uri.scheme ||= @current_scheme\n      uri.host ||= @current_host\n      uri.port ||= @current_port unless uri.default_port == @current_port\n      uri\n    end\n  end\n\n  def current_url\n    uri = build_uri(last_request.url)\n    uri.fragment = @current_fragment if @current_fragment\n    uri.to_s\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def reset_host!\n    uri = URI.parse(driver.session_options.app_host || driver.session_options.default_host)\n    @current_scheme, @current_host, @current_port = uri.select(:scheme, :host, :port)\n  end\n\n  def reset_cache!\n    @dom = nil\n  end\n\n  def dom\n    @dom ||= Capybara::HTML(html)\n  end\n\n  def find(format, selector)\n    if format == :css\n      dom.css(selector, Capybara::RackTest::CSSHandlers.new)\n    else\n      dom.xpath(selector)\n    end.map { |node| Capybara::RackTest::Node.new(self, node) }\n  end\n\n  def html\n    last_response.body\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def title\n    dom.title\n  end\n\n  def last_request\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\n  def last_response\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\nprotected\n\n  def base_href\n    find(:css, 'head > base').first&.[](:href).to_s\n  end\n\n  def base_relative_uri_for(uri)\n    base_uri = URI.parse(base_href)\n    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|\n      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?\n      c.path = '/' if c.path.empty?\n    end\n\n    if [current_uri, base_uri].any?(&:absolute?)\n      current_uri.merge(base_uri)\n    else\n      base_uri.path = current_uri.path if base_uri.path.empty?\n      base_uri\n    end\n  end\n\n  def build_rack_mock_session\n    reset_host! unless current_host\n    Rack::MockSession.new(app, current_host)\n  end\n\n  def request_path\n    last_request.path\n  rescue Rack::Test::Error\n    '/'\n  end\n\n  def safe_last_request\n    last_request\n  rescue Rack::Test::Error\n    nil\n  end\n\nprivate\n\n  def fragment_or_script?(path)\n    path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')\n  end\n\n  def referer_url\n    build_uri(last_request.url).to_s\n  rescue Rack::Test::Error\n    ''\n  end\nend\n", "language": "Ruby", "function_component": {"name": "build_uri", "signature": "def build_uri(path)", "start_line": 84, "end_line": 98}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Browser", "class_signature": "class Capybara::RackTest::Browser"}, "task_id": 64}
{"function_name": "base_relative_uri_for", "file_path": "capybara/lib/capybara/rack_test/browser.rb", "focal_code": "def base_relative_uri_for(uri)\n    base_uri = URI.parse(base_href)\n    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|\n      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?\n      c.path = '/' if c.path.empty?\n    end\n\n    if [current_uri, base_uri].any?(&:absolute?)\n      current_uri.merge(base_uri)\n    else\n      base_uri.path = current_uri.path if base_uri.path.empty?\n      base_uri\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Browser\n  include ::Rack::Test::Methods\n\n  attr_reader :driver\n  attr_accessor :current_host\n\n  def initialize(driver)\n    @driver = driver\n    @current_fragment = nil\n  end\n\n  def app\n    driver.app\n  end\n\n  def options\n    driver.options\n  end\n\n  def visit(path, **attributes)\n    @new_visit_request = true\n    reset_cache!\n    reset_host!\n    process_and_follow_redirects(:get, path, attributes)\n  end\n\n  def refresh\n    reset_cache!\n    request(last_request.fullpath, last_request.env)\n  end\n\n  def submit(method, path, attributes, content_type: nil)\n    path = request_path if path.nil? || path.empty?\n    uri = build_uri(path)\n    uri.query = '' if method.to_s.casecmp('get').zero?\n    env = { 'HTTP_REFERER' => referer_url }\n    env['CONTENT_TYPE'] = content_type if content_type\n    process_and_follow_redirects(\n      method,\n      uri.to_s,\n      attributes,\n      env\n    )\n  end\n\n  def follow(method, path, **attributes)\n    return if fragment_or_script?(path)\n\n    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)\n  end\n\n  def process_and_follow_redirects(method, path, attributes = {}, env = {})\n    @current_fragment = build_uri(path).fragment\n    process(method, path, attributes, env)\n    return unless driver.follow_redirects?\n\n    driver.redirect_limit.times do\n      if last_response.redirect?\n        if [307, 308].include? last_response.status\n          process(last_request.request_method, last_response['Location'], last_request.params, env)\n        else\n          process(:get, last_response['Location'], {}, env)\n        end\n      end\n    end\n\n    if last_response.redirect? # rubocop:disable Style/GuardClause\n      raise Capybara::InfiniteRedirectError, \"redirected more than #{driver.redirect_limit} times, check for infinite redirects.\"\n    end\n  end\n\n  def process(method, path, attributes = {}, env = {})\n    method = method.downcase\n    new_uri = build_uri(path)\n    @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)\n    @current_fragment = new_uri.fragment || @current_fragment\n    reset_cache!\n    @new_visit_request = false\n    send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))\n  end\n\n  def build_uri(path)\n    uri = URI.parse(path)\n    base_uri = base_relative_uri_for(uri)\n\n    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')\n\n    if base_uri.absolute?\n      base_uri.merge(uri)\n    else\n      uri.scheme ||= @current_scheme\n      uri.host ||= @current_host\n      uri.port ||= @current_port unless uri.default_port == @current_port\n      uri\n    end\n  end\n\n  def current_url\n    uri = build_uri(last_request.url)\n    uri.fragment = @current_fragment if @current_fragment\n    uri.to_s\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def reset_host!\n    uri = URI.parse(driver.session_options.app_host || driver.session_options.default_host)\n    @current_scheme, @current_host, @current_port = uri.select(:scheme, :host, :port)\n  end\n\n  def reset_cache!\n    @dom = nil\n  end\n\n  def dom\n    @dom ||= Capybara::HTML(html)\n  end\n\n  def find(format, selector)\n    if format == :css\n      dom.css(selector, Capybara::RackTest::CSSHandlers.new)\n    else\n      dom.xpath(selector)\n    end.map { |node| Capybara::RackTest::Node.new(self, node) }\n  end\n\n  def html\n    last_response.body\n  rescue Rack::Test::Error\n    ''\n  end\n\n  def title\n    dom.title\n  end\n\n  def last_request\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\n  def last_response\n    raise Rack::Test::Error if @new_visit_request\n\n    super\n  end\n\nprotected\n\n  def base_href\n    find(:css, 'head > base').first&.[](:href).to_s\n  end\n\n  def base_relative_uri_for(uri)\n    base_uri = URI.parse(base_href)\n    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|\n      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?\n      c.path = '/' if c.path.empty?\n    end\n\n    if [current_uri, base_uri].any?(&:absolute?)\n      current_uri.merge(base_uri)\n    else\n      base_uri.path = current_uri.path if base_uri.path.empty?\n      base_uri\n    end\n  end\n\n  def build_rack_mock_session\n    reset_host! unless current_host\n    Rack::MockSession.new(app, current_host)\n  end\n\n  def request_path\n    last_request.path\n  rescue Rack::Test::Error\n    '/'\n  end\n\n  def safe_last_request\n    last_request\n  rescue Rack::Test::Error\n    nil\n  end\n\nprivate\n\n  def fragment_or_script?(path)\n    path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')\n  end\n\n  def referer_url\n    build_uri(last_request.url).to_s\n  rescue Rack::Test::Error\n    ''\n  end\nend\n", "language": "Ruby", "function_component": {"name": "base_relative_uri_for", "signature": "def base_relative_uri_for(uri)", "start_line": 157, "end_line": 170}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Browser", "class_signature": "class Capybara::RackTest::Browser"}, "task_id": 65}
{"function_name": "params", "file_path": "capybara/lib/capybara/rack_test/form.rb", "focal_code": "def params(button)\n    form_element_types = %i[input select textarea button]\n    form_elements_xpath = XPath.generate do |xp|\n      xpath = xp.descendant(*form_element_types).where(!xp.attr(:form))\n      xpath += xp.anywhere(*form_element_types).where(xp.attr(:form) == native[:id]) if native[:id]\n      xpath.where(!xp.attr(:disabled))\n    end.to_s\n\n    form_elements = native.xpath(form_elements_xpath).reject { |el| submitter?(el) && (el != button.native) }\n\n    form_params = form_elements.each_with_object({}.compare_by_identity) do |field, params|\n      case field.name\n      when 'input', 'button' then add_input_param(field, params)\n      when 'select' then add_select_param(field, params)\n      when 'textarea' then add_textarea_param(field, params)\n      end\n    end\n\n    form_params.each_with_object(make_params) do |(name, value), params|\n      merge_param!(params, name, value)\n    end.to_params_hash\n\n    # form_elements.each_with_object(make_params) do |field, params|\n    #   case field.name\n    #   when 'input', 'button' then add_input_param(field, params)\n    #   when 'select' then add_select_param(field, params)\n    #   when 'textarea' then add_textarea_param(field, params)\n    #   end\n    # end.to_params_hash\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Form < Capybara::RackTest::Node\n  # This only needs to inherit from Rack::Test::UploadedFile because Rack::Test checks for\n  # the class specifically when determining whether to construct the request as multipart.\n  # That check should be based solely on the form element's 'enctype' attribute value,\n  # which should probably be provided to Rack::Test in its non-GET request methods.\n  class NilUploadedFile < Rack::Test::UploadedFile\n    def initialize # rubocop:disable Lint/MissingSuper\n      @empty_file = Tempfile.new('nil_uploaded_file')\n      @empty_file.close\n    end\n\n    def original_filename; ''; end\n    def content_type; 'application/octet-stream'; end\n    def path; @empty_file.path; end\n    def size; 0; end\n    def read; ''; end\n    def append_to(_); end\n    def set_encoding(_); end # rubocop:disable Naming/AccessorMethodName\n  end\n\n  def params(button)\n    form_element_types = %i[input select textarea button]\n    form_elements_xpath = XPath.generate do |xp|\n      xpath = xp.descendant(*form_element_types).where(!xp.attr(:form))\n      xpath += xp.anywhere(*form_element_types).where(xp.attr(:form) == native[:id]) if native[:id]\n      xpath.where(!xp.attr(:disabled))\n    end.to_s\n\n    form_elements = native.xpath(form_elements_xpath).reject { |el| submitter?(el) && (el != button.native) }\n\n    form_params = form_elements.each_with_object({}.compare_by_identity) do |field, params|\n      case field.name\n      when 'input', 'button' then add_input_param(field, params)\n      when 'select' then add_select_param(field, params)\n      when 'textarea' then add_textarea_param(field, params)\n      end\n    end\n\n    form_params.each_with_object(make_params) do |(name, value), params|\n      merge_param!(params, name, value)\n    end.to_params_hash\n\n    # form_elements.each_with_object(make_params) do |field, params|\n    #   case field.name\n    #   when 'input', 'button' then add_input_param(field, params)\n    #   when 'select' then add_select_param(field, params)\n    #   when 'textarea' then add_textarea_param(field, params)\n    #   end\n    # end.to_params_hash\n  end\n\n  def submit(button)\n    action = button&.[]('formaction') || native['action']\n    method = button&.[]('formmethod') || request_method\n    driver.submit(method, action.to_s, params(button), content_type: native['enctype'])\n  end\n\n  def multipart?\n    self[:enctype] == 'multipart/form-data'\n  end\n\nprivate\n\n  class ParamsHash < Hash\n    def to_params_hash\n      self\n    end\n  end\n\n  def request_method\n    /post/i.match?(self[:method] || '') ? :post : :get\n  end\n\n  def merge_param!(params, key, value)\n    key = key.to_s\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.normalize_params(params, key, value, Rack::Utils.param_depth_limit)\n    else\n      Rack::Utils.normalize_params(params, key, value)\n    end\n  end\n\n  def make_params\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.make_params\n    else\n      ParamsHash.new\n    end\n  end\n\n  def add_input_param(field, params)\n    name, value = field['name'].to_s, field['value'].to_s\n    return if name.empty?\n\n    value = case field['type']\n    when 'radio', 'checkbox'\n      return unless field['checked']\n\n      Capybara::RackTest::Node.new(driver, field).value.to_s\n    when 'file'\n      return if value.empty? && params.keys.include?(name) && Rack::Test::VERSION.to_f >= 2.0 # rubocop:disable Performance/InefficientHashSearch\n\n      if multipart?\n        file_to_upload(value)\n      else\n        File.basename(value)\n      end\n    else\n      value\n    end\n    # merge_param!(params, name, value)\n    params[name] = value\n  end\n\n  def file_to_upload(filename)\n    if filename.empty?\n      NilUploadedFile.new\n    else\n      mime_info = MiniMime.lookup_by_filename(filename)\n      Rack::Test::UploadedFile.new(filename, mime_info&.content_type&.to_s)\n    end\n  end\n\n  def add_select_param(field, params)\n    name = field['name']\n    if field.has_attribute?('multiple')\n      value = field.xpath('.//option[@selected]').map do |option|\n        # merge_param!(params, field['name'], (option['value'] || option.text).to_s)\n        (option['value'] || option.text).to_s\n      end\n      params[name] = value unless value.empty?\n    else\n      option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first\n      # merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option\n      params[name] = (option['value'] || option.text).to_s if option\n    end\n  end\n\n  def add_textarea_param(field, params)\n    # merge_param!(params, field['name'], field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\"))\n    params[field['name']] = field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\")\n  end\n\n  def submitter?(el)\n    (%w[submit image].include? el['type']) || (el.name == 'button')\n  end\nend\n", "language": "Ruby", "function_component": {"name": "params", "signature": "def params(button)", "start_line": 23, "end_line": 52}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Form", "class_signature": "class Capybara::RackTest::Form < < Capybara::RackTest::Node"}, "task_id": 66}
{"function_name": "add_input_param", "file_path": "capybara/lib/capybara/rack_test/form.rb", "focal_code": "def add_input_param(field, params)\n    name, value = field['name'].to_s, field['value'].to_s\n    return if name.empty?\n\n    value = case field['type']\n    when 'radio', 'checkbox'\n      return unless field['checked']\n\n      Capybara::RackTest::Node.new(driver, field).value.to_s\n    when 'file'\n      return if value.empty? && params.keys.include?(name) && Rack::Test::VERSION.to_f >= 2.0 # rubocop:disable Performance/InefficientHashSearch\n\n      if multipart?\n        file_to_upload(value)\n      else\n        File.basename(value)\n      end\n    else\n      value\n    end\n    # merge_param!(params, name, value)\n    params[name] = value\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Form < Capybara::RackTest::Node\n  # This only needs to inherit from Rack::Test::UploadedFile because Rack::Test checks for\n  # the class specifically when determining whether to construct the request as multipart.\n  # That check should be based solely on the form element's 'enctype' attribute value,\n  # which should probably be provided to Rack::Test in its non-GET request methods.\n  class NilUploadedFile < Rack::Test::UploadedFile\n    def initialize # rubocop:disable Lint/MissingSuper\n      @empty_file = Tempfile.new('nil_uploaded_file')\n      @empty_file.close\n    end\n\n    def original_filename; ''; end\n    def content_type; 'application/octet-stream'; end\n    def path; @empty_file.path; end\n    def size; 0; end\n    def read; ''; end\n    def append_to(_); end\n    def set_encoding(_); end # rubocop:disable Naming/AccessorMethodName\n  end\n\n  def params(button)\n    form_element_types = %i[input select textarea button]\n    form_elements_xpath = XPath.generate do |xp|\n      xpath = xp.descendant(*form_element_types).where(!xp.attr(:form))\n      xpath += xp.anywhere(*form_element_types).where(xp.attr(:form) == native[:id]) if native[:id]\n      xpath.where(!xp.attr(:disabled))\n    end.to_s\n\n    form_elements = native.xpath(form_elements_xpath).reject { |el| submitter?(el) && (el != button.native) }\n\n    form_params = form_elements.each_with_object({}.compare_by_identity) do |field, params|\n      case field.name\n      when 'input', 'button' then add_input_param(field, params)\n      when 'select' then add_select_param(field, params)\n      when 'textarea' then add_textarea_param(field, params)\n      end\n    end\n\n    form_params.each_with_object(make_params) do |(name, value), params|\n      merge_param!(params, name, value)\n    end.to_params_hash\n\n    # form_elements.each_with_object(make_params) do |field, params|\n    #   case field.name\n    #   when 'input', 'button' then add_input_param(field, params)\n    #   when 'select' then add_select_param(field, params)\n    #   when 'textarea' then add_textarea_param(field, params)\n    #   end\n    # end.to_params_hash\n  end\n\n  def submit(button)\n    action = button&.[]('formaction') || native['action']\n    method = button&.[]('formmethod') || request_method\n    driver.submit(method, action.to_s, params(button), content_type: native['enctype'])\n  end\n\n  def multipart?\n    self[:enctype] == 'multipart/form-data'\n  end\n\nprivate\n\n  class ParamsHash < Hash\n    def to_params_hash\n      self\n    end\n  end\n\n  def request_method\n    /post/i.match?(self[:method] || '') ? :post : :get\n  end\n\n  def merge_param!(params, key, value)\n    key = key.to_s\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.normalize_params(params, key, value, Rack::Utils.param_depth_limit)\n    else\n      Rack::Utils.normalize_params(params, key, value)\n    end\n  end\n\n  def make_params\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.make_params\n    else\n      ParamsHash.new\n    end\n  end\n\n  def add_input_param(field, params)\n    name, value = field['name'].to_s, field['value'].to_s\n    return if name.empty?\n\n    value = case field['type']\n    when 'radio', 'checkbox'\n      return unless field['checked']\n\n      Capybara::RackTest::Node.new(driver, field).value.to_s\n    when 'file'\n      return if value.empty? && params.keys.include?(name) && Rack::Test::VERSION.to_f >= 2.0 # rubocop:disable Performance/InefficientHashSearch\n\n      if multipart?\n        file_to_upload(value)\n      else\n        File.basename(value)\n      end\n    else\n      value\n    end\n    # merge_param!(params, name, value)\n    params[name] = value\n  end\n\n  def file_to_upload(filename)\n    if filename.empty?\n      NilUploadedFile.new\n    else\n      mime_info = MiniMime.lookup_by_filename(filename)\n      Rack::Test::UploadedFile.new(filename, mime_info&.content_type&.to_s)\n    end\n  end\n\n  def add_select_param(field, params)\n    name = field['name']\n    if field.has_attribute?('multiple')\n      value = field.xpath('.//option[@selected]').map do |option|\n        # merge_param!(params, field['name'], (option['value'] || option.text).to_s)\n        (option['value'] || option.text).to_s\n      end\n      params[name] = value unless value.empty?\n    else\n      option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first\n      # merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option\n      params[name] = (option['value'] || option.text).to_s if option\n    end\n  end\n\n  def add_textarea_param(field, params)\n    # merge_param!(params, field['name'], field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\"))\n    params[field['name']] = field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\")\n  end\n\n  def submitter?(el)\n    (%w[submit image].include? el['type']) || (el.name == 'button')\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add_input_param", "signature": "def add_input_param(field, params)", "start_line": 93, "end_line": 115}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Form", "class_signature": "class Capybara::RackTest::Form < < Capybara::RackTest::Node"}, "task_id": 67}
{"function_name": "add_select_param", "file_path": "capybara/lib/capybara/rack_test/form.rb", "focal_code": "def add_select_param(field, params)\n    name = field['name']\n    if field.has_attribute?('multiple')\n      value = field.xpath('.//option[@selected]').map do |option|\n        # merge_param!(params, field['name'], (option['value'] || option.text).to_s)\n        (option['value'] || option.text).to_s\n      end\n      params[name] = value unless value.empty?\n    else\n      option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first\n      # merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option\n      params[name] = (option['value'] || option.text).to_s if option\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::RackTest::Form < Capybara::RackTest::Node\n  # This only needs to inherit from Rack::Test::UploadedFile because Rack::Test checks for\n  # the class specifically when determining whether to construct the request as multipart.\n  # That check should be based solely on the form element's 'enctype' attribute value,\n  # which should probably be provided to Rack::Test in its non-GET request methods.\n  class NilUploadedFile < Rack::Test::UploadedFile\n    def initialize # rubocop:disable Lint/MissingSuper\n      @empty_file = Tempfile.new('nil_uploaded_file')\n      @empty_file.close\n    end\n\n    def original_filename; ''; end\n    def content_type; 'application/octet-stream'; end\n    def path; @empty_file.path; end\n    def size; 0; end\n    def read; ''; end\n    def append_to(_); end\n    def set_encoding(_); end # rubocop:disable Naming/AccessorMethodName\n  end\n\n  def params(button)\n    form_element_types = %i[input select textarea button]\n    form_elements_xpath = XPath.generate do |xp|\n      xpath = xp.descendant(*form_element_types).where(!xp.attr(:form))\n      xpath += xp.anywhere(*form_element_types).where(xp.attr(:form) == native[:id]) if native[:id]\n      xpath.where(!xp.attr(:disabled))\n    end.to_s\n\n    form_elements = native.xpath(form_elements_xpath).reject { |el| submitter?(el) && (el != button.native) }\n\n    form_params = form_elements.each_with_object({}.compare_by_identity) do |field, params|\n      case field.name\n      when 'input', 'button' then add_input_param(field, params)\n      when 'select' then add_select_param(field, params)\n      when 'textarea' then add_textarea_param(field, params)\n      end\n    end\n\n    form_params.each_with_object(make_params) do |(name, value), params|\n      merge_param!(params, name, value)\n    end.to_params_hash\n\n    # form_elements.each_with_object(make_params) do |field, params|\n    #   case field.name\n    #   when 'input', 'button' then add_input_param(field, params)\n    #   when 'select' then add_select_param(field, params)\n    #   when 'textarea' then add_textarea_param(field, params)\n    #   end\n    # end.to_params_hash\n  end\n\n  def submit(button)\n    action = button&.[]('formaction') || native['action']\n    method = button&.[]('formmethod') || request_method\n    driver.submit(method, action.to_s, params(button), content_type: native['enctype'])\n  end\n\n  def multipart?\n    self[:enctype] == 'multipart/form-data'\n  end\n\nprivate\n\n  class ParamsHash < Hash\n    def to_params_hash\n      self\n    end\n  end\n\n  def request_method\n    /post/i.match?(self[:method] || '') ? :post : :get\n  end\n\n  def merge_param!(params, key, value)\n    key = key.to_s\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.normalize_params(params, key, value, Rack::Utils.param_depth_limit)\n    else\n      Rack::Utils.normalize_params(params, key, value)\n    end\n  end\n\n  def make_params\n    if Rack::Utils.respond_to?(:default_query_parser)\n      Rack::Utils.default_query_parser.make_params\n    else\n      ParamsHash.new\n    end\n  end\n\n  def add_input_param(field, params)\n    name, value = field['name'].to_s, field['value'].to_s\n    return if name.empty?\n\n    value = case field['type']\n    when 'radio', 'checkbox'\n      return unless field['checked']\n\n      Capybara::RackTest::Node.new(driver, field).value.to_s\n    when 'file'\n      return if value.empty? && params.keys.include?(name) && Rack::Test::VERSION.to_f >= 2.0 # rubocop:disable Performance/InefficientHashSearch\n\n      if multipart?\n        file_to_upload(value)\n      else\n        File.basename(value)\n      end\n    else\n      value\n    end\n    # merge_param!(params, name, value)\n    params[name] = value\n  end\n\n  def file_to_upload(filename)\n    if filename.empty?\n      NilUploadedFile.new\n    else\n      mime_info = MiniMime.lookup_by_filename(filename)\n      Rack::Test::UploadedFile.new(filename, mime_info&.content_type&.to_s)\n    end\n  end\n\n  def add_select_param(field, params)\n    name = field['name']\n    if field.has_attribute?('multiple')\n      value = field.xpath('.//option[@selected]').map do |option|\n        # merge_param!(params, field['name'], (option['value'] || option.text).to_s)\n        (option['value'] || option.text).to_s\n      end\n      params[name] = value unless value.empty?\n    else\n      option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first\n      # merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option\n      params[name] = (option['value'] || option.text).to_s if option\n    end\n  end\n\n  def add_textarea_param(field, params)\n    # merge_param!(params, field['name'], field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\"))\n    params[field['name']] = field['_capybara_raw_value'].to_s.gsub(/\\r?\\n/, \"\\r\\n\")\n  end\n\n  def submitter?(el)\n    (%w[submit image].include? el['type']) || (el.name == 'button')\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add_select_param", "signature": "def add_select_param(field, params)", "start_line": 126, "end_line": 139}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Form", "class_signature": "class Capybara::RackTest::Form < < Capybara::RackTest::Node"}, "task_id": 68}
{"function_name": "set", "file_path": "capybara/lib/capybara/rack_test/node.rb", "focal_code": "def set(value, **options)\n    return if disabled? || readonly?\n\n    warn \"Options passed to Node#set but the RackTest driver doesn't support any - ignoring\" unless options.empty?\n\n    if value.is_a?(Array) && !multiple?\n      raise TypeError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    if radio? then set_radio(value)\n    elsif checkbox? then set_checkbox(value)\n    elsif range? then set_range(value)\n    elsif input_field? then set_input(value)\n    elsif textarea? then native['_capybara_raw_value'] = value.to_s\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/rack_test/errors'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::RackTest::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n\n  BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze\n\n  def all_text\n    normalize_spacing(native.text)\n  end\n\n  def visible_text\n    normalize_visible_spacing(displayed_text)\n  end\n\n  def [](name)\n    string_node[name]\n  end\n\n  def style(_styles)\n    raise NotImplementedError, 'The rack_test driver does not process CSS'\n  end\n\n  def value\n    string_node.value\n  end\n\n  def set(value, **options)\n    return if disabled? || readonly?\n\n    warn \"Options passed to Node#set but the RackTest driver doesn't support any - ignoring\" unless options.empty?\n\n    if value.is_a?(Array) && !multiple?\n      raise TypeError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    if radio? then set_radio(value)\n    elsif checkbox? then set_checkbox(value)\n    elsif range? then set_range(value)\n    elsif input_field? then set_input(value)\n    elsif textarea? then native['_capybara_raw_value'] = value.to_s\n    end\n  end\n\n  def select_option\n    return if disabled?\n\n    deselect_options unless select_node.multiple?\n    native['selected'] = 'selected'\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    native.remove_attribute('selected')\n  end\n\n  def click(keys = [], **options)\n    options.delete(:offset)\n    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?\n\n    if link?\n      follow_link\n    elsif submits?\n      associated_form = form\n      Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form\n    elsif checkable?\n      set(!checked?)\n    elsif tag_name == 'label'\n      click_label\n    elsif (details = native.xpath('.//ancestor-or-self::details').last)\n      toggle_details(details)\n    end\n  end\n\n  def tag_name\n    native.node_name\n  end\n\n  def visible?\n    string_node.visible?\n  end\n\n  def checked?\n    string_node.checked?\n  end\n\n  def selected?\n    string_node.selected?\n  end\n\n  def disabled?\n    return true if string_node.disabled?\n\n    if %w[option optgroup].include? tag_name\n      find_xpath(OPTION_OWNER_XPATH)[0].disabled?\n    else\n      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?\n    end\n  end\n\n  def readonly?\n    # readonly attribute not valid on these input types\n    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)\n\n    super\n  end\n\n  def path\n    native.path\n  end\n\n  def find_xpath(locator, **_hints)\n    native.xpath(locator).map { |el| self.class.new(driver, el) }\n  end\n\n  def find_css(locator, **_hints)\n    native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }\n  end\n\n  public_instance_methods(false).each do |meth_name|\n    alias_method \"unchecked_#{meth_name}\", meth_name\n    private \"unchecked_#{meth_name}\" # rubocop:disable Style/AccessModifierDeclarations\n\n    class_eval <<~METHOD, __FILE__, __LINE__ + 1\n      def #{meth_name}(...)\n        stale_check\n        method(:\"unchecked_#{meth_name}\").call(...)\n      end\n    METHOD\n  end\n\nprotected\n\n  # @api private\n  def displayed_text(check_ancestor: true)\n    if !string_node.visible?(check_ancestor)\n      ''\n    elsif native.text?\n      native\n        .text\n        .delete(REMOVED_CHARACTERS)\n        .tr(SQUEEZED_SPACES, ' ')\n        .squeeze(' ')\n    elsif native.element?\n      text = native.children.map do |child|\n        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)\n      end.join || ''\n      text = \"\\n#{text}\\n\" if BLOCK_ELEMENTS.include?(tag_name)\n      text\n    else # rubocop:disable Lint/DuplicateBranch\n      ''\n    end\n  end\n\nprivate\n\n  def stale_check\n    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom\n  end\n\n  def deselect_options\n    select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }\n  end\n\n  def string_node\n    @string_node ||= Capybara::Node::Simple.new(native)\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath('./ancestor::select[1]').first\n  end\n\n  def type\n    native[:type]\n  end\n\n  def form\n    if native[:form]\n      native.xpath(\"//form[@id='#{native[:form]}']\")\n    else\n      native.ancestors('form')\n    end.first\n  end\n\n  def set_radio(_value) # rubocop:disable Naming/AccessorMethodName\n    other_radios_xpath = XPath.generate { |xp| xp.anywhere(:input)[xp.attr(:name) == self[:name]] }.to_s\n    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute('checked') }\n    native['checked'] = 'checked'\n  end\n\n  def set_checkbox(value) # rubocop:disable Naming/AccessorMethodName\n    if value && !native['checked']\n      native['checked'] = 'checked'\n    elsif !value && native['checked']\n      native.remove_attribute('checked')\n    end\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f\n    value = value.to_f\n    value = value.clamp(min, max)\n    value = (((value - min) / step).round * step) + min\n    native['value'] = value.clamp(min, max)\n  end\n\n  def set_input(value) # rubocop:disable Naming/AccessorMethodName\n    if text_or_password? && attribute_is_not_blank?(:maxlength)\n      # Browser behavior for maxlength=\"0\" is inconsistent, so we stick with\n      # Firefox, allowing no input\n      value = value.to_s[0...self[:maxlength].to_i]\n    end\n    if value.is_a?(Array) # Assert multiple attribute is present\n      value.each do |val|\n        new_native = native.clone\n        new_native.remove_attribute('value')\n        native.add_next_sibling(new_native)\n        new_native['value'] = val.to_s\n      end\n      native.remove\n    else\n      value.to_s.tap do |set_value|\n        if set_value.end_with?(\"\\n\") && (form&.css('input, textarea')&.count == 1) # rubocop:disable Style/CollectionQuerying\n          native['value'] = set_value.to_s.chop\n          Capybara::RackTest::Form.new(driver, form).submit(self)\n        else\n          native['value'] = set_value\n        end\n      end\n    end\n  end\n\n  def attribute_is_not_blank?(attribute)\n    self[attribute] && !self[attribute].empty?\n  end\n\n  def follow_link\n    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]\n    method ||= :get\n    driver.follow(method, self[:href].to_s)\n  end\n\n  def click_label\n    labelled_control = if native[:for]\n      find_xpath(\"//input[@id='#{native[:for]}']\")\n    else\n      find_xpath('.//input')\n    end.first\n\n    labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)\n  end\n\n  def toggle_details(details = nil)\n    details ||= native.xpath('.//ancestor-or-self::details').last\n    return unless details\n\n    if details.has_attribute?('open')\n      details.remove_attribute('open')\n    else\n      details.set_attribute('open', 'open')\n    end\n  end\n\n  def link?\n    tag_name == 'a' && !self[:href].nil?\n  end\n\n  def submits?\n    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, 'submit'].include?(type))\n  end\n\n  def checkable?\n    tag_name == 'input' && %w[checkbox radio].include?(type)\n  end\n\nprotected\n\n  def checkbox_or_radio?(field = self)\n    field&.checkbox? || field&.radio?\n  end\n\n  def checkbox?\n    input_field? && type == 'checkbox'\n  end\n\n  def radio?\n    input_field? && type == 'radio'\n  end\n\n  def text_or_password?\n    input_field? && %w[text password].include?(type)\n  end\n\n  def input_field?\n    tag_name == 'input'\n  end\n\n  def textarea?\n    tag_name == 'textarea'\n  end\n\n  def range?\n    input_field? && type == 'range'\n  end\n\n  OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze\n  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|\n    x.parent(:fieldset)[\n      XPath.attr(:disabled)\n    ] + x.ancestor[\n      ~x.self(:legend) |\n      x.preceding_sibling(:legend)\n    ][\n      x.parent(:fieldset)[\n        x.attr(:disabled)\n      ]\n    ]\n  end.to_s.freeze\nend\n", "language": "Ruby", "function_component": {"name": "set", "signature": "def set(value, **options)", "start_line": 31, "end_line": 46}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Node", "class_signature": "class Capybara::RackTest::Node < < Capybara::Driver::Node"}, "task_id": 69}
{"function_name": "click", "file_path": "capybara/lib/capybara/rack_test/node.rb", "focal_code": "def click(keys = [], **options)\n    options.delete(:offset)\n    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?\n\n    if link?\n      follow_link\n    elsif submits?\n      associated_form = form\n      Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form\n    elsif checkable?\n      set(!checked?)\n    elsif tag_name == 'label'\n      click_label\n    elsif (details = native.xpath('.//ancestor-or-self::details').last)\n      toggle_details(details)\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/rack_test/errors'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::RackTest::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n\n  BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze\n\n  def all_text\n    normalize_spacing(native.text)\n  end\n\n  def visible_text\n    normalize_visible_spacing(displayed_text)\n  end\n\n  def [](name)\n    string_node[name]\n  end\n\n  def style(_styles)\n    raise NotImplementedError, 'The rack_test driver does not process CSS'\n  end\n\n  def value\n    string_node.value\n  end\n\n  def set(value, **options)\n    return if disabled? || readonly?\n\n    warn \"Options passed to Node#set but the RackTest driver doesn't support any - ignoring\" unless options.empty?\n\n    if value.is_a?(Array) && !multiple?\n      raise TypeError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    if radio? then set_radio(value)\n    elsif checkbox? then set_checkbox(value)\n    elsif range? then set_range(value)\n    elsif input_field? then set_input(value)\n    elsif textarea? then native['_capybara_raw_value'] = value.to_s\n    end\n  end\n\n  def select_option\n    return if disabled?\n\n    deselect_options unless select_node.multiple?\n    native['selected'] = 'selected'\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    native.remove_attribute('selected')\n  end\n\n  def click(keys = [], **options)\n    options.delete(:offset)\n    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?\n\n    if link?\n      follow_link\n    elsif submits?\n      associated_form = form\n      Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form\n    elsif checkable?\n      set(!checked?)\n    elsif tag_name == 'label'\n      click_label\n    elsif (details = native.xpath('.//ancestor-or-self::details').last)\n      toggle_details(details)\n    end\n  end\n\n  def tag_name\n    native.node_name\n  end\n\n  def visible?\n    string_node.visible?\n  end\n\n  def checked?\n    string_node.checked?\n  end\n\n  def selected?\n    string_node.selected?\n  end\n\n  def disabled?\n    return true if string_node.disabled?\n\n    if %w[option optgroup].include? tag_name\n      find_xpath(OPTION_OWNER_XPATH)[0].disabled?\n    else\n      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?\n    end\n  end\n\n  def readonly?\n    # readonly attribute not valid on these input types\n    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)\n\n    super\n  end\n\n  def path\n    native.path\n  end\n\n  def find_xpath(locator, **_hints)\n    native.xpath(locator).map { |el| self.class.new(driver, el) }\n  end\n\n  def find_css(locator, **_hints)\n    native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }\n  end\n\n  public_instance_methods(false).each do |meth_name|\n    alias_method \"unchecked_#{meth_name}\", meth_name\n    private \"unchecked_#{meth_name}\" # rubocop:disable Style/AccessModifierDeclarations\n\n    class_eval <<~METHOD, __FILE__, __LINE__ + 1\n      def #{meth_name}(...)\n        stale_check\n        method(:\"unchecked_#{meth_name}\").call(...)\n      end\n    METHOD\n  end\n\nprotected\n\n  # @api private\n  def displayed_text(check_ancestor: true)\n    if !string_node.visible?(check_ancestor)\n      ''\n    elsif native.text?\n      native\n        .text\n        .delete(REMOVED_CHARACTERS)\n        .tr(SQUEEZED_SPACES, ' ')\n        .squeeze(' ')\n    elsif native.element?\n      text = native.children.map do |child|\n        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)\n      end.join || ''\n      text = \"\\n#{text}\\n\" if BLOCK_ELEMENTS.include?(tag_name)\n      text\n    else # rubocop:disable Lint/DuplicateBranch\n      ''\n    end\n  end\n\nprivate\n\n  def stale_check\n    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom\n  end\n\n  def deselect_options\n    select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }\n  end\n\n  def string_node\n    @string_node ||= Capybara::Node::Simple.new(native)\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath('./ancestor::select[1]').first\n  end\n\n  def type\n    native[:type]\n  end\n\n  def form\n    if native[:form]\n      native.xpath(\"//form[@id='#{native[:form]}']\")\n    else\n      native.ancestors('form')\n    end.first\n  end\n\n  def set_radio(_value) # rubocop:disable Naming/AccessorMethodName\n    other_radios_xpath = XPath.generate { |xp| xp.anywhere(:input)[xp.attr(:name) == self[:name]] }.to_s\n    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute('checked') }\n    native['checked'] = 'checked'\n  end\n\n  def set_checkbox(value) # rubocop:disable Naming/AccessorMethodName\n    if value && !native['checked']\n      native['checked'] = 'checked'\n    elsif !value && native['checked']\n      native.remove_attribute('checked')\n    end\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f\n    value = value.to_f\n    value = value.clamp(min, max)\n    value = (((value - min) / step).round * step) + min\n    native['value'] = value.clamp(min, max)\n  end\n\n  def set_input(value) # rubocop:disable Naming/AccessorMethodName\n    if text_or_password? && attribute_is_not_blank?(:maxlength)\n      # Browser behavior for maxlength=\"0\" is inconsistent, so we stick with\n      # Firefox, allowing no input\n      value = value.to_s[0...self[:maxlength].to_i]\n    end\n    if value.is_a?(Array) # Assert multiple attribute is present\n      value.each do |val|\n        new_native = native.clone\n        new_native.remove_attribute('value')\n        native.add_next_sibling(new_native)\n        new_native['value'] = val.to_s\n      end\n      native.remove\n    else\n      value.to_s.tap do |set_value|\n        if set_value.end_with?(\"\\n\") && (form&.css('input, textarea')&.count == 1) # rubocop:disable Style/CollectionQuerying\n          native['value'] = set_value.to_s.chop\n          Capybara::RackTest::Form.new(driver, form).submit(self)\n        else\n          native['value'] = set_value\n        end\n      end\n    end\n  end\n\n  def attribute_is_not_blank?(attribute)\n    self[attribute] && !self[attribute].empty?\n  end\n\n  def follow_link\n    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]\n    method ||= :get\n    driver.follow(method, self[:href].to_s)\n  end\n\n  def click_label\n    labelled_control = if native[:for]\n      find_xpath(\"//input[@id='#{native[:for]}']\")\n    else\n      find_xpath('.//input')\n    end.first\n\n    labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)\n  end\n\n  def toggle_details(details = nil)\n    details ||= native.xpath('.//ancestor-or-self::details').last\n    return unless details\n\n    if details.has_attribute?('open')\n      details.remove_attribute('open')\n    else\n      details.set_attribute('open', 'open')\n    end\n  end\n\n  def link?\n    tag_name == 'a' && !self[:href].nil?\n  end\n\n  def submits?\n    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, 'submit'].include?(type))\n  end\n\n  def checkable?\n    tag_name == 'input' && %w[checkbox radio].include?(type)\n  end\n\nprotected\n\n  def checkbox_or_radio?(field = self)\n    field&.checkbox? || field&.radio?\n  end\n\n  def checkbox?\n    input_field? && type == 'checkbox'\n  end\n\n  def radio?\n    input_field? && type == 'radio'\n  end\n\n  def text_or_password?\n    input_field? && %w[text password].include?(type)\n  end\n\n  def input_field?\n    tag_name == 'input'\n  end\n\n  def textarea?\n    tag_name == 'textarea'\n  end\n\n  def range?\n    input_field? && type == 'range'\n  end\n\n  OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze\n  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|\n    x.parent(:fieldset)[\n      XPath.attr(:disabled)\n    ] + x.ancestor[\n      ~x.self(:legend) |\n      x.preceding_sibling(:legend)\n    ][\n      x.parent(:fieldset)[\n        x.attr(:disabled)\n      ]\n    ]\n  end.to_s.freeze\nend\n", "language": "Ruby", "function_component": {"name": "click", "signature": "def click(keys = [], **options)", "start_line": 61, "end_line": 77}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Node", "class_signature": "class Capybara::RackTest::Node < < Capybara::Driver::Node"}, "task_id": 70}
{"function_name": "displayed_text", "file_path": "capybara/lib/capybara/rack_test/node.rb", "focal_code": "def displayed_text(check_ancestor: true)\n    if !string_node.visible?(check_ancestor)\n      ''\n    elsif native.text?\n      native\n        .text\n        .delete(REMOVED_CHARACTERS)\n        .tr(SQUEEZED_SPACES, ' ')\n        .squeeze(' ')\n    elsif native.element?\n      text = native.children.map do |child|\n        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)\n      end.join || ''\n      text = \"\\n#{text}\\n\" if BLOCK_ELEMENTS.include?(tag_name)\n      text\n    else # rubocop:disable Lint/DuplicateBranch\n      ''\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/rack_test/errors'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::RackTest::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n\n  BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze\n\n  def all_text\n    normalize_spacing(native.text)\n  end\n\n  def visible_text\n    normalize_visible_spacing(displayed_text)\n  end\n\n  def [](name)\n    string_node[name]\n  end\n\n  def style(_styles)\n    raise NotImplementedError, 'The rack_test driver does not process CSS'\n  end\n\n  def value\n    string_node.value\n  end\n\n  def set(value, **options)\n    return if disabled? || readonly?\n\n    warn \"Options passed to Node#set but the RackTest driver doesn't support any - ignoring\" unless options.empty?\n\n    if value.is_a?(Array) && !multiple?\n      raise TypeError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    if radio? then set_radio(value)\n    elsif checkbox? then set_checkbox(value)\n    elsif range? then set_range(value)\n    elsif input_field? then set_input(value)\n    elsif textarea? then native['_capybara_raw_value'] = value.to_s\n    end\n  end\n\n  def select_option\n    return if disabled?\n\n    deselect_options unless select_node.multiple?\n    native['selected'] = 'selected'\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    native.remove_attribute('selected')\n  end\n\n  def click(keys = [], **options)\n    options.delete(:offset)\n    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?\n\n    if link?\n      follow_link\n    elsif submits?\n      associated_form = form\n      Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form\n    elsif checkable?\n      set(!checked?)\n    elsif tag_name == 'label'\n      click_label\n    elsif (details = native.xpath('.//ancestor-or-self::details').last)\n      toggle_details(details)\n    end\n  end\n\n  def tag_name\n    native.node_name\n  end\n\n  def visible?\n    string_node.visible?\n  end\n\n  def checked?\n    string_node.checked?\n  end\n\n  def selected?\n    string_node.selected?\n  end\n\n  def disabled?\n    return true if string_node.disabled?\n\n    if %w[option optgroup].include? tag_name\n      find_xpath(OPTION_OWNER_XPATH)[0].disabled?\n    else\n      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?\n    end\n  end\n\n  def readonly?\n    # readonly attribute not valid on these input types\n    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)\n\n    super\n  end\n\n  def path\n    native.path\n  end\n\n  def find_xpath(locator, **_hints)\n    native.xpath(locator).map { |el| self.class.new(driver, el) }\n  end\n\n  def find_css(locator, **_hints)\n    native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }\n  end\n\n  public_instance_methods(false).each do |meth_name|\n    alias_method \"unchecked_#{meth_name}\", meth_name\n    private \"unchecked_#{meth_name}\" # rubocop:disable Style/AccessModifierDeclarations\n\n    class_eval <<~METHOD, __FILE__, __LINE__ + 1\n      def #{meth_name}(...)\n        stale_check\n        method(:\"unchecked_#{meth_name}\").call(...)\n      end\n    METHOD\n  end\n\nprotected\n\n  # @api private\n  def displayed_text(check_ancestor: true)\n    if !string_node.visible?(check_ancestor)\n      ''\n    elsif native.text?\n      native\n        .text\n        .delete(REMOVED_CHARACTERS)\n        .tr(SQUEEZED_SPACES, ' ')\n        .squeeze(' ')\n    elsif native.element?\n      text = native.children.map do |child|\n        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)\n      end.join || ''\n      text = \"\\n#{text}\\n\" if BLOCK_ELEMENTS.include?(tag_name)\n      text\n    else # rubocop:disable Lint/DuplicateBranch\n      ''\n    end\n  end\n\nprivate\n\n  def stale_check\n    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom\n  end\n\n  def deselect_options\n    select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }\n  end\n\n  def string_node\n    @string_node ||= Capybara::Node::Simple.new(native)\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath('./ancestor::select[1]').first\n  end\n\n  def type\n    native[:type]\n  end\n\n  def form\n    if native[:form]\n      native.xpath(\"//form[@id='#{native[:form]}']\")\n    else\n      native.ancestors('form')\n    end.first\n  end\n\n  def set_radio(_value) # rubocop:disable Naming/AccessorMethodName\n    other_radios_xpath = XPath.generate { |xp| xp.anywhere(:input)[xp.attr(:name) == self[:name]] }.to_s\n    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute('checked') }\n    native['checked'] = 'checked'\n  end\n\n  def set_checkbox(value) # rubocop:disable Naming/AccessorMethodName\n    if value && !native['checked']\n      native['checked'] = 'checked'\n    elsif !value && native['checked']\n      native.remove_attribute('checked')\n    end\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f\n    value = value.to_f\n    value = value.clamp(min, max)\n    value = (((value - min) / step).round * step) + min\n    native['value'] = value.clamp(min, max)\n  end\n\n  def set_input(value) # rubocop:disable Naming/AccessorMethodName\n    if text_or_password? && attribute_is_not_blank?(:maxlength)\n      # Browser behavior for maxlength=\"0\" is inconsistent, so we stick with\n      # Firefox, allowing no input\n      value = value.to_s[0...self[:maxlength].to_i]\n    end\n    if value.is_a?(Array) # Assert multiple attribute is present\n      value.each do |val|\n        new_native = native.clone\n        new_native.remove_attribute('value')\n        native.add_next_sibling(new_native)\n        new_native['value'] = val.to_s\n      end\n      native.remove\n    else\n      value.to_s.tap do |set_value|\n        if set_value.end_with?(\"\\n\") && (form&.css('input, textarea')&.count == 1) # rubocop:disable Style/CollectionQuerying\n          native['value'] = set_value.to_s.chop\n          Capybara::RackTest::Form.new(driver, form).submit(self)\n        else\n          native['value'] = set_value\n        end\n      end\n    end\n  end\n\n  def attribute_is_not_blank?(attribute)\n    self[attribute] && !self[attribute].empty?\n  end\n\n  def follow_link\n    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]\n    method ||= :get\n    driver.follow(method, self[:href].to_s)\n  end\n\n  def click_label\n    labelled_control = if native[:for]\n      find_xpath(\"//input[@id='#{native[:for]}']\")\n    else\n      find_xpath('.//input')\n    end.first\n\n    labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)\n  end\n\n  def toggle_details(details = nil)\n    details ||= native.xpath('.//ancestor-or-self::details').last\n    return unless details\n\n    if details.has_attribute?('open')\n      details.remove_attribute('open')\n    else\n      details.set_attribute('open', 'open')\n    end\n  end\n\n  def link?\n    tag_name == 'a' && !self[:href].nil?\n  end\n\n  def submits?\n    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, 'submit'].include?(type))\n  end\n\n  def checkable?\n    tag_name == 'input' && %w[checkbox radio].include?(type)\n  end\n\nprotected\n\n  def checkbox_or_radio?(field = self)\n    field&.checkbox? || field&.radio?\n  end\n\n  def checkbox?\n    input_field? && type == 'checkbox'\n  end\n\n  def radio?\n    input_field? && type == 'radio'\n  end\n\n  def text_or_password?\n    input_field? && %w[text password].include?(type)\n  end\n\n  def input_field?\n    tag_name == 'input'\n  end\n\n  def textarea?\n    tag_name == 'textarea'\n  end\n\n  def range?\n    input_field? && type == 'range'\n  end\n\n  OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze\n  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|\n    x.parent(:fieldset)[\n      XPath.attr(:disabled)\n    ] + x.ancestor[\n      ~x.self(:legend) |\n      x.preceding_sibling(:legend)\n    ][\n      x.parent(:fieldset)[\n        x.attr(:disabled)\n      ]\n    ]\n  end.to_s.freeze\nend\n", "language": "Ruby", "function_component": {"name": "displayed_text", "signature": "def displayed_text(check_ancestor: true)", "start_line": 139, "end_line": 157}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Node", "class_signature": "class Capybara::RackTest::Node < < Capybara::Driver::Node"}, "task_id": 71}
{"function_name": "set_input", "file_path": "capybara/lib/capybara/rack_test/node.rb", "focal_code": "def set_input(value) # rubocop:disable Naming/AccessorMethodName\n    if text_or_password? && attribute_is_not_blank?(:maxlength)\n      # Browser behavior for maxlength=\"0\" is inconsistent, so we stick with\n      # Firefox, allowing no input\n      value = value.to_s[0...self[:maxlength].to_i]\n    end\n    if value.is_a?(Array) # Assert multiple attribute is present\n      value.each do |val|\n        new_native = native.clone\n        new_native.remove_attribute('value')\n        native.add_next_sibling(new_native)\n        new_native['value'] = val.to_s\n      end\n      native.remove\n    else\n      value.to_s.tap do |set_value|\n        if set_value.end_with?(\"\\n\") && (form&.css('input, textarea')&.count == 1) # rubocop:disable Style/CollectionQuerying\n          native['value'] = set_value.to_s.chop\n          Capybara::RackTest::Form.new(driver, form).submit(self)\n        else\n          native['value'] = set_value\n        end\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/rack_test/errors'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::RackTest::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n\n  BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze\n\n  def all_text\n    normalize_spacing(native.text)\n  end\n\n  def visible_text\n    normalize_visible_spacing(displayed_text)\n  end\n\n  def [](name)\n    string_node[name]\n  end\n\n  def style(_styles)\n    raise NotImplementedError, 'The rack_test driver does not process CSS'\n  end\n\n  def value\n    string_node.value\n  end\n\n  def set(value, **options)\n    return if disabled? || readonly?\n\n    warn \"Options passed to Node#set but the RackTest driver doesn't support any - ignoring\" unless options.empty?\n\n    if value.is_a?(Array) && !multiple?\n      raise TypeError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    if radio? then set_radio(value)\n    elsif checkbox? then set_checkbox(value)\n    elsif range? then set_range(value)\n    elsif input_field? then set_input(value)\n    elsif textarea? then native['_capybara_raw_value'] = value.to_s\n    end\n  end\n\n  def select_option\n    return if disabled?\n\n    deselect_options unless select_node.multiple?\n    native['selected'] = 'selected'\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    native.remove_attribute('selected')\n  end\n\n  def click(keys = [], **options)\n    options.delete(:offset)\n    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?\n\n    if link?\n      follow_link\n    elsif submits?\n      associated_form = form\n      Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form\n    elsif checkable?\n      set(!checked?)\n    elsif tag_name == 'label'\n      click_label\n    elsif (details = native.xpath('.//ancestor-or-self::details').last)\n      toggle_details(details)\n    end\n  end\n\n  def tag_name\n    native.node_name\n  end\n\n  def visible?\n    string_node.visible?\n  end\n\n  def checked?\n    string_node.checked?\n  end\n\n  def selected?\n    string_node.selected?\n  end\n\n  def disabled?\n    return true if string_node.disabled?\n\n    if %w[option optgroup].include? tag_name\n      find_xpath(OPTION_OWNER_XPATH)[0].disabled?\n    else\n      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?\n    end\n  end\n\n  def readonly?\n    # readonly attribute not valid on these input types\n    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)\n\n    super\n  end\n\n  def path\n    native.path\n  end\n\n  def find_xpath(locator, **_hints)\n    native.xpath(locator).map { |el| self.class.new(driver, el) }\n  end\n\n  def find_css(locator, **_hints)\n    native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }\n  end\n\n  public_instance_methods(false).each do |meth_name|\n    alias_method \"unchecked_#{meth_name}\", meth_name\n    private \"unchecked_#{meth_name}\" # rubocop:disable Style/AccessModifierDeclarations\n\n    class_eval <<~METHOD, __FILE__, __LINE__ + 1\n      def #{meth_name}(...)\n        stale_check\n        method(:\"unchecked_#{meth_name}\").call(...)\n      end\n    METHOD\n  end\n\nprotected\n\n  # @api private\n  def displayed_text(check_ancestor: true)\n    if !string_node.visible?(check_ancestor)\n      ''\n    elsif native.text?\n      native\n        .text\n        .delete(REMOVED_CHARACTERS)\n        .tr(SQUEEZED_SPACES, ' ')\n        .squeeze(' ')\n    elsif native.element?\n      text = native.children.map do |child|\n        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)\n      end.join || ''\n      text = \"\\n#{text}\\n\" if BLOCK_ELEMENTS.include?(tag_name)\n      text\n    else # rubocop:disable Lint/DuplicateBranch\n      ''\n    end\n  end\n\nprivate\n\n  def stale_check\n    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom\n  end\n\n  def deselect_options\n    select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }\n  end\n\n  def string_node\n    @string_node ||= Capybara::Node::Simple.new(native)\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath('./ancestor::select[1]').first\n  end\n\n  def type\n    native[:type]\n  end\n\n  def form\n    if native[:form]\n      native.xpath(\"//form[@id='#{native[:form]}']\")\n    else\n      native.ancestors('form')\n    end.first\n  end\n\n  def set_radio(_value) # rubocop:disable Naming/AccessorMethodName\n    other_radios_xpath = XPath.generate { |xp| xp.anywhere(:input)[xp.attr(:name) == self[:name]] }.to_s\n    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute('checked') }\n    native['checked'] = 'checked'\n  end\n\n  def set_checkbox(value) # rubocop:disable Naming/AccessorMethodName\n    if value && !native['checked']\n      native['checked'] = 'checked'\n    elsif !value && native['checked']\n      native.remove_attribute('checked')\n    end\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f\n    value = value.to_f\n    value = value.clamp(min, max)\n    value = (((value - min) / step).round * step) + min\n    native['value'] = value.clamp(min, max)\n  end\n\n  def set_input(value) # rubocop:disable Naming/AccessorMethodName\n    if text_or_password? && attribute_is_not_blank?(:maxlength)\n      # Browser behavior for maxlength=\"0\" is inconsistent, so we stick with\n      # Firefox, allowing no input\n      value = value.to_s[0...self[:maxlength].to_i]\n    end\n    if value.is_a?(Array) # Assert multiple attribute is present\n      value.each do |val|\n        new_native = native.clone\n        new_native.remove_attribute('value')\n        native.add_next_sibling(new_native)\n        new_native['value'] = val.to_s\n      end\n      native.remove\n    else\n      value.to_s.tap do |set_value|\n        if set_value.end_with?(\"\\n\") && (form&.css('input, textarea')&.count == 1) # rubocop:disable Style/CollectionQuerying\n          native['value'] = set_value.to_s.chop\n          Capybara::RackTest::Form.new(driver, form).submit(self)\n        else\n          native['value'] = set_value\n        end\n      end\n    end\n  end\n\n  def attribute_is_not_blank?(attribute)\n    self[attribute] && !self[attribute].empty?\n  end\n\n  def follow_link\n    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]\n    method ||= :get\n    driver.follow(method, self[:href].to_s)\n  end\n\n  def click_label\n    labelled_control = if native[:for]\n      find_xpath(\"//input[@id='#{native[:for]}']\")\n    else\n      find_xpath('.//input')\n    end.first\n\n    labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)\n  end\n\n  def toggle_details(details = nil)\n    details ||= native.xpath('.//ancestor-or-self::details').last\n    return unless details\n\n    if details.has_attribute?('open')\n      details.remove_attribute('open')\n    else\n      details.set_attribute('open', 'open')\n    end\n  end\n\n  def link?\n    tag_name == 'a' && !self[:href].nil?\n  end\n\n  def submits?\n    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, 'submit'].include?(type))\n  end\n\n  def checkable?\n    tag_name == 'input' && %w[checkbox radio].include?(type)\n  end\n\nprotected\n\n  def checkbox_or_radio?(field = self)\n    field&.checkbox? || field&.radio?\n  end\n\n  def checkbox?\n    input_field? && type == 'checkbox'\n  end\n\n  def radio?\n    input_field? && type == 'radio'\n  end\n\n  def text_or_password?\n    input_field? && %w[text password].include?(type)\n  end\n\n  def input_field?\n    tag_name == 'input'\n  end\n\n  def textarea?\n    tag_name == 'textarea'\n  end\n\n  def range?\n    input_field? && type == 'range'\n  end\n\n  OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze\n  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|\n    x.parent(:fieldset)[\n      XPath.attr(:disabled)\n    ] + x.ancestor[\n      ~x.self(:legend) |\n      x.preceding_sibling(:legend)\n    ][\n      x.parent(:fieldset)[\n        x.attr(:disabled)\n      ]\n    ]\n  end.to_s.freeze\nend\n", "language": "Ruby", "function_component": {"name": "set_input", "signature": "def set_input(value) # rubocop:disable Naming/AccessorMethodName", "start_line": 212, "end_line": 236}, "metadata": {"module": "", "class_name": "Capybara::RackTest::Node", "class_signature": "class Capybara::RackTest::Node < < Capybara::Driver::Node"}, "task_id": 72}
{"function_name": "split", "file_path": "capybara/lib/capybara/selector/css.rb", "focal_code": "def split(css)\n          selectors = []\n          StringIO.open(css.to_s) do |str|\n            selector = +''\n            while (char = str.getc)\n              case char\n              when '['\n                selector << parse_square(str)\n              when '('\n                selector << parse_paren(str)\n              when '\"', \"'\"\n                selector << parse_string(char, str)\n              when '\\\\'\n                selector << (char + str.getc)\n              when ','\n                selectors << selector.strip\n                selector.clear\n              else\n                selector << char\n              end\n            end\n            selectors << selector.strip\n          end\n          selectors\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/selector'\n\nmodule Capybara\n  class Selector\n    class CSS\n      def self.escape(str)\n        value = str.dup\n        out = +''\n        out << value.slice!(0...1) if value.match?(/^[-_]/)\n        out << (value[0].match?(NMSTART) ? value.slice!(0...1) : escape_char(value.slice!(0...1)))\n        out << value.gsub(/[^a-zA-Z0-9_-]/) { |char| escape_char char }\n        out\n      end\n\n      def self.escape_char(char)\n        char.match?(%r{[ -/:-~]}) ? \"\\\\#{char}\" : format('\\\\%06<hex>x', hex: char.ord)\n      end\n\n      def self.split(css)\n        Splitter.new.split(css)\n      end\n\n      S = '\\u{80}-\\u{D7FF}\\u{E000}-\\u{FFFD}\\u{10000}-\\u{10FFFF}'\n      H = /[0-9a-fA-F]/\n      UNICODE  = /\\\\#{H}{1,6}[ \\t\\r\\n\\f]?/\n      NONASCII = /[#{S}]/\n      ESCAPE   = /#{UNICODE}|\\\\[ -~#{S}]/\n      NMSTART = /[_a-zA-Z]|#{NONASCII}|#{ESCAPE}/\n\n      class Splitter\n        def split(css)\n          selectors = []\n          StringIO.open(css.to_s) do |str|\n            selector = +''\n            while (char = str.getc)\n              case char\n              when '['\n                selector << parse_square(str)\n              when '('\n                selector << parse_paren(str)\n              when '\"', \"'\"\n                selector << parse_string(char, str)\n              when '\\\\'\n                selector << (char + str.getc)\n              when ','\n                selectors << selector.strip\n                selector.clear\n              else\n                selector << char\n              end\n            end\n            selectors << selector.strip\n          end\n          selectors\n        end\n\n      private\n\n        def parse_square(strio)\n          parse_block('[', ']', strio)\n        end\n\n        def parse_paren(strio)\n          parse_block('(', ')', strio)\n        end\n\n        def parse_block(start, final, strio)\n          block = start\n          while (char = strio.getc)\n            case char\n            when final\n              return block + char\n            when '\\\\'\n              block += char + strio.getc\n            when '\"', \"'\"\n              block += parse_string(char, strio)\n            else\n              block += char\n            end\n          end\n          raise ArgumentError, \"Invalid CSS Selector - Block end '#{final}' not found\"\n        end\n\n        def parse_string(quote, strio)\n          string = quote\n          while (char = strio.getc)\n            string += char\n            case char\n            when quote\n              return string\n            when '\\\\'\n              string += strio.getc\n            end\n          end\n          raise ArgumentError, 'Invalid CSS Selector - string end not found'\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "split", "signature": "def split(css)", "start_line": 33, "end_line": 57}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 73}
{"function_name": "parse_block", "file_path": "capybara/lib/capybara/selector/css.rb", "focal_code": "def parse_block(start, final, strio)\n          block = start\n          while (char = strio.getc)\n            case char\n            when final\n              return block + char\n            when '\\\\'\n              block += char + strio.getc\n            when '\"', \"'\"\n              block += parse_string(char, strio)\n            else\n              block += char\n            end\n          end\n          raise ArgumentError, \"Invalid CSS Selector - Block end '#{final}' not found\"\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/selector'\n\nmodule Capybara\n  class Selector\n    class CSS\n      def self.escape(str)\n        value = str.dup\n        out = +''\n        out << value.slice!(0...1) if value.match?(/^[-_]/)\n        out << (value[0].match?(NMSTART) ? value.slice!(0...1) : escape_char(value.slice!(0...1)))\n        out << value.gsub(/[^a-zA-Z0-9_-]/) { |char| escape_char char }\n        out\n      end\n\n      def self.escape_char(char)\n        char.match?(%r{[ -/:-~]}) ? \"\\\\#{char}\" : format('\\\\%06<hex>x', hex: char.ord)\n      end\n\n      def self.split(css)\n        Splitter.new.split(css)\n      end\n\n      S = '\\u{80}-\\u{D7FF}\\u{E000}-\\u{FFFD}\\u{10000}-\\u{10FFFF}'\n      H = /[0-9a-fA-F]/\n      UNICODE  = /\\\\#{H}{1,6}[ \\t\\r\\n\\f]?/\n      NONASCII = /[#{S}]/\n      ESCAPE   = /#{UNICODE}|\\\\[ -~#{S}]/\n      NMSTART = /[_a-zA-Z]|#{NONASCII}|#{ESCAPE}/\n\n      class Splitter\n        def split(css)\n          selectors = []\n          StringIO.open(css.to_s) do |str|\n            selector = +''\n            while (char = str.getc)\n              case char\n              when '['\n                selector << parse_square(str)\n              when '('\n                selector << parse_paren(str)\n              when '\"', \"'\"\n                selector << parse_string(char, str)\n              when '\\\\'\n                selector << (char + str.getc)\n              when ','\n                selectors << selector.strip\n                selector.clear\n              else\n                selector << char\n              end\n            end\n            selectors << selector.strip\n          end\n          selectors\n        end\n\n      private\n\n        def parse_square(strio)\n          parse_block('[', ']', strio)\n        end\n\n        def parse_paren(strio)\n          parse_block('(', ')', strio)\n        end\n\n        def parse_block(start, final, strio)\n          block = start\n          while (char = strio.getc)\n            case char\n            when final\n              return block + char\n            when '\\\\'\n              block += char + strio.getc\n            when '\"', \"'\"\n              block += parse_string(char, strio)\n            else\n              block += char\n            end\n          end\n          raise ArgumentError, \"Invalid CSS Selector - Block end '#{final}' not found\"\n        end\n\n        def parse_string(quote, strio)\n          string = quote\n          while (char = strio.getc)\n            string += char\n            case char\n            when quote\n              return string\n            when '\\\\'\n              string += strio.getc\n            end\n          end\n          raise ArgumentError, 'Invalid CSS Selector - string end not found'\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse_block", "signature": "def parse_block(start, final, strio)", "start_line": 69, "end_line": 84}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 74}
{"function_name": "parse_string", "file_path": "capybara/lib/capybara/selector/css.rb", "focal_code": "def parse_string(quote, strio)\n          string = quote\n          while (char = strio.getc)\n            string += char\n            case char\n            when quote\n              return string\n            when '\\\\'\n              string += strio.getc\n            end\n          end\n          raise ArgumentError, 'Invalid CSS Selector - string end not found'\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/selector'\n\nmodule Capybara\n  class Selector\n    class CSS\n      def self.escape(str)\n        value = str.dup\n        out = +''\n        out << value.slice!(0...1) if value.match?(/^[-_]/)\n        out << (value[0].match?(NMSTART) ? value.slice!(0...1) : escape_char(value.slice!(0...1)))\n        out << value.gsub(/[^a-zA-Z0-9_-]/) { |char| escape_char char }\n        out\n      end\n\n      def self.escape_char(char)\n        char.match?(%r{[ -/:-~]}) ? \"\\\\#{char}\" : format('\\\\%06<hex>x', hex: char.ord)\n      end\n\n      def self.split(css)\n        Splitter.new.split(css)\n      end\n\n      S = '\\u{80}-\\u{D7FF}\\u{E000}-\\u{FFFD}\\u{10000}-\\u{10FFFF}'\n      H = /[0-9a-fA-F]/\n      UNICODE  = /\\\\#{H}{1,6}[ \\t\\r\\n\\f]?/\n      NONASCII = /[#{S}]/\n      ESCAPE   = /#{UNICODE}|\\\\[ -~#{S}]/\n      NMSTART = /[_a-zA-Z]|#{NONASCII}|#{ESCAPE}/\n\n      class Splitter\n        def split(css)\n          selectors = []\n          StringIO.open(css.to_s) do |str|\n            selector = +''\n            while (char = str.getc)\n              case char\n              when '['\n                selector << parse_square(str)\n              when '('\n                selector << parse_paren(str)\n              when '\"', \"'\"\n                selector << parse_string(char, str)\n              when '\\\\'\n                selector << (char + str.getc)\n              when ','\n                selectors << selector.strip\n                selector.clear\n              else\n                selector << char\n              end\n            end\n            selectors << selector.strip\n          end\n          selectors\n        end\n\n      private\n\n        def parse_square(strio)\n          parse_block('[', ']', strio)\n        end\n\n        def parse_paren(strio)\n          parse_block('(', ')', strio)\n        end\n\n        def parse_block(start, final, strio)\n          block = start\n          while (char = strio.getc)\n            case char\n            when final\n              return block + char\n            when '\\\\'\n              block += char + strio.getc\n            when '\"', \"'\"\n              block += parse_string(char, strio)\n            else\n              block += char\n            end\n          end\n          raise ArgumentError, \"Invalid CSS Selector - Block end '#{final}' not found\"\n        end\n\n        def parse_string(quote, strio)\n          string = quote\n          while (char = strio.getc)\n            string += char\n            case char\n            when quote\n              return string\n            when '\\\\'\n              string += strio.getc\n            end\n          end\n          raise ArgumentError, 'Invalid CSS Selector - string end not found'\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse_string", "signature": "def parse_string(quote, strio)", "start_line": 86, "end_line": 98}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 75}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/selector/definition.rb", "focal_code": "def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)\n        @name = name\n        @filter_set = Capybara::Selector::FilterSet.add(name)\n        @match = nil\n        @label = nil\n        @failure_message = nil\n        @expressions = {}\n        @expression_filters = {}\n        @locator_filter = nil\n        @default_visibility = nil\n        @locator_type = locator_type\n        @raw_locator = raw_locator\n        @supports_exact = supports_exact\n        instance_eval(&block)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/filter_set'\nrequire 'capybara/selector/css'\nrequire 'capybara/selector/regexp_disassembler'\nrequire 'capybara/selector/builders/xpath_builder'\nrequire 'capybara/selector/builders/css_builder'\n\nmodule Capybara\n  class Selector\n    class Definition\n      attr_reader :name, :expressions\n\n      extend Forwardable\n\n      def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)\n        @name = name\n        @filter_set = Capybara::Selector::FilterSet.add(name)\n        @match = nil\n        @label = nil\n        @failure_message = nil\n        @expressions = {}\n        @expression_filters = {}\n        @locator_filter = nil\n        @default_visibility = nil\n        @locator_type = locator_type\n        @raw_locator = raw_locator\n        @supports_exact = supports_exact\n        instance_eval(&block)\n      end\n\n      def custom_filters\n        warn \"Deprecated: Selector#custom_filters is not valid when same named expression and node filter exist - don't use\"\n        node_filters.merge(expression_filters).freeze\n      end\n\n      def node_filters\n        @filter_set.node_filters\n      end\n\n      def expression_filters\n        @filter_set.expression_filters\n      end\n\n      ##\n      #\n      # Define a selector by an xpath expression\n      #\n      # @overload xpath(*expression_filters, &block)\n      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that are implemented via this expression, if not specified the names of any keyword parameters in the block will be used\n      #   @yield [locator, options]                       The block to use to generate the XPath expression\n      #   @yieldparam [String] locator                    The locator string passed to the query\n      #   @yieldparam [Hash] options                      The options hash passed to the query\n      #   @yieldreturn [#to_xpath, #to_s]                 An object that can produce an xpath expression\n      #\n      # @overload xpath()\n      # @return [#call]                             The block that will be called to generate the XPath expression\n      #\n      def xpath(*allowed_filters, &block)\n        expression(:xpath, allowed_filters, &block)\n      end\n\n      ##\n      #\n      # Define a selector by a CSS selector\n      #\n      # @overload css(*expression_filters, &block)\n      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that can be implemented via this CSS selector\n      #   @yield [locator, options]                   The block to use to generate the CSS selector\n      #   @yieldparam [String] locator               The locator string passed to the query\n      #   @yieldparam [Hash] options                 The options hash passed to the query\n      #   @yieldreturn [#to_s]                        An object that can produce a CSS selector\n      #\n      # @overload css()\n      # @return [#call]                             The block that will be called to generate the CSS selector\n      #\n      def css(*allowed_filters, &block)\n        expression(:css, allowed_filters, &block)\n      end\n\n      ##\n      #\n      # Automatic selector detection\n      #\n      # @yield [locator]                   This block takes the passed in locator string and returns whether or not it matches the selector\n      # @yieldparam [String], locator      The locator string used to determine if it matches the selector\n      # @yieldreturn [Boolean]             Whether this selector matches the locator string\n      # @return [#call]                    The block that will be used to detect selector match\n      #\n      def match(&block)\n        @match = block if block\n        @match\n      end\n\n      ##\n      #\n      # Set/get a descriptive label for the selector\n      #\n      # @overload label(label)\n      #   @param [String] label            A descriptive label for this selector - used in error messages\n      # @overload label()\n      # @return [String]                 The currently set label\n      #\n      def label(label = nil)\n        @label = label if label\n        @label\n      end\n\n      ##\n      #\n      # Description of the selector\n      #\n      # @!method description(options)\n      #   @param [Hash] options            The options of the query used to generate the description\n      #   @return [String]                 Description of the selector when used with the options passed\n      def_delegator :@filter_set, :description\n\n      ##\n      #\n      #  Should this selector be used for the passed in locator\n      #\n      #  This is used by the automatic selector selection mechanism when no selector type is passed to a selector query\n      #\n      # @param [String] locator     The locator passed to the query\n      # @return [Boolean]           Whether or not to use this selector\n      #\n      def match?(locator)\n        @match&.call(locator)\n      end\n\n      ##\n      #\n      # Define a node filter for use with this selector\n      #\n      # @!method node_filter(name, *types, options={}, &block)\n      #   @param [Symbol, Regexp] name            The filter name\n      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]\n      #   @param [Hash] options ({})      Options of the filter\n      #   @option options [Array<>] :valid_values Valid values for this filter\n      #   @option options :default        The default value of the filter (if any)\n      #   @option options :skip_if        Value of the filter that will cause it to be skipped\n      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.\n      #\n      # If a Symbol is passed for the name the block should accept | node, option_value |, while if a Regexp\n      # is passed for the name the block should accept | node, option_name, option_value |. In either case\n      # the block should return `true` if the node passes the filer or `false` if it doesn't\n\n      ##\n      #\n      # Define an expression filter for use with this selector\n      #\n      # @!method expression_filter(name, *types, matcher: nil, **options, &block)\n      #   @param [Symbol, Regexp] name            The filter name\n      #   @param [Regexp] matcher (nil)   A Regexp used to check whether a specific option is handled by this filter\n      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]\n      #   @param [Hash] options ({})      Options of the filter\n      #   @option options [Array<>] :valid_values Valid values for this filter\n      #   @option options :default        The default value of the filter (if any)\n      #   @option options :skip_if        Value of the filter that will cause it to be skipped\n      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.\n      #\n      # If a Symbol is passed for the name the block should accept | current_expression, option_value |, while if a Regexp\n      # is passed for the name the block should accept | current_expression, option_name, option_value |. In either case\n      # the block should return the modified expression\n\n      def_delegators :@filter_set, :node_filter, :expression_filter, :filter\n\n      def locator_filter(*types, **options, &block)\n        types.each { |type| options[type] = true }\n        @locator_filter = Capybara::Selector::Filters::LocatorFilter.new(block, **options) if block\n        @locator_filter\n      end\n\n      def filter_set(name, filters_to_use = nil)\n        @filter_set.import(name, filters_to_use)\n      end\n\n      def_delegator :@filter_set, :describe\n\n      def describe_expression_filters(&block)\n        if block\n          describe(:expression_filters, &block)\n        else\n          describe(:expression_filters) do |**options|\n            describe_all_expression_filters(**options)\n          end\n        end\n      end\n\n      def describe_all_expression_filters(**opts)\n        expression_filters.map do |ef_name, ef|\n          if ef.matcher?\n            handled_custom_options(ef, opts).map { |option, value| \" with #{ef_name}[#{option} => #{value}]\" }.join\n          elsif opts.key?(ef_name)\n            \" with #{ef_name} #{opts[ef_name]}\"\n          end\n        end.join\n      end\n\n      def describe_node_filters(&block)\n        describe(:node_filters, &block)\n      end\n\n      ##\n      #\n      # Set the default visibility mode that should be used if no visible option is passed when using the selector.\n      # If not specified will default to the behavior indicated by Capybara.ignore_hidden_elements\n      #\n      # @param [Symbol] default_visibility  Only find elements with the specified visibility:\n      #                                              * :all - finds visible and invisible elements.\n      #                                              * :hidden - only finds invisible elements.\n      #                                              * :visible - only finds visible elements.\n      def visible(default_visibility = nil, &block)\n        @default_visibility = block || default_visibility\n      end\n\n      def default_visibility(fallback = Capybara.ignore_hidden_elements, options = {})\n        vis = if @default_visibility.respond_to?(:call)\n          @default_visibility.call(options)\n        else\n          @default_visibility\n        end\n        vis.nil? ? fallback : vis\n      end\n\n      # @api private\n      def raw_locator?\n        !!@raw_locator\n      end\n\n      # @api private\n      def supports_exact?\n        @supports_exact\n      end\n\n      def default_format\n        return nil if @expressions.keys.empty?\n\n        if @expressions.size == 1\n          @expressions.keys.first\n        else\n          :xpath\n        end\n      end\n\n      # @api private\n      def locator_types\n        return nil unless @locator_type\n\n        Array(@locator_type)\n      end\n\n    private\n\n      def handled_custom_options(filter, options)\n        options.select do |option, _|\n          filter.handles_option?(option) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(option)\n        end\n      end\n\n      def parameter_names(block)\n        key_types = %i[key keyreq]\n        # user filter_map when we drop dupport for 2.6\n        # block.parameters.select { |(type, _name)| key_types.include? type }.map { |(_, name)| name }\n        block.parameters.filter_map { |(type, name)| name if key_types.include? type }\n      end\n\n      def expression(type, allowed_filters, &block)\n        if block\n          @expressions[type] = block\n          allowed_filters = parameter_names(block) if allowed_filters.empty?\n          allowed_filters.flatten.each do |ef|\n            expression_filters[ef] = Capybara::Selector::Filters::IdentityExpressionFilter.new(ef)\n          end\n        end\n        @expressions[type]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)", "start_line": 16, "end_line": 30}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 76}
{"function_name": "expression", "file_path": "capybara/lib/capybara/selector/definition.rb", "focal_code": "def expression(type, allowed_filters, &block)\n        if block\n          @expressions[type] = block\n          allowed_filters = parameter_names(block) if allowed_filters.empty?\n          allowed_filters.flatten.each do |ef|\n            expression_filters[ef] = Capybara::Selector::Filters::IdentityExpressionFilter.new(ef)\n          end\n        end\n        @expressions[type]\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/filter_set'\nrequire 'capybara/selector/css'\nrequire 'capybara/selector/regexp_disassembler'\nrequire 'capybara/selector/builders/xpath_builder'\nrequire 'capybara/selector/builders/css_builder'\n\nmodule Capybara\n  class Selector\n    class Definition\n      attr_reader :name, :expressions\n\n      extend Forwardable\n\n      def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)\n        @name = name\n        @filter_set = Capybara::Selector::FilterSet.add(name)\n        @match = nil\n        @label = nil\n        @failure_message = nil\n        @expressions = {}\n        @expression_filters = {}\n        @locator_filter = nil\n        @default_visibility = nil\n        @locator_type = locator_type\n        @raw_locator = raw_locator\n        @supports_exact = supports_exact\n        instance_eval(&block)\n      end\n\n      def custom_filters\n        warn \"Deprecated: Selector#custom_filters is not valid when same named expression and node filter exist - don't use\"\n        node_filters.merge(expression_filters).freeze\n      end\n\n      def node_filters\n        @filter_set.node_filters\n      end\n\n      def expression_filters\n        @filter_set.expression_filters\n      end\n\n      ##\n      #\n      # Define a selector by an xpath expression\n      #\n      # @overload xpath(*expression_filters, &block)\n      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that are implemented via this expression, if not specified the names of any keyword parameters in the block will be used\n      #   @yield [locator, options]                       The block to use to generate the XPath expression\n      #   @yieldparam [String] locator                    The locator string passed to the query\n      #   @yieldparam [Hash] options                      The options hash passed to the query\n      #   @yieldreturn [#to_xpath, #to_s]                 An object that can produce an xpath expression\n      #\n      # @overload xpath()\n      # @return [#call]                             The block that will be called to generate the XPath expression\n      #\n      def xpath(*allowed_filters, &block)\n        expression(:xpath, allowed_filters, &block)\n      end\n\n      ##\n      #\n      # Define a selector by a CSS selector\n      #\n      # @overload css(*expression_filters, &block)\n      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that can be implemented via this CSS selector\n      #   @yield [locator, options]                   The block to use to generate the CSS selector\n      #   @yieldparam [String] locator               The locator string passed to the query\n      #   @yieldparam [Hash] options                 The options hash passed to the query\n      #   @yieldreturn [#to_s]                        An object that can produce a CSS selector\n      #\n      # @overload css()\n      # @return [#call]                             The block that will be called to generate the CSS selector\n      #\n      def css(*allowed_filters, &block)\n        expression(:css, allowed_filters, &block)\n      end\n\n      ##\n      #\n      # Automatic selector detection\n      #\n      # @yield [locator]                   This block takes the passed in locator string and returns whether or not it matches the selector\n      # @yieldparam [String], locator      The locator string used to determine if it matches the selector\n      # @yieldreturn [Boolean]             Whether this selector matches the locator string\n      # @return [#call]                    The block that will be used to detect selector match\n      #\n      def match(&block)\n        @match = block if block\n        @match\n      end\n\n      ##\n      #\n      # Set/get a descriptive label for the selector\n      #\n      # @overload label(label)\n      #   @param [String] label            A descriptive label for this selector - used in error messages\n      # @overload label()\n      # @return [String]                 The currently set label\n      #\n      def label(label = nil)\n        @label = label if label\n        @label\n      end\n\n      ##\n      #\n      # Description of the selector\n      #\n      # @!method description(options)\n      #   @param [Hash] options            The options of the query used to generate the description\n      #   @return [String]                 Description of the selector when used with the options passed\n      def_delegator :@filter_set, :description\n\n      ##\n      #\n      #  Should this selector be used for the passed in locator\n      #\n      #  This is used by the automatic selector selection mechanism when no selector type is passed to a selector query\n      #\n      # @param [String] locator     The locator passed to the query\n      # @return [Boolean]           Whether or not to use this selector\n      #\n      def match?(locator)\n        @match&.call(locator)\n      end\n\n      ##\n      #\n      # Define a node filter for use with this selector\n      #\n      # @!method node_filter(name, *types, options={}, &block)\n      #   @param [Symbol, Regexp] name            The filter name\n      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]\n      #   @param [Hash] options ({})      Options of the filter\n      #   @option options [Array<>] :valid_values Valid values for this filter\n      #   @option options :default        The default value of the filter (if any)\n      #   @option options :skip_if        Value of the filter that will cause it to be skipped\n      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.\n      #\n      # If a Symbol is passed for the name the block should accept | node, option_value |, while if a Regexp\n      # is passed for the name the block should accept | node, option_name, option_value |. In either case\n      # the block should return `true` if the node passes the filer or `false` if it doesn't\n\n      ##\n      #\n      # Define an expression filter for use with this selector\n      #\n      # @!method expression_filter(name, *types, matcher: nil, **options, &block)\n      #   @param [Symbol, Regexp] name            The filter name\n      #   @param [Regexp] matcher (nil)   A Regexp used to check whether a specific option is handled by this filter\n      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]\n      #   @param [Hash] options ({})      Options of the filter\n      #   @option options [Array<>] :valid_values Valid values for this filter\n      #   @option options :default        The default value of the filter (if any)\n      #   @option options :skip_if        Value of the filter that will cause it to be skipped\n      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.\n      #\n      # If a Symbol is passed for the name the block should accept | current_expression, option_value |, while if a Regexp\n      # is passed for the name the block should accept | current_expression, option_name, option_value |. In either case\n      # the block should return the modified expression\n\n      def_delegators :@filter_set, :node_filter, :expression_filter, :filter\n\n      def locator_filter(*types, **options, &block)\n        types.each { |type| options[type] = true }\n        @locator_filter = Capybara::Selector::Filters::LocatorFilter.new(block, **options) if block\n        @locator_filter\n      end\n\n      def filter_set(name, filters_to_use = nil)\n        @filter_set.import(name, filters_to_use)\n      end\n\n      def_delegator :@filter_set, :describe\n\n      def describe_expression_filters(&block)\n        if block\n          describe(:expression_filters, &block)\n        else\n          describe(:expression_filters) do |**options|\n            describe_all_expression_filters(**options)\n          end\n        end\n      end\n\n      def describe_all_expression_filters(**opts)\n        expression_filters.map do |ef_name, ef|\n          if ef.matcher?\n            handled_custom_options(ef, opts).map { |option, value| \" with #{ef_name}[#{option} => #{value}]\" }.join\n          elsif opts.key?(ef_name)\n            \" with #{ef_name} #{opts[ef_name]}\"\n          end\n        end.join\n      end\n\n      def describe_node_filters(&block)\n        describe(:node_filters, &block)\n      end\n\n      ##\n      #\n      # Set the default visibility mode that should be used if no visible option is passed when using the selector.\n      # If not specified will default to the behavior indicated by Capybara.ignore_hidden_elements\n      #\n      # @param [Symbol] default_visibility  Only find elements with the specified visibility:\n      #                                              * :all - finds visible and invisible elements.\n      #                                              * :hidden - only finds invisible elements.\n      #                                              * :visible - only finds visible elements.\n      def visible(default_visibility = nil, &block)\n        @default_visibility = block || default_visibility\n      end\n\n      def default_visibility(fallback = Capybara.ignore_hidden_elements, options = {})\n        vis = if @default_visibility.respond_to?(:call)\n          @default_visibility.call(options)\n        else\n          @default_visibility\n        end\n        vis.nil? ? fallback : vis\n      end\n\n      # @api private\n      def raw_locator?\n        !!@raw_locator\n      end\n\n      # @api private\n      def supports_exact?\n        @supports_exact\n      end\n\n      def default_format\n        return nil if @expressions.keys.empty?\n\n        if @expressions.size == 1\n          @expressions.keys.first\n        else\n          :xpath\n        end\n      end\n\n      # @api private\n      def locator_types\n        return nil unless @locator_type\n\n        Array(@locator_type)\n      end\n\n    private\n\n      def handled_custom_options(filter, options)\n        options.select do |option, _|\n          filter.handles_option?(option) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(option)\n        end\n      end\n\n      def parameter_names(block)\n        key_types = %i[key keyreq]\n        # user filter_map when we drop dupport for 2.6\n        # block.parameters.select { |(type, _name)| key_types.include? type }.map { |(_, name)| name }\n        block.parameters.filter_map { |(type, name)| name if key_types.include? type }\n      end\n\n      def expression(type, allowed_filters, &block)\n        if block\n          @expressions[type] = block\n          allowed_filters = parameter_names(block) if allowed_filters.empty?\n          allowed_filters.flatten.each do |ef|\n            expression_filters[ef] = Capybara::Selector::Filters::IdentityExpressionFilter.new(ef)\n          end\n        end\n        @expressions[type]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "expression", "signature": "def expression(type, allowed_filters, &block)", "start_line": 268, "end_line": 277}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 77}
{"function_name": "describe", "file_path": "capybara/lib/capybara/selector/filter_set.rb", "focal_code": "def describe(what = nil, &block)\n        case what\n        when nil\n          undeclared_descriptions.push block\n        when :node_filters\n          node_filter_descriptions.push block\n        when :expression_filters\n          expression_filter_descriptions.push block\n        else\n          raise ArgumentError, 'Unknown description type'\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/filter'\n\nmodule Capybara\n  class Selector\n    class FilterSet\n      attr_reader :node_filters, :expression_filters\n\n      def initialize(name, &block)\n        @name = name\n        @node_filters = {}\n        @expression_filters = {}\n        @descriptions = Hash.new { |hsh, key| hsh[key] = [] }\n        instance_eval(&block) if block\n      end\n\n      def node_filter(names, *types, **options, &block)\n        Array(names).each do |name|\n          add_filter(name, Filters::NodeFilter, *types, **options, &block)\n        end\n      end\n      alias_method :filter, :node_filter\n\n      def expression_filter(name, *types, **options, &block)\n        add_filter(name, Filters::ExpressionFilter, *types, **options, &block)\n      end\n\n      def describe(what = nil, &block)\n        case what\n        when nil\n          undeclared_descriptions.push block\n        when :node_filters\n          node_filter_descriptions.push block\n        when :expression_filters\n          expression_filter_descriptions.push block\n        else\n          raise ArgumentError, 'Unknown description type'\n        end\n      end\n\n      def description(node_filters: true, expression_filters: true, **options)\n        opts = options_with_defaults(options)\n        description = +''\n        description << undeclared_descriptions.map { |desc| desc.call(**opts).to_s }.join\n        description << expression_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if expression_filters\n        description << node_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if node_filters\n        description\n      end\n\n      def descriptions\n        Capybara::Helpers.warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'\n        [undeclared_descriptions, node_filter_descriptions, expression_filter_descriptions].flatten\n      end\n\n      def import(name, filters = nil)\n        filter_selector = filters.nil? ? ->(*) { true } : ->(filter_name, _) { filters.include? filter_name }\n\n        self.class[name].tap do |f_set|\n          expression_filters.merge!(f_set.expression_filters.select(&filter_selector))\n          node_filters.merge!(f_set.node_filters.select(&filter_selector))\n          f_set.undeclared_descriptions.each { |desc| describe(&desc) }\n          f_set.expression_filter_descriptions.each { |desc| describe(:expression_filters, &desc) }\n          f_set.node_filter_descriptions.each { |desc| describe(:node_filters, &desc) }\n        end\n        self\n      end\n\n      class << self\n        def all\n          @filter_sets ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName\n        end\n\n        def [](name)\n          all.fetch(name.to_sym) { |set_name| raise ArgumentError, \"Unknown filter set (:#{set_name})\" }\n        end\n\n        def add(name, &block)\n          all[name.to_sym] = FilterSet.new(name.to_sym, &block)\n        end\n\n        def remove(name)\n          all.delete(name.to_sym)\n        end\n      end\n\n    protected\n\n      def undeclared_descriptions\n        @descriptions[:undeclared]\n      end\n\n      def node_filter_descriptions\n        @descriptions[:node_filters]\n      end\n\n      def expression_filter_descriptions\n        @descriptions[:expression_filters]\n      end\n\n    private\n\n      def options_with_defaults(options)\n        expression_filters\n          .chain(node_filters)\n          .filter_map { |name, filter| [name, filter.default] if filter.default? }\n          .to_h.merge!(options)\n      end\n\n      def add_filter(name, filter_class, *types, matcher: nil, **options, &block)\n        types.each { |type| options[type] = true }\n        if matcher && options[:default]\n          raise 'ArgumentError', ':default option is not supported for filters with a :matcher option'\n        end\n\n        filter = filter_class.new(name, matcher, block, **options)\n        (filter_class <= Filters::ExpressionFilter ? @expression_filters : @node_filters)[name] = filter\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "describe", "signature": "def describe(what = nil, &block)", "start_line": 29, "end_line": 40}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 78}
{"function_name": "import", "file_path": "capybara/lib/capybara/selector/filter_set.rb", "focal_code": "def import(name, filters = nil)\n        filter_selector = filters.nil? ? ->(*) { true } : ->(filter_name, _) { filters.include? filter_name }\n\n        self.class[name].tap do |f_set|\n          expression_filters.merge!(f_set.expression_filters.select(&filter_selector))\n          node_filters.merge!(f_set.node_filters.select(&filter_selector))\n          f_set.undeclared_descriptions.each { |desc| describe(&desc) }\n          f_set.expression_filter_descriptions.each { |desc| describe(:expression_filters, &desc) }\n          f_set.node_filter_descriptions.each { |desc| describe(:node_filters, &desc) }\n        end\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/filter'\n\nmodule Capybara\n  class Selector\n    class FilterSet\n      attr_reader :node_filters, :expression_filters\n\n      def initialize(name, &block)\n        @name = name\n        @node_filters = {}\n        @expression_filters = {}\n        @descriptions = Hash.new { |hsh, key| hsh[key] = [] }\n        instance_eval(&block) if block\n      end\n\n      def node_filter(names, *types, **options, &block)\n        Array(names).each do |name|\n          add_filter(name, Filters::NodeFilter, *types, **options, &block)\n        end\n      end\n      alias_method :filter, :node_filter\n\n      def expression_filter(name, *types, **options, &block)\n        add_filter(name, Filters::ExpressionFilter, *types, **options, &block)\n      end\n\n      def describe(what = nil, &block)\n        case what\n        when nil\n          undeclared_descriptions.push block\n        when :node_filters\n          node_filter_descriptions.push block\n        when :expression_filters\n          expression_filter_descriptions.push block\n        else\n          raise ArgumentError, 'Unknown description type'\n        end\n      end\n\n      def description(node_filters: true, expression_filters: true, **options)\n        opts = options_with_defaults(options)\n        description = +''\n        description << undeclared_descriptions.map { |desc| desc.call(**opts).to_s }.join\n        description << expression_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if expression_filters\n        description << node_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if node_filters\n        description\n      end\n\n      def descriptions\n        Capybara::Helpers.warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'\n        [undeclared_descriptions, node_filter_descriptions, expression_filter_descriptions].flatten\n      end\n\n      def import(name, filters = nil)\n        filter_selector = filters.nil? ? ->(*) { true } : ->(filter_name, _) { filters.include? filter_name }\n\n        self.class[name].tap do |f_set|\n          expression_filters.merge!(f_set.expression_filters.select(&filter_selector))\n          node_filters.merge!(f_set.node_filters.select(&filter_selector))\n          f_set.undeclared_descriptions.each { |desc| describe(&desc) }\n          f_set.expression_filter_descriptions.each { |desc| describe(:expression_filters, &desc) }\n          f_set.node_filter_descriptions.each { |desc| describe(:node_filters, &desc) }\n        end\n        self\n      end\n\n      class << self\n        def all\n          @filter_sets ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName\n        end\n\n        def [](name)\n          all.fetch(name.to_sym) { |set_name| raise ArgumentError, \"Unknown filter set (:#{set_name})\" }\n        end\n\n        def add(name, &block)\n          all[name.to_sym] = FilterSet.new(name.to_sym, &block)\n        end\n\n        def remove(name)\n          all.delete(name.to_sym)\n        end\n      end\n\n    protected\n\n      def undeclared_descriptions\n        @descriptions[:undeclared]\n      end\n\n      def node_filter_descriptions\n        @descriptions[:node_filters]\n      end\n\n      def expression_filter_descriptions\n        @descriptions[:expression_filters]\n      end\n\n    private\n\n      def options_with_defaults(options)\n        expression_filters\n          .chain(node_filters)\n          .filter_map { |name, filter| [name, filter.default] if filter.default? }\n          .to_h.merge!(options)\n      end\n\n      def add_filter(name, filter_class, *types, matcher: nil, **options, &block)\n        types.each { |type| options[type] = true }\n        if matcher && options[:default]\n          raise 'ArgumentError', ':default option is not supported for filters with a :matcher option'\n        end\n\n        filter = filter_class.new(name, matcher, block, **options)\n        (filter_class <= Filters::ExpressionFilter ? @expression_filters : @node_filters)[name] = filter\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "import", "signature": "def import(name, filters = nil)", "start_line": 56, "end_line": 67}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 79}
{"function_name": "combine", "file_path": "capybara/lib/capybara/selector/regexp_disassembler.rb", "focal_code": "def combine(strs)\n        suffixes = [[]]\n        strs.reverse_each do |str|\n          if str.is_a? Set\n            prefixes = str.flat_map { |s| combine(s) }\n            suffixes = prefixes.product(suffixes).map { |pair| pair.flatten(1) }\n          else\n            suffixes.each { |arr| arr.unshift str }\n          end\n        end\n        suffixes\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'regexp_parser'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class RegexpDisassembler\n      def initialize(regexp)\n        @regexp = regexp\n      end\n\n      def alternated_substrings\n        @alternated_substrings ||= begin\n          or_strings = process(alternation: true)\n          remove_or_covered(or_strings)\n          or_strings.any?(&:empty?) ? [] : or_strings\n        end\n      end\n\n      def substrings\n        @substrings ||= begin\n          strs = process(alternation: false).first\n          remove_and_covered(strs)\n        end\n      end\n\n    private\n\n      def remove_and_covered(strings)\n        # delete_if is documented to modify the array after every block iteration - this doesn't appear to be true\n        # uniq the strings to prevent identical strings from removing each other\n        strings.uniq!\n\n        # If we have \"ab\" and \"abcd\" required - only need to check for \"abcd\"\n        strings.delete_if do |sub_string|\n          strings.any? do |cover_string|\n            next if sub_string.equal? cover_string\n\n            cover_string.include?(sub_string)\n          end\n        end\n      end\n\n      def remove_or_covered(or_series)\n        # If we are going to match `(\"a\" and \"b\") or (\"ade\" and \"bce\")` it only makes sense to match (\"a\" and \"b\")\n\n        # Ensure minimum sets of strings are being or'd\n        or_series.each { |strs| remove_and_covered(strs) }\n\n        # Remove any of the alternated string series that fully contain any other string series\n        or_series.delete_if do |and_strs|\n          or_series.any? do |and_strs2|\n            next if and_strs.equal? and_strs2\n\n            remove_and_covered(and_strs + and_strs2) == and_strs\n          end\n        end\n      end\n\n      def process(alternation:)\n        strs = extract_strings(Regexp::Parser.parse(@regexp), alternation: alternation)\n        strs = collapse(combine(strs).map(&:flatten))\n        strs.each { |str| str.map!(&:upcase) } if @regexp.casefold?\n        strs\n      end\n\n      def combine(strs)\n        suffixes = [[]]\n        strs.reverse_each do |str|\n          if str.is_a? Set\n            prefixes = str.flat_map { |s| combine(s) }\n            suffixes = prefixes.product(suffixes).map { |pair| pair.flatten(1) }\n          else\n            suffixes.each { |arr| arr.unshift str }\n          end\n        end\n        suffixes\n      end\n\n      def collapse(strs)\n        strs.map do |substrings|\n          substrings.slice_before(&:nil?).map(&:join).reject(&:empty?).uniq\n        end\n      end\n\n      def extract_strings(expression, alternation: false)\n        Expression.new(expression).extract_strings(alternation)\n      end\n\n      # @api private\n      class Expression\n        def initialize(exp)\n          @exp = exp\n        end\n\n        def extract_strings(process_alternatives)\n          strings = []\n          each do |exp|\n            next if exp.ignore?\n\n            next strings.push(nil) if exp.optional? && !process_alternatives\n\n            next strings.push(exp.alternative_strings) if exp.alternation? && process_alternatives\n\n            strings.concat(exp.strings(process_alternatives))\n          end\n          strings\n        end\n\n      protected\n\n        def alternation?\n          (type == :meta) && !terminal?\n        end\n\n        def optional?\n          min_repeat.zero?\n        end\n\n        def terminal?\n          @exp.terminal?\n        end\n\n        def strings(process_alternatives)\n          if indeterminate?\n            [nil]\n          elsif terminal?\n            terminal_strings\n          elsif optional?\n            optional_strings\n          else\n            repeated_strings(process_alternatives)\n          end\n        end\n\n        def terminal_strings\n          text = case @exp.type\n          when :literal then @exp.text\n          when :escape then @exp.char\n          else\n            return [nil]\n          end\n\n          optional? ? options_set(text) : repeat_set(text)\n        end\n\n        def optional_strings\n          options_set(extract_strings(true))\n        end\n\n        def repeated_strings(process_alternatives)\n          repeat_set extract_strings(process_alternatives)\n        end\n\n        def alternative_strings\n          alts = alternatives.map { |sub_exp| sub_exp.extract_strings(alternation: true) }\n          alts.all?(&:any?) ? Set.new(alts) : nil\n        end\n\n        def ignore?\n          [Regexp::Expression::Assertion::NegativeLookahead,\n           Regexp::Expression::Assertion::NegativeLookbehind].any? { |klass| @exp.is_a? klass }\n        end\n\n      private\n\n        def indeterminate?\n          %i[meta set].include?(type)\n        end\n\n        def min_repeat\n          @exp.repetitions.begin\n        end\n\n        def max_repeat\n          @exp.repetitions.end\n        end\n\n        def fixed_repeat?\n          min_repeat == max_repeat\n        end\n\n        def type\n          @exp.type\n        end\n\n        def repeat_set(str)\n          strs = Array(str * min_repeat)\n          strs.push(nil) unless fixed_repeat?\n          strs\n        end\n\n        def options_set(strs)\n          strs = [Set.new([[''], Array(strs)])]\n          strs.push(nil) unless max_repeat == 1\n          strs\n        end\n\n        def alternatives\n          @exp.alternatives.map { |exp| Expression.new(exp) }\n        end\n\n        def each\n          @exp.each { |exp| yield Expression.new(exp) }\n        end\n      end\n      private_constant :Expression\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "combine", "signature": "def combine(strs)", "start_line": 68, "end_line": 79}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 80}
{"function_name": "extract_strings", "file_path": "capybara/lib/capybara/selector/regexp_disassembler.rb", "focal_code": "def extract_strings(process_alternatives)\n          strings = []\n          each do |exp|\n            next if exp.ignore?\n\n            next strings.push(nil) if exp.optional? && !process_alternatives\n\n            next strings.push(exp.alternative_strings) if exp.alternation? && process_alternatives\n\n            strings.concat(exp.strings(process_alternatives))\n          end\n          strings\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'regexp_parser'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class RegexpDisassembler\n      def initialize(regexp)\n        @regexp = regexp\n      end\n\n      def alternated_substrings\n        @alternated_substrings ||= begin\n          or_strings = process(alternation: true)\n          remove_or_covered(or_strings)\n          or_strings.any?(&:empty?) ? [] : or_strings\n        end\n      end\n\n      def substrings\n        @substrings ||= begin\n          strs = process(alternation: false).first\n          remove_and_covered(strs)\n        end\n      end\n\n    private\n\n      def remove_and_covered(strings)\n        # delete_if is documented to modify the array after every block iteration - this doesn't appear to be true\n        # uniq the strings to prevent identical strings from removing each other\n        strings.uniq!\n\n        # If we have \"ab\" and \"abcd\" required - only need to check for \"abcd\"\n        strings.delete_if do |sub_string|\n          strings.any? do |cover_string|\n            next if sub_string.equal? cover_string\n\n            cover_string.include?(sub_string)\n          end\n        end\n      end\n\n      def remove_or_covered(or_series)\n        # If we are going to match `(\"a\" and \"b\") or (\"ade\" and \"bce\")` it only makes sense to match (\"a\" and \"b\")\n\n        # Ensure minimum sets of strings are being or'd\n        or_series.each { |strs| remove_and_covered(strs) }\n\n        # Remove any of the alternated string series that fully contain any other string series\n        or_series.delete_if do |and_strs|\n          or_series.any? do |and_strs2|\n            next if and_strs.equal? and_strs2\n\n            remove_and_covered(and_strs + and_strs2) == and_strs\n          end\n        end\n      end\n\n      def process(alternation:)\n        strs = extract_strings(Regexp::Parser.parse(@regexp), alternation: alternation)\n        strs = collapse(combine(strs).map(&:flatten))\n        strs.each { |str| str.map!(&:upcase) } if @regexp.casefold?\n        strs\n      end\n\n      def combine(strs)\n        suffixes = [[]]\n        strs.reverse_each do |str|\n          if str.is_a? Set\n            prefixes = str.flat_map { |s| combine(s) }\n            suffixes = prefixes.product(suffixes).map { |pair| pair.flatten(1) }\n          else\n            suffixes.each { |arr| arr.unshift str }\n          end\n        end\n        suffixes\n      end\n\n      def collapse(strs)\n        strs.map do |substrings|\n          substrings.slice_before(&:nil?).map(&:join).reject(&:empty?).uniq\n        end\n      end\n\n      def extract_strings(expression, alternation: false)\n        Expression.new(expression).extract_strings(alternation)\n      end\n\n      # @api private\n      class Expression\n        def initialize(exp)\n          @exp = exp\n        end\n\n        def extract_strings(process_alternatives)\n          strings = []\n          each do |exp|\n            next if exp.ignore?\n\n            next strings.push(nil) if exp.optional? && !process_alternatives\n\n            next strings.push(exp.alternative_strings) if exp.alternation? && process_alternatives\n\n            strings.concat(exp.strings(process_alternatives))\n          end\n          strings\n        end\n\n      protected\n\n        def alternation?\n          (type == :meta) && !terminal?\n        end\n\n        def optional?\n          min_repeat.zero?\n        end\n\n        def terminal?\n          @exp.terminal?\n        end\n\n        def strings(process_alternatives)\n          if indeterminate?\n            [nil]\n          elsif terminal?\n            terminal_strings\n          elsif optional?\n            optional_strings\n          else\n            repeated_strings(process_alternatives)\n          end\n        end\n\n        def terminal_strings\n          text = case @exp.type\n          when :literal then @exp.text\n          when :escape then @exp.char\n          else\n            return [nil]\n          end\n\n          optional? ? options_set(text) : repeat_set(text)\n        end\n\n        def optional_strings\n          options_set(extract_strings(true))\n        end\n\n        def repeated_strings(process_alternatives)\n          repeat_set extract_strings(process_alternatives)\n        end\n\n        def alternative_strings\n          alts = alternatives.map { |sub_exp| sub_exp.extract_strings(alternation: true) }\n          alts.all?(&:any?) ? Set.new(alts) : nil\n        end\n\n        def ignore?\n          [Regexp::Expression::Assertion::NegativeLookahead,\n           Regexp::Expression::Assertion::NegativeLookbehind].any? { |klass| @exp.is_a? klass }\n        end\n\n      private\n\n        def indeterminate?\n          %i[meta set].include?(type)\n        end\n\n        def min_repeat\n          @exp.repetitions.begin\n        end\n\n        def max_repeat\n          @exp.repetitions.end\n        end\n\n        def fixed_repeat?\n          min_repeat == max_repeat\n        end\n\n        def type\n          @exp.type\n        end\n\n        def repeat_set(str)\n          strs = Array(str * min_repeat)\n          strs.push(nil) unless fixed_repeat?\n          strs\n        end\n\n        def options_set(strs)\n          strs = [Set.new([[''], Array(strs)])]\n          strs.push(nil) unless max_repeat == 1\n          strs\n        end\n\n        def alternatives\n          @exp.alternatives.map { |exp| Expression.new(exp) }\n        end\n\n        def each\n          @exp.each { |exp| yield Expression.new(exp) }\n        end\n      end\n      private_constant :Expression\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "extract_strings", "signature": "def extract_strings(process_alternatives)", "start_line": 97, "end_line": 109}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 81}
{"function_name": "strings", "file_path": "capybara/lib/capybara/selector/regexp_disassembler.rb", "focal_code": "def strings(process_alternatives)\n          if indeterminate?\n            [nil]\n          elsif terminal?\n            terminal_strings\n          elsif optional?\n            optional_strings\n          else\n            repeated_strings(process_alternatives)\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'regexp_parser'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class RegexpDisassembler\n      def initialize(regexp)\n        @regexp = regexp\n      end\n\n      def alternated_substrings\n        @alternated_substrings ||= begin\n          or_strings = process(alternation: true)\n          remove_or_covered(or_strings)\n          or_strings.any?(&:empty?) ? [] : or_strings\n        end\n      end\n\n      def substrings\n        @substrings ||= begin\n          strs = process(alternation: false).first\n          remove_and_covered(strs)\n        end\n      end\n\n    private\n\n      def remove_and_covered(strings)\n        # delete_if is documented to modify the array after every block iteration - this doesn't appear to be true\n        # uniq the strings to prevent identical strings from removing each other\n        strings.uniq!\n\n        # If we have \"ab\" and \"abcd\" required - only need to check for \"abcd\"\n        strings.delete_if do |sub_string|\n          strings.any? do |cover_string|\n            next if sub_string.equal? cover_string\n\n            cover_string.include?(sub_string)\n          end\n        end\n      end\n\n      def remove_or_covered(or_series)\n        # If we are going to match `(\"a\" and \"b\") or (\"ade\" and \"bce\")` it only makes sense to match (\"a\" and \"b\")\n\n        # Ensure minimum sets of strings are being or'd\n        or_series.each { |strs| remove_and_covered(strs) }\n\n        # Remove any of the alternated string series that fully contain any other string series\n        or_series.delete_if do |and_strs|\n          or_series.any? do |and_strs2|\n            next if and_strs.equal? and_strs2\n\n            remove_and_covered(and_strs + and_strs2) == and_strs\n          end\n        end\n      end\n\n      def process(alternation:)\n        strs = extract_strings(Regexp::Parser.parse(@regexp), alternation: alternation)\n        strs = collapse(combine(strs).map(&:flatten))\n        strs.each { |str| str.map!(&:upcase) } if @regexp.casefold?\n        strs\n      end\n\n      def combine(strs)\n        suffixes = [[]]\n        strs.reverse_each do |str|\n          if str.is_a? Set\n            prefixes = str.flat_map { |s| combine(s) }\n            suffixes = prefixes.product(suffixes).map { |pair| pair.flatten(1) }\n          else\n            suffixes.each { |arr| arr.unshift str }\n          end\n        end\n        suffixes\n      end\n\n      def collapse(strs)\n        strs.map do |substrings|\n          substrings.slice_before(&:nil?).map(&:join).reject(&:empty?).uniq\n        end\n      end\n\n      def extract_strings(expression, alternation: false)\n        Expression.new(expression).extract_strings(alternation)\n      end\n\n      # @api private\n      class Expression\n        def initialize(exp)\n          @exp = exp\n        end\n\n        def extract_strings(process_alternatives)\n          strings = []\n          each do |exp|\n            next if exp.ignore?\n\n            next strings.push(nil) if exp.optional? && !process_alternatives\n\n            next strings.push(exp.alternative_strings) if exp.alternation? && process_alternatives\n\n            strings.concat(exp.strings(process_alternatives))\n          end\n          strings\n        end\n\n      protected\n\n        def alternation?\n          (type == :meta) && !terminal?\n        end\n\n        def optional?\n          min_repeat.zero?\n        end\n\n        def terminal?\n          @exp.terminal?\n        end\n\n        def strings(process_alternatives)\n          if indeterminate?\n            [nil]\n          elsif terminal?\n            terminal_strings\n          elsif optional?\n            optional_strings\n          else\n            repeated_strings(process_alternatives)\n          end\n        end\n\n        def terminal_strings\n          text = case @exp.type\n          when :literal then @exp.text\n          when :escape then @exp.char\n          else\n            return [nil]\n          end\n\n          optional? ? options_set(text) : repeat_set(text)\n        end\n\n        def optional_strings\n          options_set(extract_strings(true))\n        end\n\n        def repeated_strings(process_alternatives)\n          repeat_set extract_strings(process_alternatives)\n        end\n\n        def alternative_strings\n          alts = alternatives.map { |sub_exp| sub_exp.extract_strings(alternation: true) }\n          alts.all?(&:any?) ? Set.new(alts) : nil\n        end\n\n        def ignore?\n          [Regexp::Expression::Assertion::NegativeLookahead,\n           Regexp::Expression::Assertion::NegativeLookbehind].any? { |klass| @exp.is_a? klass }\n        end\n\n      private\n\n        def indeterminate?\n          %i[meta set].include?(type)\n        end\n\n        def min_repeat\n          @exp.repetitions.begin\n        end\n\n        def max_repeat\n          @exp.repetitions.end\n        end\n\n        def fixed_repeat?\n          min_repeat == max_repeat\n        end\n\n        def type\n          @exp.type\n        end\n\n        def repeat_set(str)\n          strs = Array(str * min_repeat)\n          strs.push(nil) unless fixed_repeat?\n          strs\n        end\n\n        def options_set(strs)\n          strs = [Set.new([[''], Array(strs)])]\n          strs.push(nil) unless max_repeat == 1\n          strs\n        end\n\n        def alternatives\n          @exp.alternatives.map { |exp| Expression.new(exp) }\n        end\n\n        def each\n          @exp.each { |exp| yield Expression.new(exp) }\n        end\n      end\n      private_constant :Expression\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "strings", "signature": "def strings(process_alternatives)", "start_line": 125, "end_line": 135}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 82}
{"function_name": "call", "file_path": "capybara/lib/capybara/selector/selector.rb", "focal_code": "def call(locator, **options)\n      if format\n        raise ArgumentError, \"Selector #{@name} does not support #{format}\" unless expressions.key?(format)\n\n        instance_exec(locator, **options, &expressions[format])\n      else\n        warn 'Selector has no format'\n      end\n    ensure\n      unless locator_valid?(locator)\n        Capybara::Helpers.warn(\n          \"Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. \" \\\n          'This will raise an error in a future version of Capybara. ' \\\n          \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n        )\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Selector < SimpleDelegator\n    class << self\n      def all\n        @definitions ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName\n      end\n\n      def [](name)\n        all.fetch(name.to_sym) { |sel_type| raise ArgumentError, \"Unknown selector type (:#{sel_type})\" }\n      end\n\n      def add(name, **options, &block)\n        all[name.to_sym] = Definition.new(name.to_sym, **options, &block)\n      end\n\n      def update(name, &block)\n        self[name].instance_eval(&block)\n      end\n\n      def remove(name)\n        all.delete(name.to_sym)\n      end\n\n      def for(locator)\n        all.values.find { |sel| sel.match?(locator) }\n      end\n    end\n\n    attr_reader :errors\n\n    def initialize(definition, config:, format:)\n      definition = self.class[definition] unless definition.is_a? Definition\n      super(definition)\n      @definition = definition\n      @config = config\n      @format = format\n      @errors = []\n    end\n\n    def format\n      @format || @definition.default_format\n    end\n    alias_method :current_format, :format\n\n    def enable_aria_label\n      @config[:enable_aria_label]\n    end\n\n    def enable_aria_role\n      @config[:enable_aria_role]\n    end\n\n    def test_id\n      @config[:test_id]\n    end\n\n    def call(locator, **options)\n      if format\n        raise ArgumentError, \"Selector #{@name} does not support #{format}\" unless expressions.key?(format)\n\n        instance_exec(locator, **options, &expressions[format])\n      else\n        warn 'Selector has no format'\n      end\n    ensure\n      unless locator_valid?(locator)\n        Capybara::Helpers.warn(\n          \"Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. \" \\\n          'This will raise an error in a future version of Capybara. ' \\\n          \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n        )\n      end\n    end\n\n    def add_error(error_msg)\n      errors << error_msg\n    end\n\n    def expression_for(name, locator, config: @config, format: current_format, **options)\n      Selector.new(name, config: config, format: format).call(locator, **options)\n    end\n\n    # @api private\n    def with_filter_errors(errors)\n      old_errors = @errors\n      @errors = errors\n      yield\n    ensure\n      @errors = old_errors\n    end\n\n    # @api private\n    def builder(expr = nil)\n      case format\n      when :css\n        Capybara::Selector::CSSBuilder\n      when :xpath\n        Capybara::Selector::XPathBuilder\n      else\n        raise NotImplementedError, \"No builder exists for selector of type #{default_format}\"\n      end.new(expr)\n    end\n\n  private\n\n    def locator_description\n      locator_types.group_by { |lt| lt.is_a? Symbol }.map do |symbol, types_or_methods|\n        if symbol\n          \"respond to #{types_or_methods.join(' or ')}\"\n        else\n          \"be an instance of #{types_or_methods.join(' or ')}\"\n        end\n      end.join(' or ')\n    end\n\n    def locator_valid?(locator)\n      return true unless locator && locator_types\n\n      locator_types&.any? do |type_or_method|\n        type_or_method.is_a?(Symbol) ? locator.respond_to?(type_or_method) : type_or_method === locator # rubocop:disable Style/CaseEquality\n      end\n    end\n\n    def locate_field(xpath, locator, **_options)\n      return xpath if locator.nil?\n\n      locate_xpath = xpath # Need to save original xpath for the label wrap\n      locator = locator.to_s\n      attr_matchers = [XPath.attr(:id) == locator,\n                       XPath.attr(:name) == locator,\n                       XPath.attr(:placeholder) == locator,\n                       XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)\n      attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label\n      attr_matchers |= XPath.attr(test_id) == locator if test_id\n\n      locate_xpath = locate_xpath[attr_matchers]\n      locate_xpath + locate_label(locator).descendant(xpath)\n    end\n\n    def locate_label(locator)\n      XPath.descendant(:label)[XPath.string.n.is(locator)]\n    end\n\n    def find_by_attr(attribute, value)\n      finder_name = \"find_by_#{attribute}_attr\"\n      if respond_to?(finder_name, true)\n        send(finder_name, value)\n      else\n        value ? XPath.attr(attribute) == value : nil\n      end\n    end\n\n    def find_by_class_attr(classes)\n      Array(classes).map { |klass| XPath.attr(:class).contains_word(klass) }.reduce(:&)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(locator, **options)", "start_line": 59, "end_line": 75}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector < < SimpleDelegator"}, "task_id": 83}
{"function_name": "builder", "file_path": "capybara/lib/capybara/selector/selector.rb", "focal_code": "def builder(expr = nil)\n      case format\n      when :css\n        Capybara::Selector::CSSBuilder\n      when :xpath\n        Capybara::Selector::XPathBuilder\n      else\n        raise NotImplementedError, \"No builder exists for selector of type #{default_format}\"\n      end.new(expr)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Selector < SimpleDelegator\n    class << self\n      def all\n        @definitions ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName\n      end\n\n      def [](name)\n        all.fetch(name.to_sym) { |sel_type| raise ArgumentError, \"Unknown selector type (:#{sel_type})\" }\n      end\n\n      def add(name, **options, &block)\n        all[name.to_sym] = Definition.new(name.to_sym, **options, &block)\n      end\n\n      def update(name, &block)\n        self[name].instance_eval(&block)\n      end\n\n      def remove(name)\n        all.delete(name.to_sym)\n      end\n\n      def for(locator)\n        all.values.find { |sel| sel.match?(locator) }\n      end\n    end\n\n    attr_reader :errors\n\n    def initialize(definition, config:, format:)\n      definition = self.class[definition] unless definition.is_a? Definition\n      super(definition)\n      @definition = definition\n      @config = config\n      @format = format\n      @errors = []\n    end\n\n    def format\n      @format || @definition.default_format\n    end\n    alias_method :current_format, :format\n\n    def enable_aria_label\n      @config[:enable_aria_label]\n    end\n\n    def enable_aria_role\n      @config[:enable_aria_role]\n    end\n\n    def test_id\n      @config[:test_id]\n    end\n\n    def call(locator, **options)\n      if format\n        raise ArgumentError, \"Selector #{@name} does not support #{format}\" unless expressions.key?(format)\n\n        instance_exec(locator, **options, &expressions[format])\n      else\n        warn 'Selector has no format'\n      end\n    ensure\n      unless locator_valid?(locator)\n        Capybara::Helpers.warn(\n          \"Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. \" \\\n          'This will raise an error in a future version of Capybara. ' \\\n          \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n        )\n      end\n    end\n\n    def add_error(error_msg)\n      errors << error_msg\n    end\n\n    def expression_for(name, locator, config: @config, format: current_format, **options)\n      Selector.new(name, config: config, format: format).call(locator, **options)\n    end\n\n    # @api private\n    def with_filter_errors(errors)\n      old_errors = @errors\n      @errors = errors\n      yield\n    ensure\n      @errors = old_errors\n    end\n\n    # @api private\n    def builder(expr = nil)\n      case format\n      when :css\n        Capybara::Selector::CSSBuilder\n      when :xpath\n        Capybara::Selector::XPathBuilder\n      else\n        raise NotImplementedError, \"No builder exists for selector of type #{default_format}\"\n      end.new(expr)\n    end\n\n  private\n\n    def locator_description\n      locator_types.group_by { |lt| lt.is_a? Symbol }.map do |symbol, types_or_methods|\n        if symbol\n          \"respond to #{types_or_methods.join(' or ')}\"\n        else\n          \"be an instance of #{types_or_methods.join(' or ')}\"\n        end\n      end.join(' or ')\n    end\n\n    def locator_valid?(locator)\n      return true unless locator && locator_types\n\n      locator_types&.any? do |type_or_method|\n        type_or_method.is_a?(Symbol) ? locator.respond_to?(type_or_method) : type_or_method === locator # rubocop:disable Style/CaseEquality\n      end\n    end\n\n    def locate_field(xpath, locator, **_options)\n      return xpath if locator.nil?\n\n      locate_xpath = xpath # Need to save original xpath for the label wrap\n      locator = locator.to_s\n      attr_matchers = [XPath.attr(:id) == locator,\n                       XPath.attr(:name) == locator,\n                       XPath.attr(:placeholder) == locator,\n                       XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)\n      attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label\n      attr_matchers |= XPath.attr(test_id) == locator if test_id\n\n      locate_xpath = locate_xpath[attr_matchers]\n      locate_xpath + locate_label(locator).descendant(xpath)\n    end\n\n    def locate_label(locator)\n      XPath.descendant(:label)[XPath.string.n.is(locator)]\n    end\n\n    def find_by_attr(attribute, value)\n      finder_name = \"find_by_#{attribute}_attr\"\n      if respond_to?(finder_name, true)\n        send(finder_name, value)\n      else\n        value ? XPath.attr(attribute) == value : nil\n      end\n    end\n\n    def find_by_class_attr(classes)\n      Array(classes).map { |klass| XPath.attr(:class).contains_word(klass) }.reduce(:&)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "builder", "signature": "def builder(expr = nil)", "start_line": 95, "end_line": 104}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector < < SimpleDelegator"}, "task_id": 84}
{"function_name": "locate_field", "file_path": "capybara/lib/capybara/selector/selector.rb", "focal_code": "def locate_field(xpath, locator, **_options)\n      return xpath if locator.nil?\n\n      locate_xpath = xpath # Need to save original xpath for the label wrap\n      locator = locator.to_s\n      attr_matchers = [XPath.attr(:id) == locator,\n                       XPath.attr(:name) == locator,\n                       XPath.attr(:placeholder) == locator,\n                       XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)\n      attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label\n      attr_matchers |= XPath.attr(test_id) == locator if test_id\n\n      locate_xpath = locate_xpath[attr_matchers]\n      locate_xpath + locate_label(locator).descendant(xpath)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Selector < SimpleDelegator\n    class << self\n      def all\n        @definitions ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName\n      end\n\n      def [](name)\n        all.fetch(name.to_sym) { |sel_type| raise ArgumentError, \"Unknown selector type (:#{sel_type})\" }\n      end\n\n      def add(name, **options, &block)\n        all[name.to_sym] = Definition.new(name.to_sym, **options, &block)\n      end\n\n      def update(name, &block)\n        self[name].instance_eval(&block)\n      end\n\n      def remove(name)\n        all.delete(name.to_sym)\n      end\n\n      def for(locator)\n        all.values.find { |sel| sel.match?(locator) }\n      end\n    end\n\n    attr_reader :errors\n\n    def initialize(definition, config:, format:)\n      definition = self.class[definition] unless definition.is_a? Definition\n      super(definition)\n      @definition = definition\n      @config = config\n      @format = format\n      @errors = []\n    end\n\n    def format\n      @format || @definition.default_format\n    end\n    alias_method :current_format, :format\n\n    def enable_aria_label\n      @config[:enable_aria_label]\n    end\n\n    def enable_aria_role\n      @config[:enable_aria_role]\n    end\n\n    def test_id\n      @config[:test_id]\n    end\n\n    def call(locator, **options)\n      if format\n        raise ArgumentError, \"Selector #{@name} does not support #{format}\" unless expressions.key?(format)\n\n        instance_exec(locator, **options, &expressions[format])\n      else\n        warn 'Selector has no format'\n      end\n    ensure\n      unless locator_valid?(locator)\n        Capybara::Helpers.warn(\n          \"Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. \" \\\n          'This will raise an error in a future version of Capybara. ' \\\n          \"Called from: #{Capybara::Helpers.filter_backtrace(caller)}\"\n        )\n      end\n    end\n\n    def add_error(error_msg)\n      errors << error_msg\n    end\n\n    def expression_for(name, locator, config: @config, format: current_format, **options)\n      Selector.new(name, config: config, format: format).call(locator, **options)\n    end\n\n    # @api private\n    def with_filter_errors(errors)\n      old_errors = @errors\n      @errors = errors\n      yield\n    ensure\n      @errors = old_errors\n    end\n\n    # @api private\n    def builder(expr = nil)\n      case format\n      when :css\n        Capybara::Selector::CSSBuilder\n      when :xpath\n        Capybara::Selector::XPathBuilder\n      else\n        raise NotImplementedError, \"No builder exists for selector of type #{default_format}\"\n      end.new(expr)\n    end\n\n  private\n\n    def locator_description\n      locator_types.group_by { |lt| lt.is_a? Symbol }.map do |symbol, types_or_methods|\n        if symbol\n          \"respond to #{types_or_methods.join(' or ')}\"\n        else\n          \"be an instance of #{types_or_methods.join(' or ')}\"\n        end\n      end.join(' or ')\n    end\n\n    def locator_valid?(locator)\n      return true unless locator && locator_types\n\n      locator_types&.any? do |type_or_method|\n        type_or_method.is_a?(Symbol) ? locator.respond_to?(type_or_method) : type_or_method === locator # rubocop:disable Style/CaseEquality\n      end\n    end\n\n    def locate_field(xpath, locator, **_options)\n      return xpath if locator.nil?\n\n      locate_xpath = xpath # Need to save original xpath for the label wrap\n      locator = locator.to_s\n      attr_matchers = [XPath.attr(:id) == locator,\n                       XPath.attr(:name) == locator,\n                       XPath.attr(:placeholder) == locator,\n                       XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)\n      attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label\n      attr_matchers |= XPath.attr(test_id) == locator if test_id\n\n      locate_xpath = locate_xpath[attr_matchers]\n      locate_xpath + locate_label(locator).descendant(xpath)\n    end\n\n    def locate_label(locator)\n      XPath.descendant(:label)[XPath.string.n.is(locator)]\n    end\n\n    def find_by_attr(attribute, value)\n      finder_name = \"find_by_#{attribute}_attr\"\n      if respond_to?(finder_name, true)\n        send(finder_name, value)\n      else\n        value ? XPath.attr(attribute) == value : nil\n      end\n    end\n\n    def find_by_class_attr(classes)\n      Array(classes).map { |klass| XPath.attr(:class).contains_word(klass) }.reduce(:&)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "locate_field", "signature": "def locate_field(xpath, locator, **_options)", "start_line": 126, "end_line": 140}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector < < SimpleDelegator"}, "task_id": 85}
{"function_name": "load_selenium", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "load_selenium", "signature": "def load_selenium require 'selenium-webdriver'", "start_line": 22, "end_line": 53}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 86}
{"function_name": "browser", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "browser", "signature": "def browser unless @browser", "start_line": 63, "end_line": 81}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 87}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(app, **options)", "start_line": 83, "end_line": 92}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 88}
{"function_name": "reset!", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "reset!", "signature": "def reset! # Use instance variable directly so we avoid starting the browser just to reset the session", "start_line": 155, "end_line": 176}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 89}
{"function_name": "frame_obscured_at?", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "frame_obscured_at?", "signature": "def frame_obscured_at?(x:, y:)", "start_line": 178, "end_line": 188}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 90}
{"function_name": "switch_to_frame", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "switch_to_frame", "signature": "def switch_to_frame(frame)", "start_line": 190, "end_line": 203}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 91}
{"function_name": "open_new_window", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "open_new_window", "signature": "def open_new_window(kind = :tab)", "start_line": 247, "end_line": 258}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 92}
{"function_name": "quit", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "quit", "signature": "def quit @browser&.quit", "start_line": 283, "end_line": 295}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 93}
{"function_name": "invalid_element_errors", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "invalid_element_errors", "signature": "def invalid_element_errors @invalid_element_errors ||=", "start_line": 297, "end_line": 311}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 94}
{"function_name": "clear_session_storage", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "clear_session_storage", "signature": "def clear_session_storage if @browser.respond_to? :session_storage", "start_line": 355, "end_line": 367}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 95}
{"function_name": "clear_local_storage", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "clear_local_storage", "signature": "def clear_local_storage # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why", "start_line": 369, "end_line": 383}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 96}
{"function_name": "within_given_window", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "within_given_window", "signature": "def within_given_window(handle)", "start_line": 397, "end_line": 407}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 97}
{"function_name": "find_modal", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "find_modal", "signature": "def find_modal(text: nil, **options)", "start_line": 409, "end_line": 430}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 98}
{"function_name": "unwrap_script_result", "file_path": "capybara/lib/capybara/selenium/driver.rb", "focal_code": "def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'uri'\nrequire 'English'\n\nclass Capybara::Selenium::Driver < Capybara::Driver::Base\n  include Capybara::Selenium::Find\n\n  DEFAULT_OPTIONS = {\n    browser: :firefox,\n    clear_local_storage: nil,\n    clear_session_storage: nil\n  }.freeze\n  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze\n  CAPS_VERSION = Gem::Requirement.new('< 4.8.0')\n\n  attr_reader :app, :options\n\n  class << self\n    attr_reader :selenium_webdriver_version\n\n    def load_selenium\n      require 'selenium-webdriver'\n      require 'capybara/selenium/patches/atoms'\n      require 'capybara/selenium/patches/is_displayed'\n\n      # Look up the version of `selenium-webdriver` to\n      # see if it's a version we support.\n      #\n      # By default, we use Gem.loaded_specs to determine\n      # the version number. However, in some cases, such\n      # as when loading `selenium-webdriver` outside of\n      # Rubygems, we fall back to referencing\n      # Selenium::WebDriver::VERSION. Ideally we'd\n      # use the constant in all cases, but earlier versions\n      # of `selenium-webdriver` didn't provide the constant.\n      @selenium_webdriver_version =\n        if Gem.loaded_specs['selenium-webdriver']\n          Gem.loaded_specs['selenium-webdriver'].version\n        else\n          Gem::Version.new(Selenium::WebDriver::VERSION)\n        end\n\n      unless Gem::Requirement.new('>= 4.8').satisfied_by? @selenium_webdriver_version\n        warn \"Warning: You're using an unsupported version of selenium-webdriver, please upgrade to 4.8+.\"\n      end\n\n      @selenium_webdriver_version\n    rescue LoadError => e\n      raise e unless e.message.include?('selenium-webdriver')\n\n      raise LoadError, \"Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler.\"\n    end\n\n    attr_reader :specializations\n\n    def register_specialization(browser_name, specialization)\n      @specializations ||= {}\n      @specializations[browser_name] = specialization\n    end\n  end\n\n  def browser\n    unless @browser\n      options[:http_client] ||= begin\n        require 'capybara/selenium/patches/persistent_client'\n        if options[:timeout]\n          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])\n        else\n          ::Capybara::Selenium::PersistentClient.new\n        end\n      end\n      processed_options = options.except(*SPECIAL_OPTIONS)\n\n      @browser = Selenium::WebDriver.for(options[:browser], processed_options)\n\n      specialize_driver\n      setup_exit_handler\n    end\n    @browser\n  end\n\n  def initialize(app, **options)\n    super()\n    self.class.load_selenium\n    @app = app\n    @browser = nil\n    @exit_status = nil\n    @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }\n    @options = DEFAULT_OPTIONS.merge(options)\n    @node_class = ::Capybara::Selenium::Node\n  end\n\n  def visit(path)\n    browser.navigate.to(path)\n  end\n\n  def refresh\n    browser.navigate.refresh\n  end\n\n  def go_back\n    browser.navigate.back\n  end\n\n  def go_forward\n    browser.navigate.forward\n  end\n\n  def html\n    browser.page_source\n  rescue Selenium::WebDriver::Error::JavascriptError => e\n    raise unless e.message.include?('documentElement is null')\n  end\n\n  def title\n    browser.title\n  end\n\n  def current_url\n    browser.current_url\n  end\n\n  def wait?; true; end\n  def needs_server?; true; end\n\n  def execute_script(script, *args)\n    browser.execute_script(script, *native_args(args))\n  end\n\n  def evaluate_script(script, *args)\n    result = execute_script(\"return #{script}\", *args)\n    unwrap_script_result(result)\n  end\n\n  def evaluate_async_script(script, *args)\n    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time\n    result = browser.execute_async_script(script, *native_args(args))\n    unwrap_script_result(result)\n  end\n\n  def active_element\n    build_node(native_active_element)\n  end\n\n  def send_keys(*args)\n    # Should this call the specialized nodes rather than native???\n    native_active_element.send_keys(*args)\n  end\n\n  def save_screenshot(path, **options)\n    browser.save_screenshot(path, **options)\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    navigated = false\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      # Only trigger a navigation if we haven't done it already, otherwise it\n      # can trigger an endless series of unload modals\n      reset_browser_state unless navigated\n      navigated = true\n      # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      # This error is thrown if an unhandled alert is on the page\n      # Firefox appears to automatically dismiss this alert, chrome does not\n      # We'll try to accept it\n      accept_unhandled_reset_alert\n      # try cleaning up the browser again\n      retry\n    end\n  end\n\n  def frame_obscured_at?(x:, y:)\n    frame = @frame_handles[current_window_handle].last\n    return false unless frame\n\n    switch_to_frame(:parent)\n    begin\n      frame.base.obscured?(x: x, y: y)\n    ensure\n      switch_to_frame(frame)\n    end\n  end\n\n  def switch_to_frame(frame)\n    handles = @frame_handles[current_window_handle]\n    case frame\n    when :top\n      handles.clear\n      browser.switch_to.default_content\n    when :parent\n      handles.pop\n      browser.switch_to.parent_frame\n    else\n      handles << frame\n      browser.switch_to.frame(frame.native)\n    end\n  end\n\n  def current_window_handle\n    browser.window_handle\n  end\n\n  def window_size(handle)\n    within_given_window(handle) do\n      size = browser.manage.window.size\n      [size.width, size.height]\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      browser.manage.window.resize_to(width, height)\n    end\n  end\n\n  def maximize_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.maximize\n    end\n    sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      browser.manage.window.full_screen\n    end\n  end\n\n  def close_window(handle)\n    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first\n\n    within_given_window(handle) do\n      browser.close\n    end\n  end\n\n  def window_handles\n    browser.window_handles\n  end\n\n  def open_new_window(kind = :tab)\n    if browser.switch_to.respond_to?(:new_window)\n      handle = current_window_handle\n      browser.switch_to.new_window(kind)\n      switch_to_window(handle)\n    else\n      browser.manage.new_window(kind)\n    end\n  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError\n    # If not supported by the driver or browser default to using JS\n    browser.execute_script('window.open();')\n  end\n\n  def switch_to_window(handle)\n    browser.switch_to.window handle\n  end\n\n  def accept_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n\n    modal.send_keys options[:with] if options[:with]\n\n    message = modal.text\n    modal.accept\n    message\n  end\n\n  def dismiss_modal(_type, **options)\n    yield if block_given?\n    modal = find_modal(**options)\n    message = modal.text\n    modal.dismiss\n    message\n  end\n\n  def quit\n    @browser&.quit\n  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,\n         Selenium::WebDriver::Error::InvalidSessionIdError\n    # Browser must have already gone\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    unless silenced_unknown_error_message?(e.message) # Most likely already gone\n      # probably already gone but not sure - so warn\n      warn \"Ignoring Selenium UnknownError during driver quit: #{e.message}\"\n    end\n  ensure\n    @browser = nil\n  end\n\n  def invalid_element_errors\n    @invalid_element_errors ||=\n      [\n        ::Selenium::WebDriver::Error::StaleElementReferenceError,\n        ::Selenium::WebDriver::Error::ElementNotInteractableError,\n        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition\n        ::Selenium::WebDriver::Error::ElementClickInterceptedError,\n        ::Selenium::WebDriver::Error::NoSuchElementError, # IE\n        ::Selenium::WebDriver::Error::InvalidArgumentError # IE\n      ].tap do |errors|\n        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)\n          errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)\n        end\n      end\n  end\n\n  def no_such_window_error\n    Selenium::WebDriver::Error::NoSuchWindowError\n  end\n\nprivate\n\n  def native_args(args)\n    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }\n  end\n\n  def native_active_element\n    browser.switch_to.active_element\n  end\n\n  def clear_browser_state\n    delete_all_cookies\n    clear_storage\n  rescue *clear_browser_state_errors\n    # delete_all_cookies fails when we've previously gone\n    # to about:blank, so we rescue this error and do nothing\n    # instead.\n  end\n\n  def clear_browser_state_errors\n    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]\n  end\n\n  def unhandled_alert_errors\n    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError]\n  end\n\n  def delete_all_cookies\n    @browser.manage.delete_all_cookies\n  end\n\n  def clear_storage\n    clear_session_storage unless options[:clear_session_storage] == false\n    clear_local_storage unless options[:clear_local_storage] == false\n  rescue Selenium::WebDriver::Error::JavascriptError, Selenium::WebDriver::Error::WebDriverError\n    # session/local storage may not be available if on non-http pages (e.g. about:blank)\n  end\n\n  def clear_session_storage\n    if @browser.respond_to? :session_storage\n      @browser.session_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.sessionStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_session_storage].nil?\n          warn 'sessionStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def clear_local_storage\n    # selenium-webdriver 4.30.0 removed HTML5 storage accessors -- not really sure why\n    # can we replicate this robustly via CDP?\n    if @browser.respond_to? :local_storage\n      @browser.local_storage.clear\n    else\n      begin\n        @browser&.execute_script('window.localStorage.clear()')\n      rescue # rubocop:disable Style/RescueStandardError\n        unless options[:clear_local_storage].nil?\n          warn 'localStorage clear requested but is not supported by this driver'\n        end\n      end\n    end\n  end\n\n  def navigate_with_accept(url)\n    @browser.navigate.to(url)\n    sleep 0.1 # slight wait for alert\n    @browser.switch_to.alert.accept\n  rescue modal_error\n    # alert now gone, should mean navigation happened\n  end\n\n  def modal_error\n    Selenium::WebDriver::Error::NoSuchAlertError\n  end\n\n  def within_given_window(handle)\n    original_handle = current_window_handle\n    if handle == original_handle\n      yield\n    else\n      switch_to_window(handle)\n      result = yield\n      switch_to_window(original_handle)\n      result\n    end\n  end\n\n  def find_modal(text: nil, **options)\n    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time\n    # Actual wait time may be longer than specified\n    wait = Selenium::WebDriver::Wait.new(\n      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,\n      ignore: modal_error\n    )\n    begin\n      wait.until do\n        alert = @browser.switch_to.alert\n        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))\n        matched = alert.text.match?(regexp)\n        unless matched\n          raise Capybara::ModalNotFound, \"Unable to find modal dialog with #{text} - found '#{alert.text}' instead.\"\n        end\n\n        alert\n      end\n    rescue *find_modal_errors\n      raise Capybara::ModalNotFound, \"Unable to find modal dialog#{\" with #{text}\" if text}\"\n    end\n  end\n\n  def find_modal_errors\n    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError]\n  end\n\n  def silenced_unknown_error_message?(msg)\n    silenced_unknown_error_messages.any? { |regex| msg.match? regex }\n  end\n\n  def silenced_unknown_error_messages\n    [/Error communicating with the remote browser/]\n  end\n\n  def unwrap_script_result(arg)\n    case arg\n    when Array\n      arg.map { |arr| unwrap_script_result(arr) }\n    when Hash\n      arg.transform_values! { |value| unwrap_script_result(value) }\n    when Selenium::WebDriver::Element, Selenium::WebDriver::ShadowRoot\n      build_node(arg)\n    else\n      arg\n    end\n  end\n\n  def find_context\n    browser\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def specialize_driver\n    browser_type = browser.browser\n    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality\n      extend specialization\n    end\n  end\n\n  def setup_exit_handler\n    main = Process.pid\n    at_exit do\n      # Store the exit status of the test run since it goes away after calling the at_exit proc...\n      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)\n      quit if Process.pid == main\n      exit @exit_status if @exit_status # Force exit with stored status\n    end\n  end\n\n  def reset_browser_state\n    clear_browser_state\n    @browser.navigate.to('about:blank')\n  end\n\n  def wait_for_empty_page(timer)\n    until find_xpath('/html/body/*').empty?\n      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?\n\n      sleep 0.01\n\n      # It has been observed that it is possible that asynchronous JS code in\n      # the application under test can navigate the browser away from about:blank\n      # if the timing is just right. Ensure we are still at about:blank...\n      @browser.navigate.to('about:blank') unless current_url == 'about:blank'\n    end\n  end\n\n  def accept_unhandled_reset_alert\n    @browser.switch_to.alert.accept\n    sleep 0.25 # allow time for the modal to be handled\n  rescue modal_error\n    # The alert is now gone.\n    # If navigation has not occurred attempt again and accept alert\n    # since FF may have dismissed the alert at first attempt.\n    navigate_with_accept('about:blank') if current_url != 'about:blank'\n  end\nend\n\nrequire 'capybara/selenium/driver_specializations/chrome_driver'\nrequire 'capybara/selenium/driver_specializations/firefox_driver'\nrequire 'capybara/selenium/driver_specializations/internet_explorer_driver'\nrequire 'capybara/selenium/driver_specializations/safari_driver'\nrequire 'capybara/selenium/driver_specializations/edge_driver'\n", "language": "Ruby", "function_component": {"name": "unwrap_script_result", "signature": "def unwrap_script_result(arg)", "start_line": 444, "end_line": 455}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Driver", "class_signature": "class Capybara::Selenium::Driver < < Capybara::Driver::Base"}, "task_id": 99}
{"function_name": "set", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "set", "signature": "def set(value, **options)", "start_line": 59, "end_line": 94}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 100}
{"function_name": "click", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "click", "signature": "def click(keys = [], **options)", "start_line": 106, "end_line": 127}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 101}
{"function_name": "right_click", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "right_click", "signature": "def right_click(keys = [], **options)", "start_line": 129, "end_line": 142}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 102}
{"function_name": "scroll_to_center", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "scroll_to_center", "signature": "def scroll_to_center script = <<-JS", "start_line": 233, "end_line": 246}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 103}
{"function_name": "sibling_index", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "sibling_index", "signature": "def sibling_index(parent, node, selector)", "start_line": 250, "end_line": 262}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 104}
{"function_name": "set_text", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "set_text", "signature": "def set_text(value, clear: nil, rapid: nil, **_unused)", "start_line": 273, "end_line": 293}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 105}
{"function_name": "perform_with_options", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "perform_with_options", "signature": "def perform_with_options(click_options, &block)", "start_line": 299, "end_line": 311}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 106}
{"function_name": "update_value_js", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "update_value_js", "signature": "def update_value_js(value)", "start_line": 345, "end_line": 357}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 107}
{"function_name": "with_file_detector", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "with_file_detector", "signature": "def with_file_detector if driver.options[:browser] == :remote &&", "start_line": 369, "end_line": 385}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 108}
{"function_name": "set_content_editable", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "set_content_editable", "signature": "def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName", "start_line": 387, "end_line": 409}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 109}
{"function_name": "action_with_modifiers", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "action_with_modifiers", "signature": "def action_with_modifiers(click_options)", "start_line": 411, "end_line": 436}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 110}
{"function_name": "normalize_keys", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "normalize_keys", "signature": "def normalize_keys(keys)", "start_line": 468, "end_line": 477}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 111}
{"function_name": "attrs", "file_path": "capybara/lib/capybara/selenium/node.rb", "focal_code": "def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end", "file_content": "# frozen_string_literal: true\n\n# Selenium specific implementation of the Capybara::Driver::Node API\n\nrequire 'capybara/selenium/extensions/find'\nrequire 'capybara/selenium/extensions/scroll'\nrequire 'capybara/node/whitespace_normalizer'\n\nclass Capybara::Selenium::Node < Capybara::Driver::Node\n  include Capybara::Node::WhitespaceNormalizer\n  include Capybara::Selenium::Find\n  include Capybara::Selenium::Scroll\n\n  def visible_text\n    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?\n\n    native.text\n  end\n\n  def all_text\n    text = driver.evaluate_script('arguments[0].textContent', self) || ''\n    normalize_spacing(text)\n  end\n\n  def [](name)\n    native.attribute(name.to_s)\n  rescue Selenium::WebDriver::Error::WebDriverError\n    nil\n  end\n\n  def value\n    if tag_name == 'select' && multiple?\n      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }\n    else\n      native[:value]\n    end\n  end\n\n  def style(styles)\n    styles.to_h { |style| [style, native.css_value(style)] }\n  end\n\n  ##\n  #\n  # Set the value of the form element to the given value.\n  #\n  # @param [String] value    The new value\n  # @param [Hash{}] options  Driver specific options for how to set the value\n  # @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>\n  #   nil => clear via javascript <br/>\n  #   :none =>  append the new value to the existing value <br/>\n  #   :backspace => send backspace keystrokes to clear the field <br/>\n  #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]\n  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>\n  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>\n  #   true => Rapid mode will be used regardless of input length<br/>\n  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain\n  #            Javascript interactions on form inputs<br/>\n  def set(value, **options)\n    if value.is_a?(Array) && !multiple?\n      raise ArgumentError, \"Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}\"\n    end\n\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    @tag_name ||= tag_name\n\n    case tag_name\n    when 'input'\n      case type\n      when 'radio'\n        click\n      when 'checkbox'\n        click if value ^ checked?\n      when 'file'\n        set_file(value)\n      when 'date'\n        set_date(value)\n      when 'time'\n        set_time(value)\n      when 'datetime-local'\n        set_datetime_local(value)\n      when 'color'\n        set_color(value)\n      when 'range'\n        set_range(value)\n      else\n        set_text(value, **options)\n      end\n    when 'textarea'\n      set_text(value, **options)\n    else\n      set_content_editable(value)\n    end\n  end\n\n  def select_option\n    click unless selected? || disabled?\n  end\n\n  def unselect_option\n    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?\n\n    click if selected?\n  end\n\n  def click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    return native.click if click_options.empty?\n\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.click(target)\n      else\n        action.click_and_hold(target)\n        action_pause(action, click_options.delay)\n        action.release\n      end\n    end\n  rescue StandardError => e\n    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||\n       e.message.include?('Other element would receive the click')\n      scroll_to_center\n    end\n\n    raise e\n  end\n\n  def right_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    perform_with_options(click_options) do |action|\n      target = click_options.coords? ? nil : native\n      if click_options.delay.zero?\n        action.context_click(target)\n      else\n        action.move_to(target) if target\n        action.pointer_down(:right).then do |act|\n          action_pause(act, click_options.delay)\n        end.pointer_up(:right)\n      end\n    end\n  end\n\n  def double_click(keys = [], **options)\n    click_options = ClickOptions.new(keys, options)\n    raise ArgumentError, \"double_click doesn't support a delay option\" unless click_options.delay.zero?\n\n    perform_with_options(click_options) do |action|\n      click_options.coords? ? action.double_click : action.double_click(native)\n    end\n  end\n\n  def send_keys(*args)\n    native.send_keys(*args)\n  end\n\n  def hover\n    scroll_if_needed { browser_action.move_to(native).perform }\n  end\n\n  def drag_to(element, drop_modifiers: [], **)\n    drop_modifiers = Array(drop_modifiers)\n    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary\n    # which means Seleniums `drag_and_drop` is now broken - do it manually\n    scroll_if_needed { browser_action.click_and_hold(native).perform }\n    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }\n    element.scroll_if_needed do\n      keys_down = modifiers_down(browser_action, drop_modifiers)\n      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n      keys_up.perform\n    end\n  end\n\n  def drop(*_)\n    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'\n  end\n\n  def tag_name\n    @tag_name ||=\n      if native.respond_to? :tag_name\n        native.tag_name.downcase\n      else\n        shadow_root? ? 'ShadowRoot' : 'Unknown'\n      end\n  end\n\n  def visible?; boolean_attr(native.displayed?); end\n  def readonly?; boolean_attr(self[:readonly]); end\n  def multiple?; boolean_attr(self[:multiple]); end\n  def selected?; boolean_attr(native.selected?); end\n  alias :checked? :selected?\n\n  def disabled?\n    return true unless native.enabled?\n\n    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too\n    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?\n  end\n\n  def content_editable?\n    native.attribute('isContentEditable') == 'true'\n  end\n\n  def path\n    driver.evaluate_script GET_XPATH_SCRIPT, self\n  end\n\n  def obscured?(x: nil, y: nil)\n    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)\n    return true if res == true\n\n    driver.frame_obscured_at?(x: res['x'], y: res['y'])\n  end\n\n  def rect\n    native.rect\n  end\n\n  def shadow_root\n    root = native.shadow_root\n    root && build_node(native.shadow_root)\n  end\n\nprotected\n\n  def scroll_if_needed\n    yield\n  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError\n    scroll_to_center\n    yield\n  end\n\n  def scroll_to_center\n    script = <<-JS\n      try {\n        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n      } catch(e) {\n        arguments[0].scrollIntoView(true);\n      }\n    JS\n    begin\n      driver.execute_script(script, self)\n    rescue StandardError\n      # Swallow error if scrollIntoView with options isn't supported\n    end\n  end\n\nprivate\n\n  def sibling_index(parent, node, selector)\n    siblings = parent.find_xpath(selector)\n    case siblings.size\n    when 0\n      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)\n    when 1\n      '' # index not necessary when only one matching element\n    else\n      idx = siblings.index(node)\n      # Element may not be found in the siblings if it has gone away\n      idx.nil? ? '[ERROR]' : \"[#{idx + 1}]\"\n    end\n  end\n\n  def boolean_attr(val)\n    val && (val != 'false')\n  end\n\n  # a reference to the select node if this is an option node\n  def select_node\n    find_xpath(XPath.ancestor(:select)[1]).first\n  end\n\n  def set_text(value, clear: nil, rapid: nil, **_unused)\n    value = value.to_s\n    if value.empty? && clear.nil?\n      native.clear\n    elsif clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys(:end, *backspaces, value)\n    elsif clear.is_a? Array\n      send_keys(*clear, value)\n    else\n      driver.execute_script 'arguments[0].select()', self unless clear == :none\n      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)\n        send_keys(value[0..3])\n        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]\n        send_keys(value[-3..])\n      else\n        send_keys(value)\n      end\n    end\n  end\n\n  def auto_rapid_set_length\n    30\n  end\n\n  def perform_with_options(click_options, &block)\n    raise ArgumentError, 'A block must be provided' unless block\n\n    scroll_if_needed do\n      action_with_modifiers(click_options) do |action|\n        if block\n          yield action\n        else\n          click_options.coords? ? action.click : action.click(native)\n        end\n      end\n    end\n  end\n\n  def set_date(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.dateable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_date_str)\n  end\n\n  def set_time(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_time_str)\n  end\n\n  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName\n    value = SettableValue.new(value)\n    return set_text(value) unless value.timeable?\n\n    # TODO: this would be better if locale can be detected and correct keystrokes sent\n    update_value_js(value.to_datetime_str)\n  end\n\n  def set_color(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def set_range(value) # rubocop:disable Naming/AccessorMethodName\n    update_value_js(value)\n  end\n\n  def update_value_js(value)\n    driver.execute_script(<<-JS, self, value)\n      if (arguments[0].readOnly) { return };\n      if (document.activeElement !== arguments[0]){\n        arguments[0].focus();\n      }\n      if (arguments[0].value != arguments[1]) {\n        arguments[0].value = arguments[1]\n        arguments[0].dispatchEvent(new InputEvent('input'));\n        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));\n      }\n    JS\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    with_file_detector do\n      path_names = value.to_s.empty? ? [] : value\n      file_names = Array(path_names).map do |pn|\n        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)\n      end.join(\"\\n\")\n      native.send_keys(file_names)\n    end\n  end\n\n  def with_file_detector\n    if driver.options[:browser] == :remote &&\n       bridge.respond_to?(:file_detector) &&\n       bridge.file_detector.nil?\n      begin\n        bridge.file_detector = lambda do |(fn, *)|\n          str = fn.to_s\n          str if File.exist?(str)\n        end\n        yield\n      ensure\n        bridge.file_detector = nil\n      end\n    else\n      yield\n    end\n  end\n\n  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName\n    # Ensure we are focused on the element\n    click\n\n    editable = driver.execute_script <<-JS, self\n      if (arguments[0].isContentEditable) {\n        var range = document.createRange();\n        var sel = window.getSelection();\n        arguments[0].focus();\n        range.selectNodeContents(arguments[0]);\n        sel.removeAllRanges();\n        sel.addRange(range);\n        return true;\n      }\n      return false;\n    JS\n\n    # The action api has a speed problem but both chrome and firefox 58 raise errors\n    # if we use the faster direct send_keys.  For now just send_keys to the element\n    # we've already focused.\n    # native.send_keys(value.to_s)\n    browser_action.send_keys(value.to_s).perform if editable\n  end\n\n  def action_with_modifiers(click_options)\n    actions = browser_action.tap do |acts|\n      if click_options.coords?\n        if click_options.center_offset?\n          acts.move_to(native, *click_options.coords)\n        else\n          right_by, down_by = *click_options.coords\n          size = native.size\n          left_offset = (size[:width] / 2).to_i\n          top_offset = (size[:height] / 2).to_i\n          left = -left_offset + right_by\n          top = -top_offset + down_by\n          acts.move_to(native, left, top)\n        end\n      else\n        acts.move_to(native)\n      end\n    end\n    modifiers_down(actions, click_options.keys)\n    yield actions\n    modifiers_up(actions, click_options.keys)\n    actions.perform\n  ensure\n    act = browser_action\n    act.release_actions if act.respond_to?(:release_actions)\n  end\n\n  def modifiers_down(actions, keys)\n    each_key(keys) { |key| actions.key_down(key) }\n    actions\n  end\n\n  def modifiers_up(actions, keys)\n    each_key(keys) { |key| actions.key_up(key) }\n    actions\n  end\n\n  def browser\n    driver.browser\n  end\n\n  def bridge\n    browser.send(:bridge)\n  end\n\n  def browser_action\n    browser.action\n  end\n\n  def capabilities\n    browser.capabilities\n  end\n\n  def action_pause(action, duration)\n    action.pause(device: action.pointer_inputs.first, duration: duration)\n  end\n\n  def normalize_keys(keys)\n    keys.map do |key|\n      case key\n      when :ctrl then :control\n      when :command, :cmd then :meta\n      else\n        key\n      end\n    end\n  end\n\n  def each_key(keys, &block)\n    normalize_keys(keys).each(&block)\n  end\n\n  def find_context\n    native\n  end\n\n  def build_node(native_node, initial_cache = {})\n    self.class.new(driver, native_node, initial_cache)\n  end\n\n  def attrs(*attr_names)\n    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']\n\n    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)\n      (function(el, names){\n        return names.map(function(name){\n          return el[name]\n        });\n      })(arguments[0], arguments[1]);\n    JS\n  end\n\n  def native_id\n    # Selenium 3 -> 4 changed the return of ref\n    type_or_id, id = native.ref\n    id || type_or_id\n  end\n\n  def shadow_root?\n    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)\n  end\n\n  GET_XPATH_SCRIPT = <<~'JS'\n    (function(el, xml){\n      var xpath = '';\n    \tvar pos, tempitem2;\n\n      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {\n        return \"(: Shadow DOM element - no XPath :)\";\n      };\n      while(el !== xml.documentElement) {\n        pos = 0;\n        tempitem2 = el;\n        while(tempitem2) {\n          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name\n            pos += 1;\n          }\n          tempitem2 = tempitem2.previousSibling;\n        }\n\n        if (el.namespaceURI != xml.documentElement.namespaceURI) {\n          xpath = \"*[local-name()='\"+el.nodeName+\"' and namespace-uri()='\"+(el.namespaceURI===null?'':el.namespaceURI)+\"'][\"+pos+']'+'/'+xpath;\n        } else {\n          xpath = el.nodeName.toUpperCase()+\"[\"+pos+\"]/\"+xpath;\n        }\n\n        el = el.parentNode;\n      }\n      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;\n      xpath = xpath.replace(/\\/$/, '');\n      return xpath;\n    })(arguments[0], document)\n  JS\n\n  OBSCURED_OR_OFFSET_SCRIPT = <<~JS\n    (function(el, x, y) {\n      var box = el.getBoundingClientRect();\n      if (x == null) x = box.width/2;\n      if (y == null) y = box.height/2 ;\n\n      var px = box.left + x,\n          py = box.top + y,\n          e = document.elementFromPoint(px, py);\n\n      if (!el.contains(e))\n        return true;\n\n      return { x: px, y: py };\n    })(arguments[0], arguments[1], arguments[2])\n  JS\n\n  RAPID_APPEND_TEXT = <<~JS\n    (function(el, value) {\n      value = el.value + value;\n      if (el.maxLength && el.maxLength != -1){\n        value = value.slice(0, el.maxLength);\n      }\n      el.value = value;\n    })(arguments[0], arguments[1])\n  JS\n\n  # SettableValue encapsulates time/date field formatting\n  class SettableValue\n    attr_reader :value\n\n    def initialize(value)\n      @value = value\n    end\n\n    def to_s\n      value.to_s\n    end\n\n    def dateable?\n      !value.is_a?(String) && value.respond_to?(:to_date)\n    end\n\n    def to_date_str\n      value.to_date.iso8601\n    end\n\n    def timeable?\n      !value.is_a?(String) && value.respond_to?(:to_time)\n    end\n\n    def to_time_str\n      value.to_time.strftime('%H:%M')\n    end\n\n    def to_datetime_str\n      value.to_time.strftime('%Y-%m-%dT%H:%M')\n    end\n  end\n  private_constant :SettableValue\n\n  # ClickOptions encapsulates click option logic\n  class ClickOptions\n    attr_reader :keys, :options\n\n    def initialize(keys, options)\n      @keys = keys\n      @options = options\n    end\n\n    def coords?\n      options[:x] && options[:y]\n    end\n\n    def coords\n      [options[:x], options[:y]]\n    end\n\n    def center_offset?\n      options[:offset] == :center\n    end\n\n    def empty?\n      keys.empty? && !coords? && delay.zero?\n    end\n\n    def delay\n      options[:delay] || 0\n    end\n  end\n  private_constant :ClickOptions\nend\n", "language": "Ruby", "function_component": {"name": "attrs", "signature": "def attrs(*attr_names)", "start_line": 491, "end_line": 501}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node < < Capybara::Driver::Node"}, "task_id": 112}
{"function_name": "selector_for", "file_path": "capybara/lib/capybara/server/animation_disabler.rb", "focal_code": "def self.selector_for(css_or_bool)\n        case css_or_bool\n        when String\n          css_or_bool\n        when true\n          '*'\n        else\n          raise CapybaraError, 'Capybara.disable_animation supports either a String (the css selector to disable) or a boolean'\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Server\n    class AnimationDisabler\n      def self.selector_for(css_or_bool)\n        case css_or_bool\n        when String\n          css_or_bool\n        when true\n          '*'\n        else\n          raise CapybaraError, 'Capybara.disable_animation supports either a String (the css selector to disable) or a boolean'\n        end\n      end\n\n      def initialize(app)\n        @app = app\n        @disable_css_markup = format(DISABLE_CSS_MARKUP_TEMPLATE,\n                                     selector: self.class.selector_for(Capybara.disable_animation))\n        @disable_js_markup = +DISABLE_JS_MARKUP_TEMPLATE\n      end\n\n      def call(env)\n        status, headers, body = @app.call(env)\n        return [status, headers, body] unless html_content?(headers)\n\n        nonces = directive_nonces(headers).transform_values { |nonce| \"nonce=\\\"#{nonce}\\\"\" if nonce && !nonce.empty? }\n        response = Rack::Response.new([], status, headers)\n\n        body.each { |html| response.write insert_disable(html, nonces) }\n        body.close if body.respond_to?(:close)\n\n        response.finish\n      end\n\n    private\n\n      attr_reader :disable_css_markup, :disable_js_markup\n\n      def html_content?(headers)\n        /html/.match?(headers['Content-Type']) # rubocop:todo Performance/StringInclude\n      end\n\n      def insert_disable(html, nonces)\n        html.sub(%r{(</head>)}, \"<style #{nonces['style-src']}>#{disable_css_markup}</style>\\\\1\")\n            .sub(%r{(</body>)}, \"<script #{nonces['script-src']}>#{disable_js_markup}</script>\\\\1\")\n      end\n\n      def directive_nonces(headers)\n        headers.fetch('Content-Security-Policy', '')\n               .split(';')\n               .map(&:split)\n               .to_h do |s|\n                 [\n                   s[0], s[1..].filter_map do |value|\n                     /^'nonce-(?<nonce>.+)'/ =~ value\n                     nonce\n                   end[0]\n                 ]\n               end\n      end\n\n      DISABLE_CSS_MARKUP_TEMPLATE = <<~CSS\n        %<selector>s, %<selector>s::before, %<selector>s::after {\n           transition: none !important;\n           animation-duration: 0s !important;\n           animation-delay: 0s !important;\n           scroll-behavior: auto !important;\n        }\n      CSS\n\n      DISABLE_JS_MARKUP_TEMPLATE = <<~SCRIPT\n        //<![CDATA[\n          (typeof jQuery !== 'undefined') && (jQuery.fx.off = true);\n        //]]>\n      SCRIPT\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "selector_for", "signature": "def self.selector_for(css_or_bool)", "start_line": 6, "end_line": 15}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 113}
{"function_name": "directive_nonces", "file_path": "capybara/lib/capybara/server/animation_disabler.rb", "focal_code": "def directive_nonces(headers)\n        headers.fetch('Content-Security-Policy', '')\n               .split(';')\n               .map(&:split)\n               .to_h do |s|\n                 [\n                   s[0], s[1..].filter_map do |value|\n                     /^'nonce-(?<nonce>.+)'/ =~ value\n                     nonce\n                   end[0]\n                 ]\n               end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Server\n    class AnimationDisabler\n      def self.selector_for(css_or_bool)\n        case css_or_bool\n        when String\n          css_or_bool\n        when true\n          '*'\n        else\n          raise CapybaraError, 'Capybara.disable_animation supports either a String (the css selector to disable) or a boolean'\n        end\n      end\n\n      def initialize(app)\n        @app = app\n        @disable_css_markup = format(DISABLE_CSS_MARKUP_TEMPLATE,\n                                     selector: self.class.selector_for(Capybara.disable_animation))\n        @disable_js_markup = +DISABLE_JS_MARKUP_TEMPLATE\n      end\n\n      def call(env)\n        status, headers, body = @app.call(env)\n        return [status, headers, body] unless html_content?(headers)\n\n        nonces = directive_nonces(headers).transform_values { |nonce| \"nonce=\\\"#{nonce}\\\"\" if nonce && !nonce.empty? }\n        response = Rack::Response.new([], status, headers)\n\n        body.each { |html| response.write insert_disable(html, nonces) }\n        body.close if body.respond_to?(:close)\n\n        response.finish\n      end\n\n    private\n\n      attr_reader :disable_css_markup, :disable_js_markup\n\n      def html_content?(headers)\n        /html/.match?(headers['Content-Type']) # rubocop:todo Performance/StringInclude\n      end\n\n      def insert_disable(html, nonces)\n        html.sub(%r{(</head>)}, \"<style #{nonces['style-src']}>#{disable_css_markup}</style>\\\\1\")\n            .sub(%r{(</body>)}, \"<script #{nonces['script-src']}>#{disable_js_markup}</script>\\\\1\")\n      end\n\n      def directive_nonces(headers)\n        headers.fetch('Content-Security-Policy', '')\n               .split(';')\n               .map(&:split)\n               .to_h do |s|\n                 [\n                   s[0], s[1..].filter_map do |value|\n                     /^'nonce-(?<nonce>.+)'/ =~ value\n                     nonce\n                   end[0]\n                 ]\n               end\n      end\n\n      DISABLE_CSS_MARKUP_TEMPLATE = <<~CSS\n        %<selector>s, %<selector>s::before, %<selector>s::after {\n           transition: none !important;\n           animation-duration: 0s !important;\n           animation-delay: 0s !important;\n           scroll-behavior: auto !important;\n        }\n      CSS\n\n      DISABLE_JS_MARKUP_TEMPLATE = <<~SCRIPT\n        //<![CDATA[\n          (typeof jQuery !== 'undefined') && (jQuery.fx.off = true);\n        //]]>\n      SCRIPT\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "directive_nonces", "signature": "def directive_nonces(headers)", "start_line": 50, "end_line": 62}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 114}
{"function_name": "call", "file_path": "capybara/lib/capybara/server/middleware.rb", "focal_code": "def call(env)\n        if env['PATH_INFO'] == '/__identify__'\n          [200, {}, [@app.object_id.to_s]]\n        else\n          request_uri = env['REQUEST_URI']\n          @counter.increment(request_uri)\n\n          begin\n            @extended_app.call(env)\n          rescue *@server_errors => e\n            @error ||= e\n            raise e\n          ensure\n            @counter.decrement(request_uri)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  class Server\n    class Middleware\n      class Counter\n        def initialize\n          @value = []\n          @mutex = Mutex.new\n        end\n\n        def increment(uri)\n          @mutex.synchronize { @value.push(uri) }\n        end\n\n        def decrement(uri)\n          @mutex.synchronize { @value.delete_at(@value.index(uri) || - 1) }\n        end\n\n        def positive?\n          @mutex.synchronize { @value.length.positive? }\n        end\n\n        def value\n          @mutex.synchronize { @value.dup }\n        end\n      end\n\n      attr_reader :error\n\n      def initialize(app, server_errors, extra_middleware = [])\n        @app = app\n        @extended_app = extra_middleware.inject(@app) do |ex_app, klass|\n          klass.new(ex_app)\n        end\n        @counter = Counter.new\n        @server_errors = server_errors\n      end\n\n      def pending_requests\n        @counter.value\n      end\n\n      def pending_requests?\n        @counter.positive?\n      end\n\n      def clear_error\n        @error = nil\n      end\n\n      def call(env)\n        if env['PATH_INFO'] == '/__identify__'\n          [200, {}, [@app.object_id.to_s]]\n        else\n          request_uri = env['REQUEST_URI']\n          @counter.increment(request_uri)\n\n          begin\n            @extended_app.call(env)\n          rescue *@server_errors => e\n            @error ||= e\n            raise e\n          ensure\n            @counter.decrement(request_uri)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(env)", "start_line": 52, "end_line": 68}, "metadata": {"module": "Capybara", "class_name": "Server", "class_signature": "class Server"}, "task_id": 115}
{"function_name": "read_nonblock", "file_path": "capybara/lib/capybara/registrations/patches/puma_ssl.rb", "focal_code": "def read_nonblock(size, *_)\n        wait_states = %i[wait_readable wait_writable]\n\n        loop do\n          output = engine_read_all\n          return output if output\n\n          data = @socket.read_nonblock(size, exception: false)\n          raise IO::EAGAINWaitReadable if wait_states.include? data\n          return nil if data.nil?\n\n          @engine.inject(data)\n          output = engine_read_all\n\n          return output if output\n\n          while (neg_data = @engine.extract)\n            @socket.write neg_data\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Puma\n  module MiniSSL\n    class Socket\n      def read_nonblock(size, *_)\n        wait_states = %i[wait_readable wait_writable]\n\n        loop do\n          output = engine_read_all\n          return output if output\n\n          data = @socket.read_nonblock(size, exception: false)\n          raise IO::EAGAINWaitReadable if wait_states.include? data\n          return nil if data.nil?\n\n          @engine.inject(data)\n          output = engine_read_all\n\n          return output if output\n\n          while (neg_data = @engine.extract)\n            @socket.write neg_data\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "read_nonblock", "signature": "def read_nonblock(size, *_)", "start_line": 6, "end_line": 26}, "metadata": {"module": "Puma", "class_name": "Socket", "class_signature": "class Socket"}, "task_id": 116}
{"function_name": "session_options", "file_path": "capybara/lib/capybara/rspec/matchers/base.rb", "focal_code": "def session_options\n          @context_el ||= nil\n          if @context_el.respond_to? :session_options\n            @context_el.session_options\n          elsif @context_el.respond_to? :current_scope\n            @context_el.current_scope.session_options\n          else\n            Capybara.session_options\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/rspec/matchers/compound'\nrequire 'capybara/rspec/matchers/count_sugar'\nrequire 'capybara/rspec/matchers/spatial_sugar'\n\nmodule Capybara\n  module RSpecMatchers\n    module Matchers\n      class Base\n        include ::Capybara::RSpecMatchers::Matchers::Compound if defined?(::Capybara::RSpecMatchers::Matchers::Compound)\n\n        attr_reader :failure_message, :failure_message_when_negated\n\n        def initialize(*args, **kw_args, &filter_block)\n          @args = args.dup\n          @kw_args = kw_args || {}\n          @filter_block = filter_block\n        end\n\n      private\n\n        def session_query_args\n          # if @args.last.is_a? Hash\n          #   @args.last[:session_options] = session_options\n          # else\n          #   @args.push(session_options: session_options)\n          # end\n          @args\n        end\n\n        def session_query_options\n          @kw_args[:session_options] = session_options\n          @kw_args\n        end\n\n        def session_options\n          @context_el ||= nil\n          if @context_el.respond_to? :session_options\n            @context_el.session_options\n          elsif @context_el.respond_to? :current_scope\n            @context_el.current_scope.session_options\n          else\n            Capybara.session_options\n          end\n        end\n      end\n\n      class WrappedElementMatcher < Base\n        def matches?(actual, &filter_block)\n          @filter_block ||= filter_block\n          element_matches?(wrap(actual))\n        rescue Capybara::ExpectationNotMet => e\n          @failure_message = e.message\n          false\n        end\n\n        def does_not_match?(actual, &filter_block)\n          @filter_block ||= filter_block\n          element_does_not_match?(wrap(actual))\n        rescue Capybara::ExpectationNotMet => e\n          @failure_message_when_negated = e.message\n          false\n        end\n\n      private\n\n        def wrap(actual)\n          actual = actual.to_capybara_node if actual.respond_to?(:to_capybara_node)\n          @context_el = if actual.respond_to?(:has_selector?)\n            actual\n          else\n            Capybara.string(actual.to_s)\n          end\n        end\n      end\n\n      class CountableWrappedElementMatcher < WrappedElementMatcher\n        include ::Capybara::RSpecMatchers::CountSugar\n        include ::Capybara::RSpecMatchers::SpatialSugar\n      end\n\n      class NegatedMatcher\n        include ::Capybara::RSpecMatchers::Matchers::Compound if defined?(::Capybara::RSpecMatchers::Matchers::Compound)\n\n        def initialize(matcher)\n          super()\n          @matcher = matcher\n        end\n\n        def matches?(actual, &filter_block)\n          @matcher.does_not_match?(actual, &filter_block)\n        end\n\n        def does_not_match?(actual, &filter_block)\n          @matcher.matches?(actual, &filter_block)\n        end\n\n        def description\n          \"not #{@matcher.description}\"\n        end\n\n        def failure_message\n          @matcher.failure_message_when_negated\n        end\n\n        def failure_message_when_negated\n          @matcher.failure_message\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "session_options", "signature": "def session_options @context_el ||= nil", "start_line": 37, "end_line": 46}, "metadata": {"module": "Capybara", "class_name": "Base", "class_signature": "class Base"}, "task_id": 117}
{"function_name": "matches?", "file_path": "capybara/lib/capybara/rspec/matchers/become_closed.rb", "focal_code": "def matches?(window)\n          @window = window\n          @wait_time = Capybara::Queries::BaseQuery.wait(@options, window.session.config.default_max_wait_time)\n          timer = Capybara::Helpers.timer(expire_in: @wait_time)\n          while window.exists?\n            return false if timer.expired?\n\n            sleep 0.01\n          end\n          true\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module RSpecMatchers\n    module Matchers\n      class BecomeClosed\n        def initialize(options)\n          @options = options\n        end\n\n        def matches?(window)\n          @window = window\n          @wait_time = Capybara::Queries::BaseQuery.wait(@options, window.session.config.default_max_wait_time)\n          timer = Capybara::Helpers.timer(expire_in: @wait_time)\n          while window.exists?\n            return false if timer.expired?\n\n            sleep 0.01\n          end\n          true\n        end\n\n        def failure_message\n          \"expected #{@window.inspect} to become closed after #{@wait_time} seconds\"\n        end\n\n        def failure_message_when_negated\n          \"expected #{@window.inspect} not to become closed after #{@wait_time} seconds\"\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "matches?", "signature": "def matches?(window)", "start_line": 11, "end_line": 21}, "metadata": {"module": "Capybara", "class_name": "BecomeClosed", "class_signature": "class BecomeClosed"}, "task_id": 118}
{"function_name": "match", "file_path": "capybara/lib/capybara/rspec/matchers/compound.rb", "focal_code": "def match(_expected, actual)\n              @evaluator = CapybaraEvaluator.new(actual)\n              syncer = sync_element(actual)\n              begin\n                syncer.synchronize do\n                  @evaluator.reset\n                  raise ::Capybara::ElementNotFound unless synchronized_match?\n\n                  true\n                end\n              rescue StandardError\n                false\n              end\n            end", "file_content": "# frozen_string_literal: true\n\nif defined?(RSpec::Expectations::Version)\n  module Capybara\n    module RSpecMatchers\n      module Matchers\n        module Compound\n          include ::RSpec::Matchers::Composable\n\n          def and(matcher)\n            And.new(self, matcher)\n          end\n\n          def and_then(matcher)\n            ::RSpec::Matchers::BuiltIn::Compound::And.new(self, matcher)\n          end\n\n          def or(matcher)\n            Or.new(self, matcher)\n          end\n\n          class CapybaraEvaluator\n            def initialize(actual)\n              @actual = actual\n              @match_results = Hash.new { |hsh, matcher| hsh[matcher] = matcher.matches?(@actual) }\n            end\n\n            def matcher_matches?(matcher)\n              @match_results[matcher]\n            end\n\n            def reset\n              @match_results.clear\n            end\n          end\n\n          # @api private\n          module Synchronizer\n            def match(_expected, actual)\n              @evaluator = CapybaraEvaluator.new(actual)\n              syncer = sync_element(actual)\n              begin\n                syncer.synchronize do\n                  @evaluator.reset\n                  raise ::Capybara::ElementNotFound unless synchronized_match?\n\n                  true\n                end\n              rescue StandardError\n                false\n              end\n            end\n\n            def sync_element(el)\n              if el.respond_to? :synchronize\n                el\n              elsif el.respond_to? :current_scope\n                el.current_scope\n              else\n                Capybara.string(el)\n              end\n            end\n          end\n\n          class And < ::RSpec::Matchers::BuiltIn::Compound::And\n            include Synchronizer\n\n          private\n\n            def synchronized_match?\n              [matcher_1_matches?, matcher_2_matches?].all?\n            end\n          end\n\n          class Or < ::RSpec::Matchers::BuiltIn::Compound::Or\n            include Synchronizer\n\n          private\n\n            def synchronized_match?\n              [matcher_1_matches?, matcher_2_matches?].any?\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "match", "signature": "def match(_expected, actual)", "start_line": 39, "end_line": 52}, "metadata": {"module": "", "class_name": "", "class_signature": ""}, "task_id": 119}
{"function_name": "add_attribute_conditions", "file_path": "capybara/lib/capybara/selector/builders/css_builder.rb", "focal_code": "def add_attribute_conditions(**attributes)\n        @expression = attributes.inject(expression) do |css, (name, value)|\n          conditions = if name == :class\n            class_conditions(value)\n          elsif value.is_a? Regexp\n            regexp_conditions(name, value)\n          else\n            [attribute_conditions(name => value)]\n          end\n\n          ::Capybara::Selector::CSS.split(css).map do |sel|\n            next sel if conditions.empty?\n\n            conditions.map { |cond| sel + cond }.join(', ')\n          end.join(', ')\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class CSSBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**attributes)\n        @expression = attributes.inject(expression) do |css, (name, value)|\n          conditions = if name == :class\n            class_conditions(value)\n          elsif value.is_a? Regexp\n            regexp_conditions(name, value)\n          else\n            [attribute_conditions(name => value)]\n          end\n\n          ::Capybara::Selector::CSS.split(css).map do |sel|\n            next sel if conditions.empty?\n\n            conditions.map { |cond| sel + cond }.join(', ')\n          end.join(', ')\n        end\n      end\n\n    private\n\n      def regexp_conditions(name, value)\n        Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|\n          strs.map do |str|\n            \"[#{name}*='#{str}'#{' i' if value.casefold?}]\"\n          end.join\n        end\n      end\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            raise ArgumentError, \"XPath expressions are not supported for the :#{attribute} filter with CSS based selectors\"\n          when Regexp\n            Selector::RegexpDisassembler.new(value).substrings.map do |str|\n              \"[#{attribute}*='#{str}'#{' i' if value.casefold?}]\"\n            end.join\n          when true\n            \"[#{attribute}]\"\n          when false\n            ':not([attribute])'\n          else\n            if attribute == :id\n              \"##{::Capybara::Selector::CSS.escape(value)}\"\n            else\n              \"[#{attribute}='#{value}']\"\n            end\n          end\n        end.join\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression\n          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'\n        when Regexp\n          Selector::RegexpDisassembler.new(classes).alternated_substrings.map do |strs|\n            strs.map do |str|\n              \"[class*='#{str}'#{' i' if classes.casefold?}]\"\n            end.join\n          end\n        else\n          cls = Array(classes).reject { |c| c.is_a? Regexp }.group_by { |cl| cl.match?(/^!(?!!!)/) }\n          [(cls[false].to_a.map { |cl| \".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}\" } +\n          cls[true].to_a.map { |cl| \":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..))})\" }).join]\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add_attribute_conditions", "signature": "def add_attribute_conditions(**attributes)", "start_line": 15, "end_line": 31}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 120}
{"function_name": "attribute_conditions", "file_path": "capybara/lib/capybara/selector/builders/css_builder.rb", "focal_code": "def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            raise ArgumentError, \"XPath expressions are not supported for the :#{attribute} filter with CSS based selectors\"\n          when Regexp\n            Selector::RegexpDisassembler.new(value).substrings.map do |str|\n              \"[#{attribute}*='#{str}'#{' i' if value.casefold?}]\"\n            end.join\n          when true\n            \"[#{attribute}]\"\n          when false\n            ':not([attribute])'\n          else\n            if attribute == :id\n              \"##{::Capybara::Selector::CSS.escape(value)}\"\n            else\n              \"[#{attribute}='#{value}']\"\n            end\n          end\n        end.join\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class CSSBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**attributes)\n        @expression = attributes.inject(expression) do |css, (name, value)|\n          conditions = if name == :class\n            class_conditions(value)\n          elsif value.is_a? Regexp\n            regexp_conditions(name, value)\n          else\n            [attribute_conditions(name => value)]\n          end\n\n          ::Capybara::Selector::CSS.split(css).map do |sel|\n            next sel if conditions.empty?\n\n            conditions.map { |cond| sel + cond }.join(', ')\n          end.join(', ')\n        end\n      end\n\n    private\n\n      def regexp_conditions(name, value)\n        Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|\n          strs.map do |str|\n            \"[#{name}*='#{str}'#{' i' if value.casefold?}]\"\n          end.join\n        end\n      end\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            raise ArgumentError, \"XPath expressions are not supported for the :#{attribute} filter with CSS based selectors\"\n          when Regexp\n            Selector::RegexpDisassembler.new(value).substrings.map do |str|\n              \"[#{attribute}*='#{str}'#{' i' if value.casefold?}]\"\n            end.join\n          when true\n            \"[#{attribute}]\"\n          when false\n            ':not([attribute])'\n          else\n            if attribute == :id\n              \"##{::Capybara::Selector::CSS.escape(value)}\"\n            else\n              \"[#{attribute}='#{value}']\"\n            end\n          end\n        end.join\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression\n          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'\n        when Regexp\n          Selector::RegexpDisassembler.new(classes).alternated_substrings.map do |strs|\n            strs.map do |str|\n              \"[class*='#{str}'#{' i' if classes.casefold?}]\"\n            end.join\n          end\n        else\n          cls = Array(classes).reject { |c| c.is_a? Regexp }.group_by { |cl| cl.match?(/^!(?!!!)/) }\n          [(cls[false].to_a.map { |cl| \".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}\" } +\n          cls[true].to_a.map { |cl| \":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..))})\" }).join]\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "attribute_conditions", "signature": "def attribute_conditions(attributes)", "start_line": 43, "end_line": 64}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 121}
{"function_name": "class_conditions", "file_path": "capybara/lib/capybara/selector/builders/css_builder.rb", "focal_code": "def class_conditions(classes)\n        case classes\n        when XPath::Expression\n          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'\n        when Regexp\n          Selector::RegexpDisassembler.new(classes).alternated_substrings.map do |strs|\n            strs.map do |str|\n              \"[class*='#{str}'#{' i' if classes.casefold?}]\"\n            end.join\n          end\n        else\n          cls = Array(classes).reject { |c| c.is_a? Regexp }.group_by { |cl| cl.match?(/^!(?!!!)/) }\n          [(cls[false].to_a.map { |cl| \".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}\" } +\n          cls[true].to_a.map { |cl| \":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..))})\" }).join]\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class CSSBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**attributes)\n        @expression = attributes.inject(expression) do |css, (name, value)|\n          conditions = if name == :class\n            class_conditions(value)\n          elsif value.is_a? Regexp\n            regexp_conditions(name, value)\n          else\n            [attribute_conditions(name => value)]\n          end\n\n          ::Capybara::Selector::CSS.split(css).map do |sel|\n            next sel if conditions.empty?\n\n            conditions.map { |cond| sel + cond }.join(', ')\n          end.join(', ')\n        end\n      end\n\n    private\n\n      def regexp_conditions(name, value)\n        Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|\n          strs.map do |str|\n            \"[#{name}*='#{str}'#{' i' if value.casefold?}]\"\n          end.join\n        end\n      end\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            raise ArgumentError, \"XPath expressions are not supported for the :#{attribute} filter with CSS based selectors\"\n          when Regexp\n            Selector::RegexpDisassembler.new(value).substrings.map do |str|\n              \"[#{attribute}*='#{str}'#{' i' if value.casefold?}]\"\n            end.join\n          when true\n            \"[#{attribute}]\"\n          when false\n            ':not([attribute])'\n          else\n            if attribute == :id\n              \"##{::Capybara::Selector::CSS.escape(value)}\"\n            else\n              \"[#{attribute}='#{value}']\"\n            end\n          end\n        end.join\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression\n          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'\n        when Regexp\n          Selector::RegexpDisassembler.new(classes).alternated_substrings.map do |strs|\n            strs.map do |str|\n              \"[class*='#{str}'#{' i' if classes.casefold?}]\"\n            end.join\n          end\n        else\n          cls = Array(classes).reject { |c| c.is_a? Regexp }.group_by { |cl| cl.match?(/^!(?!!!)/) }\n          [(cls[false].to_a.map { |cl| \".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}\" } +\n          cls[true].to_a.map { |cl| \":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..))})\" }).join]\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "class_conditions", "signature": "def class_conditions(classes)", "start_line": 66, "end_line": 81}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 122}
{"function_name": "add_attribute_conditions", "file_path": "capybara/lib/capybara/selector/builders/xpath_builder.rb", "focal_code": "def add_attribute_conditions(**conditions)\n        @expression = conditions.inject(expression) do |xp, (name, value)|\n          conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)\n          return xp if conditions.nil?\n\n          if xp.is_a? XPath::Expression\n            xp[conditions]\n          else\n            \"(#{xp})[#{conditions}]\"\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class XPathBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**conditions)\n        @expression = conditions.inject(expression) do |xp, (name, value)|\n          conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)\n          return xp if conditions.nil?\n\n          if xp.is_a? XPath::Expression\n            xp[conditions]\n          else\n            \"(#{xp})[#{conditions}]\"\n          end\n        end\n      end\n\n    private\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            XPath.attr(attribute)[value]\n          when Regexp\n            XPath.attr(attribute)[regexp_to_xpath_conditions(value)]\n          when true\n            XPath.attr(attribute)\n          when false, nil\n            !XPath.attr(attribute)\n          else\n            XPath.attr(attribute) == value.to_s\n          end\n        end.reduce(:&)\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression, Regexp\n          attribute_conditions(class: classes)\n        else\n          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|\n            if klass.match?(/^!(?!!!)/)\n              !XPath.attr(:class).contains_word(klass.slice(1..))\n            else\n              XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))\n            end\n          end.reduce(:&)\n        end\n      end\n\n      def regexp_to_xpath_conditions(regexp)\n        condition = XPath.current\n        condition = condition.uppercase if regexp.casefold?\n        Selector::RegexpDisassembler.new(regexp).alternated_substrings.map do |strs|\n          strs.map { |str| condition.contains(str) }.reduce(:&)\n        end.reduce(:|)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add_attribute_conditions", "signature": "def add_attribute_conditions(**conditions)", "start_line": 15, "end_line": 26}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 123}
{"function_name": "attribute_conditions", "file_path": "capybara/lib/capybara/selector/builders/xpath_builder.rb", "focal_code": "def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            XPath.attr(attribute)[value]\n          when Regexp\n            XPath.attr(attribute)[regexp_to_xpath_conditions(value)]\n          when true\n            XPath.attr(attribute)\n          when false, nil\n            !XPath.attr(attribute)\n          else\n            XPath.attr(attribute) == value.to_s\n          end\n        end.reduce(:&)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class XPathBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**conditions)\n        @expression = conditions.inject(expression) do |xp, (name, value)|\n          conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)\n          return xp if conditions.nil?\n\n          if xp.is_a? XPath::Expression\n            xp[conditions]\n          else\n            \"(#{xp})[#{conditions}]\"\n          end\n        end\n      end\n\n    private\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            XPath.attr(attribute)[value]\n          when Regexp\n            XPath.attr(attribute)[regexp_to_xpath_conditions(value)]\n          when true\n            XPath.attr(attribute)\n          when false, nil\n            !XPath.attr(attribute)\n          else\n            XPath.attr(attribute) == value.to_s\n          end\n        end.reduce(:&)\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression, Regexp\n          attribute_conditions(class: classes)\n        else\n          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|\n            if klass.match?(/^!(?!!!)/)\n              !XPath.attr(:class).contains_word(klass.slice(1..))\n            else\n              XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))\n            end\n          end.reduce(:&)\n        end\n      end\n\n      def regexp_to_xpath_conditions(regexp)\n        condition = XPath.current\n        condition = condition.uppercase if regexp.casefold?\n        Selector::RegexpDisassembler.new(regexp).alternated_substrings.map do |strs|\n          strs.map { |str| condition.contains(str) }.reduce(:&)\n        end.reduce(:|)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "attribute_conditions", "signature": "def attribute_conditions(attributes)", "start_line": 30, "end_line": 45}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 124}
{"function_name": "class_conditions", "file_path": "capybara/lib/capybara/selector/builders/xpath_builder.rb", "focal_code": "def class_conditions(classes)\n        case classes\n        when XPath::Expression, Regexp\n          attribute_conditions(class: classes)\n        else\n          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|\n            if klass.match?(/^!(?!!!)/)\n              !XPath.attr(:class).contains_word(klass.slice(1..))\n            else\n              XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))\n            end\n          end.reduce(:&)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'xpath'\n\nmodule Capybara\n  class Selector\n    # @api private\n    class XPathBuilder\n      def initialize(expression)\n        @expression = expression || ''\n      end\n\n      attr_reader :expression\n\n      def add_attribute_conditions(**conditions)\n        @expression = conditions.inject(expression) do |xp, (name, value)|\n          conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)\n          return xp if conditions.nil?\n\n          if xp.is_a? XPath::Expression\n            xp[conditions]\n          else\n            \"(#{xp})[#{conditions}]\"\n          end\n        end\n      end\n\n    private\n\n      def attribute_conditions(attributes)\n        attributes.map do |attribute, value|\n          case value\n          when XPath::Expression\n            XPath.attr(attribute)[value]\n          when Regexp\n            XPath.attr(attribute)[regexp_to_xpath_conditions(value)]\n          when true\n            XPath.attr(attribute)\n          when false, nil\n            !XPath.attr(attribute)\n          else\n            XPath.attr(attribute) == value.to_s\n          end\n        end.reduce(:&)\n      end\n\n      def class_conditions(classes)\n        case classes\n        when XPath::Expression, Regexp\n          attribute_conditions(class: classes)\n        else\n          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|\n            if klass.match?(/^!(?!!!)/)\n              !XPath.attr(:class).contains_word(klass.slice(1..))\n            else\n              XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))\n            end\n          end.reduce(:&)\n        end\n      end\n\n      def regexp_to_xpath_conditions(regexp)\n        condition = XPath.current\n        condition = condition.uppercase if regexp.casefold?\n        Selector::RegexpDisassembler.new(regexp).alternated_substrings.map do |strs|\n          strs.map { |str| condition.contains(str) }.reduce(:&)\n        end.reduce(:|)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "class_conditions", "signature": "def class_conditions(classes)", "start_line": 47, "end_line": 60}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 125}
{"function_name": "combine_locators", "file_path": "capybara/lib/capybara/selector/definition/button.rb", "focal_code": "def combine_locators(locator, config:)\n    [\n      XPath.attr(:id).equals(locator),\n      XPath.attr(:name).equals(locator),\n      XPath.attr(:value).is(locator),\n      XPath.attr(:title).is(locator),\n      (XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)),\n      (XPath.attr(:'aria-label').is(locator) if config.enable_aria_label),\n      (XPath.attr(config.test_id) == locator if config.test_id)\n    ].compact.inject(&:|)\n  end", "file_content": "# frozen_string_literal: true\n\nCapybara.add_selector(:button, locator_type: [String, Symbol]) do\n  xpath(:value, :title, :type, :name) do |locator, **options|\n    input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]\n    btn_xpath = XPath.descendant(:button)\n    aria_btn_xpath = XPath.descendant[XPath.attr(:role).equals('button')]\n    image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']\n\n    unless locator.nil?\n      locator = locator.to_s\n      locator_matchers = combine_locators(locator, config: self)\n      btn_matchers = locator_matchers |\n                     XPath.string.n.is(locator) |\n                     XPath.descendant(:img)[XPath.attr(:alt).is(locator)]\n\n      label_contains_xpath = locate_label(locator).descendant[labellable_elements]\n      input_btn_xpath = input_btn_xpath[locator_matchers]\n      btn_xpath = btn_xpath[btn_matchers]\n      aria_btn_xpath = aria_btn_xpath[btn_matchers]\n\n      alt_matches = XPath.attr(:alt).is(locator)\n      alt_matches |= XPath.attr(:'aria-label').is(locator) if enable_aria_label\n      image_btn_xpath = image_btn_xpath[alt_matches]\n    end\n\n    btn_xpaths = [input_btn_xpath, btn_xpath, image_btn_xpath, label_contains_xpath].compact\n    btn_xpaths << aria_btn_xpath if enable_aria_role\n\n    %i[value title type].inject(btn_xpaths.inject(&:union)) do |memo, ef|\n      memo.where(find_by_attr(ef, options[ef]))\n    end\n  end\n\n  node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }\n  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }\n\n  node_filter(:name) { |node, value| !value.is_a?(Regexp) || value.match?(node[:name]) }\n  expression_filter(:name) do |xpath, val|\n    builder(xpath).add_attribute_conditions(name: val)\n  end\n\n  describe_expression_filters do |disabled: nil, **options|\n    desc = +''\n    desc << ' that is not disabled' if disabled == false\n    desc << describe_all_expression_filters(**options)\n  end\n\n  describe_node_filters do |disabled: nil, **|\n    ' that is disabled' if disabled == true\n  end\n\n  def combine_locators(locator, config:)\n    [\n      XPath.attr(:id).equals(locator),\n      XPath.attr(:name).equals(locator),\n      XPath.attr(:value).is(locator),\n      XPath.attr(:title).is(locator),\n      (XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)),\n      (XPath.attr(:'aria-label').is(locator) if config.enable_aria_label),\n      (XPath.attr(config.test_id) == locator if config.test_id)\n    ].compact.inject(&:|)\n  end\n\n  def labellable_elements\n    (XPath.self(:input) & XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')) | XPath.self(:button)\n  end\nend\n", "language": "Ruby", "function_component": {"name": "combine_locators", "signature": "def combine_locators(locator, config:)", "start_line": 53, "end_line": 63}, "metadata": {"module": "", "class_name": "", "class_signature": ""}, "task_id": 126}
{"function_name": "match_row", "file_path": "capybara/lib/capybara/selector/definition/table.rb", "focal_code": "def match_row(row, match_size: false)\n    xp = XPath.descendant(:tr)[\n      if row.is_a? Hash\n        row_match_cells_to_headers(row)\n      else\n        XPath.descendant(:td)[row_match_ordered_cells(row)]\n      end\n    ]\n    xp = xp[XPath.descendant(:td).count.equals(row.size)] if match_size\n    xp\n  end", "file_content": "# frozen_string_literal: true\n\nCapybara.add_selector(:table, locator_type: [String, Symbol]) do\n  xpath do |locator, caption: nil, **|\n    xpath = XPath.descendant(:table)\n    unless locator.nil?\n      locator_matchers = (XPath.attr(:id) == locator.to_s) | XPath.descendant(:caption).is(locator.to_s)\n      locator_matchers |= XPath.attr(test_id) == locator.to_s if test_id\n      xpath = xpath[locator_matchers]\n    end\n    xpath = xpath[XPath.descendant(:caption) == caption] if caption\n    xpath\n  end\n\n  expression_filter(:with_cols, valid_values: [Array]) do |xpath, cols|\n    col_conditions = cols.map do |col|\n      if col.is_a? Hash\n        col.reduce(nil) do |xp, (header, cell_str)|\n          header = XPath.descendant(:th)[XPath.string.n.is(header)]\n          td = XPath.descendant(:tr)[header].descendant(:td)\n          cell_condition = XPath.string.n.is(cell_str)\n          if xp\n            prev_cell = XPath.ancestor(:table)[1].join(xp)\n            cell_condition &= (prev_cell & prev_col_position?(prev_cell))\n          end\n          td[cell_condition]\n        end\n      else\n        cells_xp = col.reduce(nil) do |prev_cell, cell_str|\n          cell_condition = XPath.string.n.is(cell_str)\n\n          if prev_cell\n            prev_cell = XPath.ancestor(:tr)[1].preceding_sibling(:tr).join(prev_cell)\n            cell_condition &= (prev_cell & prev_col_position?(prev_cell))\n          end\n\n          XPath.descendant(:td)[cell_condition]\n        end\n        XPath.descendant(:tr).join(cells_xp)\n      end\n    end.reduce(:&)\n    xpath[col_conditions]\n  end\n\n  expression_filter(:cols, valid_values: [Array]) do |xpath, cols|\n    raise ArgumentError, ':cols must be an Array of Arrays' unless cols.all?(Array)\n\n    rows = cols.transpose\n    col_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)\n    xpath[match_row_count(rows.size)][col_conditions]\n  end\n\n  expression_filter(:with_rows, valid_values: [Array]) do |xpath, rows|\n    rows_conditions = rows.map { |row| match_row(row) }.reduce(:&)\n    xpath[rows_conditions]\n  end\n\n  expression_filter(:rows, valid_values: [Array]) do |xpath, rows|\n    rows_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)\n    xpath[match_row_count(rows.size)][rows_conditions]\n  end\n\n  describe_expression_filters do |caption: nil, **|\n    \" with caption \\\"#{caption}\\\"\" if caption\n  end\n\n  def prev_col_position?(cell)\n    XPath.position.equals(cell_position(cell))\n  end\n\n  def cell_position(cell)\n    cell.preceding_sibling(:td).count.plus(1)\n  end\n\n  def match_row(row, match_size: false)\n    xp = XPath.descendant(:tr)[\n      if row.is_a? Hash\n        row_match_cells_to_headers(row)\n      else\n        XPath.descendant(:td)[row_match_ordered_cells(row)]\n      end\n    ]\n    xp = xp[XPath.descendant(:td).count.equals(row.size)] if match_size\n    xp\n  end\n\n  def match_row_count(size)\n    XPath.descendant(:tbody).descendant(:tr).count.equals(size) |\n      (XPath.descendant(:tr).count.equals(size) & ~XPath.descendant(:tbody))\n  end\n\n  def row_match_cells_to_headers(row)\n    row.map do |header, cell|\n      header_xp = XPath.ancestor(:table)[1].descendant(:tr)[1].descendant(:th)[XPath.string.n.is(header)]\n      XPath.descendant(:td)[\n        XPath.string.n.is(cell) & header_xp.boolean & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))\n      ]\n    end.reduce(:&)\n  end\n\n  def row_match_ordered_cells(row)\n    row_conditions = row.map do |cell|\n      XPath.self(:td)[XPath.string.n.is(cell)]\n    end\n    row_conditions.reverse.reduce do |cond, cell|\n      cell[XPath.following_sibling[cond]]\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "match_row", "signature": "def match_row(row, match_size: false)", "start_line": 75, "end_line": 85}, "metadata": {"module": "", "class_name": "", "class_signature": ""}, "task_id": 127}
{"function_name": "initialize", "file_path": "capybara/lib/capybara/selector/filters/node_filter.rb", "focal_code": "def initialize(name, matcher, block, **options)\n          super\n          @block = if boolean?\n            proc do |node, value|\n              error_cnt = errors.size\n              block.call(node, value).tap do |res|\n                add_error(\"Expected #{name} #{value} but it wasn't\") if !res && error_cnt == errors.size\n              end\n            end\n          else\n            block\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selector/filters/base'\n\nmodule Capybara\n  class Selector\n    module Filters\n      class NodeFilter < Base\n        def initialize(name, matcher, block, **options)\n          super\n          @block = if boolean?\n            proc do |node, value|\n              error_cnt = errors.size\n              block.call(node, value).tap do |res|\n                add_error(\"Expected #{name} #{value} but it wasn't\") if !res && error_cnt == errors.size\n              end\n            end\n          else\n            block\n          end\n        end\n\n        def matches?(node, name, value, context = nil)\n          apply(node, name, value, true, context)\n        rescue Capybara::ElementNotFound\n          false\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(name, matcher, block, **options)", "start_line": 9, "end_line": 21}, "metadata": {"module": "Capybara", "class_name": "Selector", "class_signature": "class Selector"}, "task_id": 128}
{"function_name": "reset!", "file_path": "capybara/lib/capybara/selenium/driver_specializations/chrome_driver.rb", "focal_code": "def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n    return super if chromedriver_version < 73\n\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      clear_storage unless uniform_storage_clear?\n      @browser.navigate.to('about:blank')\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      accept_unhandled_reset_alert\n      retry\n    end\n\n    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/nodes/chrome_node'\nrequire 'capybara/selenium/patches/logs'\n\nmodule Capybara::Selenium::Driver::ChromeDriver\n  def self.extended(base)\n    bridge = base.send(:bridge)\n    bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)\n    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)\n    base.options[:native_displayed] = false if base.options[:native_displayed].nil?\n  end\n\n  def fullscreen_window(handle)\n    within_given_window(handle) do\n      super\n    rescue NoMethodError => e\n      raise unless e.message.include?('full_screen_window')\n\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/window/fullscreen\", {})\n      result['value']\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    super\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    raise unless e.message.include?('failed to change window state')\n\n    # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen\n    # and raises unnecessary error. Wait a bit and try again.\n    sleep 0.25\n    super\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n    return super if chromedriver_version < 73\n\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      clear_storage unless uniform_storage_clear?\n      @browser.navigate.to('about:blank')\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      accept_unhandled_reset_alert\n      retry\n    end\n\n    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)\n  end\n\nprivate\n\n  def storage_types_to_clear\n    types = ['cookies']\n    types << 'local_storage' if clear_all_storage?\n    types.join(',')\n  end\n\n  def clear_all_storage?\n    storage_clears.none? false\n  end\n\n  def uniform_storage_clear?\n    storage_clears.uniq { |s| s == false }.length <= 1\n  end\n\n  def storage_clears\n    options.values_at(:clear_session_storage, :clear_local_storage)\n  end\n\n  def clear_storage\n    # Chrome errors if attempt to clear storage on about:blank\n    # In W3C mode it crashes chromedriver\n    url = current_url\n    super unless url.nil? || url.start_with?('about:')\n  end\n\n  def delete_all_cookies\n    execute_cdp('Network.clearBrowserCookies')\n  rescue *cdp_unsupported_errors\n    # If the CDP clear isn't supported do original limited clear\n    super\n  end\n\n  def cdp_unsupported_errors\n    @cdp_unsupported_errors ||= [Selenium::WebDriver::Error::WebDriverError]\n  end\n\n  def execute_cdp(cmd, params = {})\n    if browser.respond_to? :execute_cdp\n      browser.execute_cdp(cmd, **params)\n    else\n      args = { cmd: cmd, params: params }\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/goog/cdp/execute\", args)\n      result['value']\n    end\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::ChromeNode.new(self, native_node, initial_cache)\n  end\n\n  def chromedriver_version\n    @chromedriver_version ||= begin\n      caps = browser.capabilities\n      caps['chrome']&.fetch('chromedriverVersion', nil).to_f\n    end\n  end\nend\n\nCapybara::Selenium::Driver.register_specialization :chrome, Capybara::Selenium::Driver::ChromeDriver\n", "language": "Ruby", "function_component": {"name": "reset!", "signature": "def reset! # Use instance variable directly so we avoid starting the browser just to reset the session", "start_line": 36, "end_line": 55}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 129}
{"function_name": "fullscreen_window", "file_path": "capybara/lib/capybara/selenium/driver_specializations/edge_driver.rb", "focal_code": "def fullscreen_window(handle)\n    return super if edgedriver_version < 75\n\n    within_given_window(handle) do\n      super\n    rescue NoMethodError => e\n      raise unless e.message.include?('full_screen_window')\n\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/window/fullscreen\", {})\n      result['value']\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/nodes/edge_node'\n\nmodule Capybara::Selenium::Driver::EdgeDriver\n  def self.extended(base)\n    bridge = base.send(:bridge)\n    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)\n    base.options[:native_displayed] = false if base.options[:native_displayed].nil?\n  end\n\n  def fullscreen_window(handle)\n    return super if edgedriver_version < 75\n\n    within_given_window(handle) do\n      super\n    rescue NoMethodError => e\n      raise unless e.message.include?('full_screen_window')\n\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/window/fullscreen\", {})\n      result['value']\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    super\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    raise unless e.message.include?('failed to change window state')\n\n    # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen\n    # and raises unnecessary error. Wait a bit and try again.\n    sleep 0.25\n    super\n  end\n\n  def reset!\n    return super if edgedriver_version < 75\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      clear_storage unless uniform_storage_clear?\n      @browser.navigate.to('about:blank')\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      accept_unhandled_reset_alert\n      retry\n    end\n\n    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)\n  end\n\n  def download_path=(path)\n    if @browser.respond_to?(:download_path=)\n      @browser.download_path = path\n    else\n      # Not yet implemented in seleniun-webdriver for edge so do it ourselves\n      execute_cdp('Page.setDownloadBehavior', behavior: 'allow', downloadPath: path)\n    end\n  end\n\nprivate\n\n  def storage_types_to_clear\n    types = ['cookies']\n    types << 'local_storage' if clear_all_storage?\n    types.join(',')\n  end\n\n  def clear_all_storage?\n    storage_clears.none? false\n  end\n\n  def uniform_storage_clear?\n    storage_clears.uniq { |s| s == false }.length <= 1\n  end\n\n  def storage_clears\n    options.values_at(:clear_session_storage, :clear_local_storage)\n  end\n\n  def clear_storage\n    # Edgedriver crashes if attempt to clear storage on about:blank\n    url = current_url\n    super unless url.nil? || url.start_with?('about:')\n  end\n\n  def delete_all_cookies\n    return super if edgedriver_version < 75\n\n    execute_cdp('Network.clearBrowserCookies')\n  rescue *cdp_unsupported_errors\n    # If the CDP clear isn't supported do original limited clear\n    super\n  end\n\n  def cdp_unsupported_errors\n    @cdp_unsupported_errors ||= [Selenium::WebDriver::Error::WebDriverError]\n  end\n\n  def execute_cdp(cmd, params = {})\n    if browser.respond_to? :execute_cdp\n      browser.execute_cdp(cmd, **params)\n    else\n      args = { cmd: cmd, params: params }\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/ms/cdp/execute\", args)\n      result['value']\n    end\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::EdgeNode.new(self, native_node, initial_cache)\n  end\n\n  def edgedriver_version\n    @edgedriver_version ||= begin\n      caps = browser.capabilities\n      caps['msedge']&.fetch('msedgedriverVersion', nil).to_f\n    end\n  end\nend\n\nCapybara::Selenium::Driver.register_specialization :edge, Capybara::Selenium::Driver::EdgeDriver\nCapybara::Selenium::Driver.register_specialization :edge_chrome, Capybara::Selenium::Driver::EdgeDriver\n", "language": "Ruby", "function_component": {"name": "fullscreen_window", "signature": "def fullscreen_window(handle)", "start_line": 12, "end_line": 23}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 130}
{"function_name": "reset!", "file_path": "capybara/lib/capybara/selenium/driver_specializations/edge_driver.rb", "focal_code": "def reset!\n    return super if edgedriver_version < 75\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      clear_storage unless uniform_storage_clear?\n      @browser.navigate.to('about:blank')\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      accept_unhandled_reset_alert\n      retry\n    end\n\n    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/nodes/edge_node'\n\nmodule Capybara::Selenium::Driver::EdgeDriver\n  def self.extended(base)\n    bridge = base.send(:bridge)\n    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)\n    base.options[:native_displayed] = false if base.options[:native_displayed].nil?\n  end\n\n  def fullscreen_window(handle)\n    return super if edgedriver_version < 75\n\n    within_given_window(handle) do\n      super\n    rescue NoMethodError => e\n      raise unless e.message.include?('full_screen_window')\n\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/window/fullscreen\", {})\n      result['value']\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    super\n  rescue Selenium::WebDriver::Error::UnknownError => e\n    raise unless e.message.include?('failed to change window state')\n\n    # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen\n    # and raises unnecessary error. Wait a bit and try again.\n    sleep 0.25\n    super\n  end\n\n  def reset!\n    return super if edgedriver_version < 75\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n\n    timer = Capybara::Helpers.timer(expire_in: 10)\n    begin\n      clear_storage unless uniform_storage_clear?\n      @browser.navigate.to('about:blank')\n      wait_for_empty_page(timer)\n    rescue *unhandled_alert_errors\n      accept_unhandled_reset_alert\n      retry\n    end\n\n    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)\n  end\n\n  def download_path=(path)\n    if @browser.respond_to?(:download_path=)\n      @browser.download_path = path\n    else\n      # Not yet implemented in seleniun-webdriver for edge so do it ourselves\n      execute_cdp('Page.setDownloadBehavior', behavior: 'allow', downloadPath: path)\n    end\n  end\n\nprivate\n\n  def storage_types_to_clear\n    types = ['cookies']\n    types << 'local_storage' if clear_all_storage?\n    types.join(',')\n  end\n\n  def clear_all_storage?\n    storage_clears.none? false\n  end\n\n  def uniform_storage_clear?\n    storage_clears.uniq { |s| s == false }.length <= 1\n  end\n\n  def storage_clears\n    options.values_at(:clear_session_storage, :clear_local_storage)\n  end\n\n  def clear_storage\n    # Edgedriver crashes if attempt to clear storage on about:blank\n    url = current_url\n    super unless url.nil? || url.start_with?('about:')\n  end\n\n  def delete_all_cookies\n    return super if edgedriver_version < 75\n\n    execute_cdp('Network.clearBrowserCookies')\n  rescue *cdp_unsupported_errors\n    # If the CDP clear isn't supported do original limited clear\n    super\n  end\n\n  def cdp_unsupported_errors\n    @cdp_unsupported_errors ||= [Selenium::WebDriver::Error::WebDriverError]\n  end\n\n  def execute_cdp(cmd, params = {})\n    if browser.respond_to? :execute_cdp\n      browser.execute_cdp(cmd, **params)\n    else\n      args = { cmd: cmd, params: params }\n      result = bridge.http.call(:post, \"session/#{bridge.session_id}/ms/cdp/execute\", args)\n      result['value']\n    end\n  end\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::EdgeNode.new(self, native_node, initial_cache)\n  end\n\n  def edgedriver_version\n    @edgedriver_version ||= begin\n      caps = browser.capabilities\n      caps['msedge']&.fetch('msedgedriverVersion', nil).to_f\n    end\n  end\nend\n\nCapybara::Selenium::Driver.register_specialization :edge, Capybara::Selenium::Driver::EdgeDriver\nCapybara::Selenium::Driver.register_specialization :edge_chrome, Capybara::Selenium::Driver::EdgeDriver\n", "language": "Ruby", "function_component": {"name": "reset!", "signature": "def reset! return super if edgedriver_version < 75", "start_line": 36, "end_line": 55}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 131}
{"function_name": "reset!", "file_path": "capybara/lib/capybara/selenium/driver_specializations/firefox_driver.rb", "focal_code": "def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    if browser_version >= 68\n      begin\n        # Firefox 68 hangs if we try to switch windows while a modal is visible\n        browser.switch_to.alert&.dismiss\n      rescue Selenium::WebDriver::Error::NoSuchAlertError\n        # Swallow\n      end\n    end\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n    super\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/nodes/firefox_node'\n\nmodule Capybara::Selenium::Driver::FirefoxDriver\n  def self.extended(driver)\n    driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver\n    bridge = driver.send(:bridge)\n    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)\n  end\nend\n\nmodule Capybara::Selenium::Driver::W3CFirefoxDriver\n  class << self\n    def extended(driver)\n      require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(driver.browser)\n      driver.options[:native_displayed] = false if driver.options[:native_displayed].nil?\n    end\n\n    def pause_broken?(sel_driver)\n      sel_driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')\n    end\n  end\n\n  def resize_window_to(handle, width, height)\n    within_given_window(handle) do\n      # Don't set the size if already set - See https://github.com/mozilla/geckodriver/issues/643\n      if window_size(handle) == [width, height]\n        {}\n      else\n        super\n      end\n    end\n  end\n\n  def reset!\n    # Use instance variable directly so we avoid starting the browser just to reset the session\n    return unless @browser\n\n    if browser_version >= 68\n      begin\n        # Firefox 68 hangs if we try to switch windows while a modal is visible\n        browser.switch_to.alert&.dismiss\n      rescue Selenium::WebDriver::Error::NoSuchAlertError\n        # Swallow\n      end\n    end\n\n    switch_to_window(window_handles.first)\n    window_handles.slice(1..).each { |win| close_window(win) }\n    super\n  end\n\n  def refresh\n    # Accept any \"will repost content\" confirmation that occurs\n    accept_modal :confirm, wait: 0.1 do\n      super\n    end\n  rescue Capybara::ModalNotFound\n    # No modal was opened - page has refreshed - ignore\n  end\n\n  def switch_to_frame(frame)\n    return super unless frame == :parent\n\n    # geckodriver/firefox has an issue if the current frame is removed from within it\n    # so we have to move to the default_content and iterate back through the frames\n    handles = @frame_handles[current_window_handle]\n    browser.switch_to.default_content\n    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh.native) }\n  end\n\nprivate\n\n  def build_node(native_node, initial_cache = {})\n    ::Capybara::Selenium::FirefoxNode.new(self, native_node, initial_cache)\n  end\n\n  def browser_version\n    browser.capabilities[:browser_version].to_f\n  end\nend\n\nCapybara::Selenium::Driver.register_specialization :firefox, Capybara::Selenium::Driver::FirefoxDriver\n", "language": "Ruby", "function_component": {"name": "reset!", "signature": "def reset! # Use instance variable directly so we avoid starting the browser just to reset the session", "start_line": 36, "end_line": 52}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 132}
{"function_name": "emulate_click", "file_path": "capybara/lib/capybara/selenium/extensions/file_input_click_emulation.rb", "focal_code": "def emulate_click\n      driver.execute_script(<<~JS, self)\n        arguments[0].dispatchEvent(\n          new MouseEvent('click', {\n            view: window,\n            bubbles: true,\n            cancelable: true\n          }));\n      JS\n    end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::Selenium::Node\n  module FileInputClickEmulation\n    def click(keys = [], **options)\n      super\n    rescue Selenium::WebDriver::Error::InvalidArgumentError\n      return emulate_click if attaching_file? && visible_file_field?\n\n      raise\n    end\n\n  private\n\n    def visible_file_field?\n      (attrs(:tagName, :type).map { |val| val&.downcase } == %w[input file]) && visible?\n    end\n\n    def attaching_file?\n      caller_locations.any? { |cl| cl.base_label == 'attach_file' }\n    end\n\n    def emulate_click\n      driver.execute_script(<<~JS, self)\n        arguments[0].dispatchEvent(\n          new MouseEvent('click', {\n            view: window,\n            bubbles: true,\n            cancelable: true\n          }));\n      JS\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "emulate_click", "signature": "def emulate_click driver.execute_script(<<~JS, self)", "start_line": 23, "end_line": 32}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node"}, "task_id": 133}
{"function_name": "find_by", "file_path": "capybara/lib/capybara/selenium/extensions/find.rb", "focal_code": "def find_by(format, selector, uses_visibility:, texts:, styles:, position:)\n        els = find_context.find_elements(format, selector)\n        hints = []\n\n        if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n          els = filter_by_text(els, texts) unless texts.empty?\n          hints = begin\n            gather_hints(els, uses_visibility: uses_visibility, styles: styles, position: position)\n          rescue Selenium::WebDriver::Error::JavascriptError\n            # Unclear how this can happen but issue #2729 indicates it can\n            []\n          end\n        end\n        els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Find\n      def find_xpath(selector, uses_visibility: false, styles: nil, position: false, **_options)\n        find_by(:xpath, selector, uses_visibility: uses_visibility, texts: [], styles: styles, position: position)\n      end\n\n      def find_css(selector, uses_visibility: false, texts: [], styles: nil, position: false, **_options)\n        find_by(:css, selector, uses_visibility: uses_visibility, texts: texts, styles: styles, position: position)\n      end\n\n    private\n\n      def find_by(format, selector, uses_visibility:, texts:, styles:, position:)\n        els = find_context.find_elements(format, selector)\n        hints = []\n\n        if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n          els = filter_by_text(els, texts) unless texts.empty?\n          hints = begin\n            gather_hints(els, uses_visibility: uses_visibility, styles: styles, position: position)\n          rescue Selenium::WebDriver::Error::JavascriptError\n            # Unclear how this can happen but issue #2729 indicates it can\n            []\n          end\n        end\n        els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }\n      end\n\n      def gather_hints(elements, uses_visibility:, styles:, position:)\n        hints_js, functions = build_hints_js(uses_visibility, styles, position)\n        return [] unless functions.any?\n\n        (es_context.execute_script(hints_js, elements) || []).map! do |results|\n          hint = {}\n          hint[:style] = results.pop if functions.include?(:style_func)\n          hint[:position] = results.pop if functions.include?(:position_func)\n          hint[:visible] = results.pop if functions.include?(:vis_func)\n          hint\n        end\n      rescue ::Selenium::WebDriver::Error::StaleElementReferenceError,\n             ::Capybara::NotSupportedByDriverError\n        # warn 'Unexpected Stale Element Error - skipping optimization'\n        []\n      end\n\n      def filter_by_text(elements, texts)\n        es_context.execute_script <<~JS, elements, texts\n          var texts = arguments[1];\n          return arguments[0].filter(function(el){\n            var content = el.textContent.toLowerCase();\n            return texts.every(function(txt){ return content.indexOf(txt.toLowerCase()) != -1 });\n          })\n        JS\n      end\n\n      def build_hints_js(uses_visibility, styles, position)\n        functions = []\n        hints_js = +''\n\n        if uses_visibility && !is_displayed_atom.empty?\n          hints_js << <<~VISIBILITY_JS\n            var vis_func = #{is_displayed_atom};\n          VISIBILITY_JS\n          functions << :vis_func\n        end\n\n        if position\n          hints_js << <<~POSITION_JS\n            var position_func = function(el){\n              return el.getBoundingClientRect();\n            };\n          POSITION_JS\n          functions << :position_func\n        end\n\n        if styles.is_a? Hash\n          hints_js << <<~STYLE_JS\n            var style_func = function(el){\n              var el_styles = window.getComputedStyle(el);\n              return #{styles.keys.map(&:to_s)}.reduce(function(res, style){\n                res[style] = el_styles[style];\n                return res;\n              }, {});\n            };\n          STYLE_JS\n          functions << :style_func\n        end\n\n        hints_js << <<~EACH_JS\n          return arguments[0].map(function(el){\n            return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });\n          });\n        EACH_JS\n\n        [hints_js, functions]\n      end\n\n      def es_context\n        respond_to?(:execute_script) ? self : driver\n      end\n\n      def is_displayed_atom # rubocop:disable Naming/PredicatePrefix\n        @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars\n          browser.send(:bridge).send(:read_atom, 'isDisplayed')\n        rescue StandardError\n          # If the atom doesn't exist or other error\n          ''\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_by", "signature": "def find_by(format, selector, uses_visibility:, texts:, styles:, position:)", "start_line": 16, "end_line": 30}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 134}
{"function_name": "gather_hints", "file_path": "capybara/lib/capybara/selenium/extensions/find.rb", "focal_code": "def gather_hints(elements, uses_visibility:, styles:, position:)\n        hints_js, functions = build_hints_js(uses_visibility, styles, position)\n        return [] unless functions.any?\n\n        (es_context.execute_script(hints_js, elements) || []).map! do |results|\n          hint = {}\n          hint[:style] = results.pop if functions.include?(:style_func)\n          hint[:position] = results.pop if functions.include?(:position_func)\n          hint[:visible] = results.pop if functions.include?(:vis_func)\n          hint\n        end\n      rescue ::Selenium::WebDriver::Error::StaleElementReferenceError,\n             ::Capybara::NotSupportedByDriverError\n        # warn 'Unexpected Stale Element Error - skipping optimization'\n        []\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Find\n      def find_xpath(selector, uses_visibility: false, styles: nil, position: false, **_options)\n        find_by(:xpath, selector, uses_visibility: uses_visibility, texts: [], styles: styles, position: position)\n      end\n\n      def find_css(selector, uses_visibility: false, texts: [], styles: nil, position: false, **_options)\n        find_by(:css, selector, uses_visibility: uses_visibility, texts: texts, styles: styles, position: position)\n      end\n\n    private\n\n      def find_by(format, selector, uses_visibility:, texts:, styles:, position:)\n        els = find_context.find_elements(format, selector)\n        hints = []\n\n        if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n          els = filter_by_text(els, texts) unless texts.empty?\n          hints = begin\n            gather_hints(els, uses_visibility: uses_visibility, styles: styles, position: position)\n          rescue Selenium::WebDriver::Error::JavascriptError\n            # Unclear how this can happen but issue #2729 indicates it can\n            []\n          end\n        end\n        els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }\n      end\n\n      def gather_hints(elements, uses_visibility:, styles:, position:)\n        hints_js, functions = build_hints_js(uses_visibility, styles, position)\n        return [] unless functions.any?\n\n        (es_context.execute_script(hints_js, elements) || []).map! do |results|\n          hint = {}\n          hint[:style] = results.pop if functions.include?(:style_func)\n          hint[:position] = results.pop if functions.include?(:position_func)\n          hint[:visible] = results.pop if functions.include?(:vis_func)\n          hint\n        end\n      rescue ::Selenium::WebDriver::Error::StaleElementReferenceError,\n             ::Capybara::NotSupportedByDriverError\n        # warn 'Unexpected Stale Element Error - skipping optimization'\n        []\n      end\n\n      def filter_by_text(elements, texts)\n        es_context.execute_script <<~JS, elements, texts\n          var texts = arguments[1];\n          return arguments[0].filter(function(el){\n            var content = el.textContent.toLowerCase();\n            return texts.every(function(txt){ return content.indexOf(txt.toLowerCase()) != -1 });\n          })\n        JS\n      end\n\n      def build_hints_js(uses_visibility, styles, position)\n        functions = []\n        hints_js = +''\n\n        if uses_visibility && !is_displayed_atom.empty?\n          hints_js << <<~VISIBILITY_JS\n            var vis_func = #{is_displayed_atom};\n          VISIBILITY_JS\n          functions << :vis_func\n        end\n\n        if position\n          hints_js << <<~POSITION_JS\n            var position_func = function(el){\n              return el.getBoundingClientRect();\n            };\n          POSITION_JS\n          functions << :position_func\n        end\n\n        if styles.is_a? Hash\n          hints_js << <<~STYLE_JS\n            var style_func = function(el){\n              var el_styles = window.getComputedStyle(el);\n              return #{styles.keys.map(&:to_s)}.reduce(function(res, style){\n                res[style] = el_styles[style];\n                return res;\n              }, {});\n            };\n          STYLE_JS\n          functions << :style_func\n        end\n\n        hints_js << <<~EACH_JS\n          return arguments[0].map(function(el){\n            return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });\n          });\n        EACH_JS\n\n        [hints_js, functions]\n      end\n\n      def es_context\n        respond_to?(:execute_script) ? self : driver\n      end\n\n      def is_displayed_atom # rubocop:disable Naming/PredicatePrefix\n        @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars\n          browser.send(:bridge).send(:read_atom, 'isDisplayed')\n        rescue StandardError\n          # If the atom doesn't exist or other error\n          ''\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "gather_hints", "signature": "def gather_hints(elements, uses_visibility:, styles:, position:)", "start_line": 32, "end_line": 47}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 135}
{"function_name": "build_hints_js", "file_path": "capybara/lib/capybara/selenium/extensions/find.rb", "focal_code": "def build_hints_js(uses_visibility, styles, position)\n        functions = []\n        hints_js = +''\n\n        if uses_visibility && !is_displayed_atom.empty?\n          hints_js << <<~VISIBILITY_JS\n            var vis_func = #{is_displayed_atom};\n          VISIBILITY_JS\n          functions << :vis_func\n        end\n\n        if position\n          hints_js << <<~POSITION_JS\n            var position_func = function(el){\n              return el.getBoundingClientRect();\n            };\n          POSITION_JS\n          functions << :position_func\n        end\n\n        if styles.is_a? Hash\n          hints_js << <<~STYLE_JS\n            var style_func = function(el){\n              var el_styles = window.getComputedStyle(el);\n              return #{styles.keys.map(&:to_s)}.reduce(function(res, style){\n                res[style] = el_styles[style];\n                return res;\n              }, {});\n            };\n          STYLE_JS\n          functions << :style_func\n        end\n\n        hints_js << <<~EACH_JS\n          return arguments[0].map(function(el){\n            return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });\n          });\n        EACH_JS\n\n        [hints_js, functions]\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Find\n      def find_xpath(selector, uses_visibility: false, styles: nil, position: false, **_options)\n        find_by(:xpath, selector, uses_visibility: uses_visibility, texts: [], styles: styles, position: position)\n      end\n\n      def find_css(selector, uses_visibility: false, texts: [], styles: nil, position: false, **_options)\n        find_by(:css, selector, uses_visibility: uses_visibility, texts: texts, styles: styles, position: position)\n      end\n\n    private\n\n      def find_by(format, selector, uses_visibility:, texts:, styles:, position:)\n        els = find_context.find_elements(format, selector)\n        hints = []\n\n        if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n          els = filter_by_text(els, texts) unless texts.empty?\n          hints = begin\n            gather_hints(els, uses_visibility: uses_visibility, styles: styles, position: position)\n          rescue Selenium::WebDriver::Error::JavascriptError\n            # Unclear how this can happen but issue #2729 indicates it can\n            []\n          end\n        end\n        els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }\n      end\n\n      def gather_hints(elements, uses_visibility:, styles:, position:)\n        hints_js, functions = build_hints_js(uses_visibility, styles, position)\n        return [] unless functions.any?\n\n        (es_context.execute_script(hints_js, elements) || []).map! do |results|\n          hint = {}\n          hint[:style] = results.pop if functions.include?(:style_func)\n          hint[:position] = results.pop if functions.include?(:position_func)\n          hint[:visible] = results.pop if functions.include?(:vis_func)\n          hint\n        end\n      rescue ::Selenium::WebDriver::Error::StaleElementReferenceError,\n             ::Capybara::NotSupportedByDriverError\n        # warn 'Unexpected Stale Element Error - skipping optimization'\n        []\n      end\n\n      def filter_by_text(elements, texts)\n        es_context.execute_script <<~JS, elements, texts\n          var texts = arguments[1];\n          return arguments[0].filter(function(el){\n            var content = el.textContent.toLowerCase();\n            return texts.every(function(txt){ return content.indexOf(txt.toLowerCase()) != -1 });\n          })\n        JS\n      end\n\n      def build_hints_js(uses_visibility, styles, position)\n        functions = []\n        hints_js = +''\n\n        if uses_visibility && !is_displayed_atom.empty?\n          hints_js << <<~VISIBILITY_JS\n            var vis_func = #{is_displayed_atom};\n          VISIBILITY_JS\n          functions << :vis_func\n        end\n\n        if position\n          hints_js << <<~POSITION_JS\n            var position_func = function(el){\n              return el.getBoundingClientRect();\n            };\n          POSITION_JS\n          functions << :position_func\n        end\n\n        if styles.is_a? Hash\n          hints_js << <<~STYLE_JS\n            var style_func = function(el){\n              var el_styles = window.getComputedStyle(el);\n              return #{styles.keys.map(&:to_s)}.reduce(function(res, style){\n                res[style] = el_styles[style];\n                return res;\n              }, {});\n            };\n          STYLE_JS\n          functions << :style_func\n        end\n\n        hints_js << <<~EACH_JS\n          return arguments[0].map(function(el){\n            return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });\n          });\n        EACH_JS\n\n        [hints_js, functions]\n      end\n\n      def es_context\n        respond_to?(:execute_script) ? self : driver\n      end\n\n      def is_displayed_atom # rubocop:disable Naming/PredicatePrefix\n        @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars\n          browser.send(:bridge).send(:read_atom, 'isDisplayed')\n        rescue StandardError\n          # If the atom doesn't exist or other error\n          ''\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "build_hints_js", "signature": "def build_hints_js(uses_visibility, styles, position)", "start_line": 59, "end_line": 99}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 136}
{"function_name": "drag_to", "file_path": "capybara/lib/capybara/selenium/extensions/html5_drag.rb", "focal_code": "def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])\n      drop_modifiers = Array(drop_modifiers)\n\n      driver.execute_script MOUSEDOWN_TRACKER\n      scroll_if_needed { browser_action.click_and_hold(native).perform }\n      html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?\n      if html5\n        perform_html5_drag(element, delay, drop_modifiers)\n      else\n        perform_legacy_drag(element, drop_modifiers)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::Selenium::Node\n  module Html5Drag\n    # Implement methods to emulate HTML5 drag and drop\n\n    def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])\n      drop_modifiers = Array(drop_modifiers)\n\n      driver.execute_script MOUSEDOWN_TRACKER\n      scroll_if_needed { browser_action.click_and_hold(native).perform }\n      html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?\n      if html5\n        perform_html5_drag(element, delay, drop_modifiers)\n      else\n        perform_legacy_drag(element, drop_modifiers)\n      end\n    end\n\n  private\n\n    def perform_legacy_drag(element, drop_modifiers)\n      element.scroll_if_needed do\n        # browser_action.move_to(element.native).release.perform\n        keys_down = modifiers_down(browser_action, drop_modifiers)\n        keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n        keys_up.perform\n      end\n    end\n\n    def perform_html5_drag(element, delay, drop_modifiers)\n      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000, normalize_keys(drop_modifiers)\n      browser_action.release.perform\n    end\n\n    def html5_drop(*args)\n      if args[0].is_a? String\n        input = driver.evaluate_script ATTACH_FILE\n        input.set_file(args)\n        driver.execute_script DROP_FILE, self, input\n      else\n        items = args.flat_map do |arg|\n          arg.map { |(type, data)| { type: type, data: data } }\n        end\n        driver.execute_script DROP_STRING, items, self\n      end\n    end\n\n    DROP_STRING = <<~JS\n      var strings = arguments[0],\n          el = arguments[1],\n          dt = new DataTransfer(),\n          opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n      for (var i=0; i < strings.length; i++){\n        if (dt.items) {\n          dt.items.add(strings[i]['data'], strings[i]['type']);\n        } else {\n          dt.setData(strings[i]['type'], strings[i]['data']);\n        }\n      }\n      var dropEvent = new DragEvent('drop', opts);\n      el.dispatchEvent(dropEvent);\n    JS\n\n    DROP_FILE = <<~JS\n      var el = arguments[0],\n          input = arguments[1],\n          files = input.files,\n          dt = new DataTransfer(),\n          opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n      input.parentElement.removeChild(input);\n      if (dt.items){\n        for (var i=0; i<files.length; i++){\n          dt.items.add(files[i]);\n        }\n      } else {\n        Object.defineProperty(dt, \"files\", {\n          value: files,\n          writable: false\n        });\n      }\n      var dropEvent = new DragEvent('drop', opts);\n      el.dispatchEvent(dropEvent);\n    JS\n\n    ATTACH_FILE = <<~JS\n      (function(){\n        var input = document.createElement('INPUT');\n        input.type = \"file\";\n        input.id = \"_capybara_drop_file\";\n        input.multiple = true;\n        document.body.appendChild(input);\n        return input;\n      })()\n    JS\n\n    MOUSEDOWN_TRACKER = <<~JS\n      window.capybara_mousedown_prevented = null;\n      document.addEventListener('mousedown', ev => {\n        window.capybara_mousedown_prevented = ev.defaultPrevented;\n      }, { once: true, passive: true })\n    JS\n\n    LEGACY_DRAG_CHECK = <<~JS\n      (function(el){\n        if ([true, null].indexOf(window.capybara_mousedown_prevented) >= 0){\n          return true;\n        }\n\n        do {\n          if (el.draggable) return false;\n        } while (el = el.parentElement );\n        return true;\n      })(arguments[0])\n    JS\n\n    HTML5_DRAG_DROP_SCRIPT = <<~JS\n      function rectCenter(rect){\n        return new DOMPoint(\n          (rect.left + rect.right)/2,\n          (rect.top + rect.bottom)/2\n        );\n      }\n\n      function pointOnRect(pt, rect) {\n      \tvar rectPt = rectCenter(rect);\n      \tvar slope = (rectPt.y - pt.y) / (rectPt.x - pt.x);\n\n      \tif (pt.x <= rectPt.x) { // left side\n      \t\tvar minXy = slope * (rect.left - pt.x) + pt.y;\n      \t\tif (rect.top <= minXy && minXy <= rect.bottom)\n            return new DOMPoint(rect.left, minXy);\n      \t}\n\n      \tif (pt.x >= rectPt.x) { // right side\n      \t\tvar maxXy = slope * (rect.right - pt.x) + pt.y;\n      \t\tif (rect.top <= maxXy && maxXy <= rect.bottom)\n            return new DOMPoint(rect.right, maxXy);\n      \t}\n\n      \tif (pt.y <= rectPt.y) { // top side\n      \t\tvar minYx = (rectPt.top - pt.y) / slope + pt.x;\n      \t\tif (rect.left <= minYx && minYx <= rect.right)\n            return new DOMPoint(minYx, rect.top);\n      \t}\n\n      \tif (pt.y >= rectPt.y) { // bottom side\n      \t\tvar maxYx = (rect.bottom - pt.y) / slope + pt.x;\n      \t\tif (rect.left <= maxYx && maxYx <= rect.right)\n            return new DOMPoint(maxYx, rect.bottom);\n      \t}\n\n        return new DOMPoint(pt.x,pt.y);\n      }\n\n      function dragEnterTarget() {\n        target.scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n        var targetRect = target.getBoundingClientRect();\n        var sourceCenter = rectCenter(source.getBoundingClientRect());\n\n        for (var i = 0; i < drop_modifier_keys.length; i++) {\n          key = drop_modifier_keys[i];\n          if (key == \"control\"){\n            key = \"ctrl\"\n          }\n          opts[key + 'Key'] = true;\n        }\n\n        var dragEnterEvent = new DragEvent('dragenter', opts);\n        target.dispatchEvent(dragEnterEvent);\n\n        // fire 2 dragover events to simulate dragging with a direction\n        var entryPoint = pointOnRect(sourceCenter, targetRect)\n        var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);\n        var dragOverEvent = new DragEvent('dragover', dragOverOpts);\n        target.dispatchEvent(dragOverEvent);\n        window.setTimeout(dragOnTarget, step_delay);\n      }\n\n      function dragOnTarget() {\n        var targetCenter = rectCenter(target.getBoundingClientRect());\n        var dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);\n        var dragOverEvent = new DragEvent('dragover', dragOverOpts);\n        target.dispatchEvent(dragOverEvent);\n        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented, dragOverOpts);\n      }\n\n      function dragLeave(drop, dragOverOpts) {\n        var dragLeaveOptions = Object.assign({}, opts, dragOverOpts);\n        var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);\n        target.dispatchEvent(dragLeaveEvent);\n        if (drop) {\n          var dropEvent = new DragEvent('drop', dragLeaveOptions);\n          target.dispatchEvent(dropEvent);\n        }\n        var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);\n        source.dispatchEvent(dragEndEvent);\n        callback.call(true);\n      }\n\n      var source = arguments[0],\n          target = arguments[1],\n          step_delay = arguments[2],\n          drop_modifier_keys = arguments[3],\n          callback = arguments[4];\n\n      var dt = new DataTransfer();\n      var opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n\n      while (source && !source.draggable) {\n        source = source.parentElement;\n      }\n\n      if (source.tagName == 'A'){\n        dt.setData('text/uri-list', source.href);\n        dt.setData('text', source.href);\n      }\n      if (source.tagName == 'IMG'){\n        dt.setData('text/uri-list', source.src);\n        dt.setData('text', source.src);\n      }\n\n      var dragEvent = new DragEvent('dragstart', opts);\n      source.dispatchEvent(dragEvent);\n\n      window.setTimeout(dragEnterTarget, step_delay);\n    JS\n  end\nend\n", "language": "Ruby", "function_component": {"name": "drag_to", "signature": "def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])", "start_line": 7, "end_line": 18}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node"}, "task_id": 137}
{"function_name": "html5_drop", "file_path": "capybara/lib/capybara/selenium/extensions/html5_drag.rb", "focal_code": "def html5_drop(*args)\n      if args[0].is_a? String\n        input = driver.evaluate_script ATTACH_FILE\n        input.set_file(args)\n        driver.execute_script DROP_FILE, self, input\n      else\n        items = args.flat_map do |arg|\n          arg.map { |(type, data)| { type: type, data: data } }\n        end\n        driver.execute_script DROP_STRING, items, self\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nclass Capybara::Selenium::Node\n  module Html5Drag\n    # Implement methods to emulate HTML5 drag and drop\n\n    def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])\n      drop_modifiers = Array(drop_modifiers)\n\n      driver.execute_script MOUSEDOWN_TRACKER\n      scroll_if_needed { browser_action.click_and_hold(native).perform }\n      html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?\n      if html5\n        perform_html5_drag(element, delay, drop_modifiers)\n      else\n        perform_legacy_drag(element, drop_modifiers)\n      end\n    end\n\n  private\n\n    def perform_legacy_drag(element, drop_modifiers)\n      element.scroll_if_needed do\n        # browser_action.move_to(element.native).release.perform\n        keys_down = modifiers_down(browser_action, drop_modifiers)\n        keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)\n        keys_up.perform\n      end\n    end\n\n    def perform_html5_drag(element, delay, drop_modifiers)\n      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000, normalize_keys(drop_modifiers)\n      browser_action.release.perform\n    end\n\n    def html5_drop(*args)\n      if args[0].is_a? String\n        input = driver.evaluate_script ATTACH_FILE\n        input.set_file(args)\n        driver.execute_script DROP_FILE, self, input\n      else\n        items = args.flat_map do |arg|\n          arg.map { |(type, data)| { type: type, data: data } }\n        end\n        driver.execute_script DROP_STRING, items, self\n      end\n    end\n\n    DROP_STRING = <<~JS\n      var strings = arguments[0],\n          el = arguments[1],\n          dt = new DataTransfer(),\n          opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n      for (var i=0; i < strings.length; i++){\n        if (dt.items) {\n          dt.items.add(strings[i]['data'], strings[i]['type']);\n        } else {\n          dt.setData(strings[i]['type'], strings[i]['data']);\n        }\n      }\n      var dropEvent = new DragEvent('drop', opts);\n      el.dispatchEvent(dropEvent);\n    JS\n\n    DROP_FILE = <<~JS\n      var el = arguments[0],\n          input = arguments[1],\n          files = input.files,\n          dt = new DataTransfer(),\n          opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n      input.parentElement.removeChild(input);\n      if (dt.items){\n        for (var i=0; i<files.length; i++){\n          dt.items.add(files[i]);\n        }\n      } else {\n        Object.defineProperty(dt, \"files\", {\n          value: files,\n          writable: false\n        });\n      }\n      var dropEvent = new DragEvent('drop', opts);\n      el.dispatchEvent(dropEvent);\n    JS\n\n    ATTACH_FILE = <<~JS\n      (function(){\n        var input = document.createElement('INPUT');\n        input.type = \"file\";\n        input.id = \"_capybara_drop_file\";\n        input.multiple = true;\n        document.body.appendChild(input);\n        return input;\n      })()\n    JS\n\n    MOUSEDOWN_TRACKER = <<~JS\n      window.capybara_mousedown_prevented = null;\n      document.addEventListener('mousedown', ev => {\n        window.capybara_mousedown_prevented = ev.defaultPrevented;\n      }, { once: true, passive: true })\n    JS\n\n    LEGACY_DRAG_CHECK = <<~JS\n      (function(el){\n        if ([true, null].indexOf(window.capybara_mousedown_prevented) >= 0){\n          return true;\n        }\n\n        do {\n          if (el.draggable) return false;\n        } while (el = el.parentElement );\n        return true;\n      })(arguments[0])\n    JS\n\n    HTML5_DRAG_DROP_SCRIPT = <<~JS\n      function rectCenter(rect){\n        return new DOMPoint(\n          (rect.left + rect.right)/2,\n          (rect.top + rect.bottom)/2\n        );\n      }\n\n      function pointOnRect(pt, rect) {\n      \tvar rectPt = rectCenter(rect);\n      \tvar slope = (rectPt.y - pt.y) / (rectPt.x - pt.x);\n\n      \tif (pt.x <= rectPt.x) { // left side\n      \t\tvar minXy = slope * (rect.left - pt.x) + pt.y;\n      \t\tif (rect.top <= minXy && minXy <= rect.bottom)\n            return new DOMPoint(rect.left, minXy);\n      \t}\n\n      \tif (pt.x >= rectPt.x) { // right side\n      \t\tvar maxXy = slope * (rect.right - pt.x) + pt.y;\n      \t\tif (rect.top <= maxXy && maxXy <= rect.bottom)\n            return new DOMPoint(rect.right, maxXy);\n      \t}\n\n      \tif (pt.y <= rectPt.y) { // top side\n      \t\tvar minYx = (rectPt.top - pt.y) / slope + pt.x;\n      \t\tif (rect.left <= minYx && minYx <= rect.right)\n            return new DOMPoint(minYx, rect.top);\n      \t}\n\n      \tif (pt.y >= rectPt.y) { // bottom side\n      \t\tvar maxYx = (rect.bottom - pt.y) / slope + pt.x;\n      \t\tif (rect.left <= maxYx && maxYx <= rect.right)\n            return new DOMPoint(maxYx, rect.bottom);\n      \t}\n\n        return new DOMPoint(pt.x,pt.y);\n      }\n\n      function dragEnterTarget() {\n        target.scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});\n        var targetRect = target.getBoundingClientRect();\n        var sourceCenter = rectCenter(source.getBoundingClientRect());\n\n        for (var i = 0; i < drop_modifier_keys.length; i++) {\n          key = drop_modifier_keys[i];\n          if (key == \"control\"){\n            key = \"ctrl\"\n          }\n          opts[key + 'Key'] = true;\n        }\n\n        var dragEnterEvent = new DragEvent('dragenter', opts);\n        target.dispatchEvent(dragEnterEvent);\n\n        // fire 2 dragover events to simulate dragging with a direction\n        var entryPoint = pointOnRect(sourceCenter, targetRect)\n        var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);\n        var dragOverEvent = new DragEvent('dragover', dragOverOpts);\n        target.dispatchEvent(dragOverEvent);\n        window.setTimeout(dragOnTarget, step_delay);\n      }\n\n      function dragOnTarget() {\n        var targetCenter = rectCenter(target.getBoundingClientRect());\n        var dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);\n        var dragOverEvent = new DragEvent('dragover', dragOverOpts);\n        target.dispatchEvent(dragOverEvent);\n        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented, dragOverOpts);\n      }\n\n      function dragLeave(drop, dragOverOpts) {\n        var dragLeaveOptions = Object.assign({}, opts, dragOverOpts);\n        var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);\n        target.dispatchEvent(dragLeaveEvent);\n        if (drop) {\n          var dropEvent = new DragEvent('drop', dragLeaveOptions);\n          target.dispatchEvent(dropEvent);\n        }\n        var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);\n        source.dispatchEvent(dragEndEvent);\n        callback.call(true);\n      }\n\n      var source = arguments[0],\n          target = arguments[1],\n          step_delay = arguments[2],\n          drop_modifier_keys = arguments[3],\n          callback = arguments[4];\n\n      var dt = new DataTransfer();\n      var opts = { cancelable: true, bubbles: true, dataTransfer: dt };\n\n      while (source && !source.draggable) {\n        source = source.parentElement;\n      }\n\n      if (source.tagName == 'A'){\n        dt.setData('text/uri-list', source.href);\n        dt.setData('text', source.href);\n      }\n      if (source.tagName == 'IMG'){\n        dt.setData('text/uri-list', source.src);\n        dt.setData('text', source.src);\n      }\n\n      var dragEvent = new DragEvent('dragstart', opts);\n      source.dispatchEvent(dragEvent);\n\n      window.setTimeout(dragEnterTarget, step_delay);\n    JS\n  end\nend\n", "language": "Ruby", "function_component": {"name": "html5_drop", "signature": "def html5_drop(*args)", "start_line": 36, "end_line": 47}, "metadata": {"module": "", "class_name": "Capybara::Selenium::Node", "class_signature": "class Capybara::Selenium::Node"}, "task_id": 138}
{"function_name": "scroll_by", "file_path": "capybara/lib/capybara/selenium/extensions/scroll.rb", "focal_code": "def scroll_by(x, y)\n        driver.execute_script <<~JS, self, x, y\n          var el = arguments[0];\n          if (el.scrollBy){\n            el.scrollBy(arguments[1], arguments[2]);\n          } else {\n            el.scrollTop = el.scrollTop + arguments[2];\n            el.scrollLeft = el.scrollLeft + arguments[1];\n          }\n        JS\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Scroll\n      def scroll_by(x, y)\n        driver.execute_script <<~JS, self, x, y\n          var el = arguments[0];\n          if (el.scrollBy){\n            el.scrollBy(arguments[1], arguments[2]);\n          } else {\n            el.scrollTop = el.scrollTop + arguments[2];\n            el.scrollLeft = el.scrollLeft + arguments[1];\n          }\n        JS\n      end\n\n      def scroll_to(element, location, position = nil)\n        # location, element = element, nil if element.is_a? Symbol\n        if element.is_a? Capybara::Selenium::Node\n          scroll_element_to_location(element, location)\n        elsif location.is_a? Symbol\n          scroll_to_location(location)\n        else\n          scroll_to_coords(*position)\n        end\n        self\n      end\n\n    private\n\n      def scroll_element_to_location(element, location)\n        scroll_opts = case location\n        when :top\n          'true'\n        when :bottom\n          'false'\n        when :center\n          \"{behavior: 'instant', block: 'center'}\"\n        else\n          raise ArgumentError, \"Invalid scroll_to location: #{location}\"\n        end\n        driver.execute_script <<~JS, element\n          arguments[0].scrollIntoView(#{scroll_opts})\n        JS\n      end\n\n      SCROLL_POSITIONS = {\n        top: '0',\n        bottom: 'arguments[0].scrollHeight',\n        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'\n      }.freeze\n\n      def scroll_to_location(location)\n        driver.execute_script <<~JS, self\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});\n          } else {\n            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};\n          }\n        JS\n      end\n\n      def scroll_to_coords(x, y)\n        driver.execute_script <<~JS, self, x, y\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(arguments[1], arguments[2]);\n          } else {\n            arguments[0].scrollTop = arguments[2];\n            arguments[0].scrollLeft = arguments[1];\n          }\n        JS\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "scroll_by", "signature": "def scroll_by(x, y)", "start_line": 6, "end_line": 16}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 139}
{"function_name": "scroll_to", "file_path": "capybara/lib/capybara/selenium/extensions/scroll.rb", "focal_code": "def scroll_to(element, location, position = nil)\n        # location, element = element, nil if element.is_a? Symbol\n        if element.is_a? Capybara::Selenium::Node\n          scroll_element_to_location(element, location)\n        elsif location.is_a? Symbol\n          scroll_to_location(location)\n        else\n          scroll_to_coords(*position)\n        end\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Scroll\n      def scroll_by(x, y)\n        driver.execute_script <<~JS, self, x, y\n          var el = arguments[0];\n          if (el.scrollBy){\n            el.scrollBy(arguments[1], arguments[2]);\n          } else {\n            el.scrollTop = el.scrollTop + arguments[2];\n            el.scrollLeft = el.scrollLeft + arguments[1];\n          }\n        JS\n      end\n\n      def scroll_to(element, location, position = nil)\n        # location, element = element, nil if element.is_a? Symbol\n        if element.is_a? Capybara::Selenium::Node\n          scroll_element_to_location(element, location)\n        elsif location.is_a? Symbol\n          scroll_to_location(location)\n        else\n          scroll_to_coords(*position)\n        end\n        self\n      end\n\n    private\n\n      def scroll_element_to_location(element, location)\n        scroll_opts = case location\n        when :top\n          'true'\n        when :bottom\n          'false'\n        when :center\n          \"{behavior: 'instant', block: 'center'}\"\n        else\n          raise ArgumentError, \"Invalid scroll_to location: #{location}\"\n        end\n        driver.execute_script <<~JS, element\n          arguments[0].scrollIntoView(#{scroll_opts})\n        JS\n      end\n\n      SCROLL_POSITIONS = {\n        top: '0',\n        bottom: 'arguments[0].scrollHeight',\n        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'\n      }.freeze\n\n      def scroll_to_location(location)\n        driver.execute_script <<~JS, self\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});\n          } else {\n            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};\n          }\n        JS\n      end\n\n      def scroll_to_coords(x, y)\n        driver.execute_script <<~JS, self, x, y\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(arguments[1], arguments[2]);\n          } else {\n            arguments[0].scrollTop = arguments[2];\n            arguments[0].scrollLeft = arguments[1];\n          }\n        JS\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "scroll_to", "signature": "def scroll_to(element, location, position = nil)", "start_line": 18, "end_line": 28}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 140}
{"function_name": "scroll_element_to_location", "file_path": "capybara/lib/capybara/selenium/extensions/scroll.rb", "focal_code": "def scroll_element_to_location(element, location)\n        scroll_opts = case location\n        when :top\n          'true'\n        when :bottom\n          'false'\n        when :center\n          \"{behavior: 'instant', block: 'center'}\"\n        else\n          raise ArgumentError, \"Invalid scroll_to location: #{location}\"\n        end\n        driver.execute_script <<~JS, element\n          arguments[0].scrollIntoView(#{scroll_opts})\n        JS\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Scroll\n      def scroll_by(x, y)\n        driver.execute_script <<~JS, self, x, y\n          var el = arguments[0];\n          if (el.scrollBy){\n            el.scrollBy(arguments[1], arguments[2]);\n          } else {\n            el.scrollTop = el.scrollTop + arguments[2];\n            el.scrollLeft = el.scrollLeft + arguments[1];\n          }\n        JS\n      end\n\n      def scroll_to(element, location, position = nil)\n        # location, element = element, nil if element.is_a? Symbol\n        if element.is_a? Capybara::Selenium::Node\n          scroll_element_to_location(element, location)\n        elsif location.is_a? Symbol\n          scroll_to_location(location)\n        else\n          scroll_to_coords(*position)\n        end\n        self\n      end\n\n    private\n\n      def scroll_element_to_location(element, location)\n        scroll_opts = case location\n        when :top\n          'true'\n        when :bottom\n          'false'\n        when :center\n          \"{behavior: 'instant', block: 'center'}\"\n        else\n          raise ArgumentError, \"Invalid scroll_to location: #{location}\"\n        end\n        driver.execute_script <<~JS, element\n          arguments[0].scrollIntoView(#{scroll_opts})\n        JS\n      end\n\n      SCROLL_POSITIONS = {\n        top: '0',\n        bottom: 'arguments[0].scrollHeight',\n        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'\n      }.freeze\n\n      def scroll_to_location(location)\n        driver.execute_script <<~JS, self\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});\n          } else {\n            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};\n          }\n        JS\n      end\n\n      def scroll_to_coords(x, y)\n        driver.execute_script <<~JS, self, x, y\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(arguments[1], arguments[2]);\n          } else {\n            arguments[0].scrollTop = arguments[2];\n            arguments[0].scrollLeft = arguments[1];\n          }\n        JS\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "scroll_element_to_location", "signature": "def scroll_element_to_location(element, location)", "start_line": 32, "end_line": 46}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 141}
{"function_name": "scroll_to_coords", "file_path": "capybara/lib/capybara/selenium/extensions/scroll.rb", "focal_code": "def scroll_to_coords(x, y)\n        driver.execute_script <<~JS, self, x, y\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(arguments[1], arguments[2]);\n          } else {\n            arguments[0].scrollTop = arguments[2];\n            arguments[0].scrollLeft = arguments[1];\n          }\n        JS\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module Scroll\n      def scroll_by(x, y)\n        driver.execute_script <<~JS, self, x, y\n          var el = arguments[0];\n          if (el.scrollBy){\n            el.scrollBy(arguments[1], arguments[2]);\n          } else {\n            el.scrollTop = el.scrollTop + arguments[2];\n            el.scrollLeft = el.scrollLeft + arguments[1];\n          }\n        JS\n      end\n\n      def scroll_to(element, location, position = nil)\n        # location, element = element, nil if element.is_a? Symbol\n        if element.is_a? Capybara::Selenium::Node\n          scroll_element_to_location(element, location)\n        elsif location.is_a? Symbol\n          scroll_to_location(location)\n        else\n          scroll_to_coords(*position)\n        end\n        self\n      end\n\n    private\n\n      def scroll_element_to_location(element, location)\n        scroll_opts = case location\n        when :top\n          'true'\n        when :bottom\n          'false'\n        when :center\n          \"{behavior: 'instant', block: 'center'}\"\n        else\n          raise ArgumentError, \"Invalid scroll_to location: #{location}\"\n        end\n        driver.execute_script <<~JS, element\n          arguments[0].scrollIntoView(#{scroll_opts})\n        JS\n      end\n\n      SCROLL_POSITIONS = {\n        top: '0',\n        bottom: 'arguments[0].scrollHeight',\n        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'\n      }.freeze\n\n      def scroll_to_location(location)\n        driver.execute_script <<~JS, self\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});\n          } else {\n            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};\n          }\n        JS\n      end\n\n      def scroll_to_coords(x, y)\n        driver.execute_script <<~JS, self, x, y\n          if (arguments[0].scrollTo){\n            arguments[0].scrollTo(arguments[1], arguments[2]);\n          } else {\n            arguments[0].scrollTop = arguments[2];\n            arguments[0].scrollLeft = arguments[1];\n          }\n        JS\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "scroll_to_coords", "signature": "def scroll_to_coords(x, y)", "start_line": 64, "end_line": 73}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 142}
{"function_name": "set_file", "file_path": "capybara/lib/capybara/selenium/nodes/chrome_node.rb", "focal_code": "def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if browser_version >= 75.0\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/file_input_click_emulation'\n\nclass Capybara::Selenium::ChromeNode < Capybara::Selenium::Node\n  include Html5Drag\n  include FileInputClickEmulation\n\n  def set_text(value, clear: nil, **_unused)\n    super.tap do\n      # React doesn't see the chromedriver element clear\n      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n    end\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if browser_version >= 75.0\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end\n\n  def drop(*args)\n    html5_drop(*args)\n  end\n\n  def click(*, **)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    # chromedriver 74 (at least on mac) raises the wrong error for this\n    if e.message.include?('element click intercepted')\n      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message\n    end\n\n    raise\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\n  def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end\n\nprotected\n\n  def catch_error?(error, errors = nil)\n    # Selenium::WebDriver::Error::UnknownError:\n    #    unknown error: unhandled inspector error: {\"code\":-32000,\"message\":\"Node with given id does not belong to the document\"}\n    super ||\n      (error.is_a?(Selenium::WebDriver::Error::UnknownError) &&\n       error.message.include?('Node with given id does not belong to the document'))\n  end\n\nprivate\n\n  def perform_legacy_drag(element, drop_modifiers)\n    return super if chromedriver_fixed_actions_key_state? || element.obscured?\n\n    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?\n\n    # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs\n    # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981\n    browser_action.release.perform\n    browser_action.click_and_hold(native).move_to(element.native).release.perform\n  end\n\n  def browser_version(to_float: true)\n    caps = capabilities\n    ver = caps[:browser_version] || caps[:version]\n    ver = ver.to_f if to_float\n    ver\n  end\n\n  def chromedriver_fixed_actions_key_state?\n    Gem::Requirement.new('>= 76.0.3809.68').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_supports_displayed_endpoint?\n    Gem::Requirement.new('>= 76.0.3809.25').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_version\n    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument\n  end\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) &&\n      chromedriver_supports_displayed_endpoint? &&\n      !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\nend\n", "language": "Ruby", "function_component": {"name": "set_file", "signature": "def set_file(value) # rubocop:disable Naming/AccessorMethodName", "start_line": 17, "end_line": 27}, "metadata": {"module": "", "class_name": "Capybara::Selenium::ChromeNode", "class_signature": "class Capybara::Selenium::ChromeNode < < Capybara::Selenium::Node"}, "task_id": 143}
{"function_name": "click", "file_path": "capybara/lib/capybara/selenium/nodes/chrome_node.rb", "focal_code": "def click(*, **)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    # chromedriver 74 (at least on mac) raises the wrong error for this\n    if e.message.include?('element click intercepted')\n      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message\n    end\n\n    raise\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/file_input_click_emulation'\n\nclass Capybara::Selenium::ChromeNode < Capybara::Selenium::Node\n  include Html5Drag\n  include FileInputClickEmulation\n\n  def set_text(value, clear: nil, **_unused)\n    super.tap do\n      # React doesn't see the chromedriver element clear\n      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n    end\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if browser_version >= 75.0\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end\n\n  def drop(*args)\n    html5_drop(*args)\n  end\n\n  def click(*, **)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    # chromedriver 74 (at least on mac) raises the wrong error for this\n    if e.message.include?('element click intercepted')\n      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message\n    end\n\n    raise\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\n  def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end\n\nprotected\n\n  def catch_error?(error, errors = nil)\n    # Selenium::WebDriver::Error::UnknownError:\n    #    unknown error: unhandled inspector error: {\"code\":-32000,\"message\":\"Node with given id does not belong to the document\"}\n    super ||\n      (error.is_a?(Selenium::WebDriver::Error::UnknownError) &&\n       error.message.include?('Node with given id does not belong to the document'))\n  end\n\nprivate\n\n  def perform_legacy_drag(element, drop_modifiers)\n    return super if chromedriver_fixed_actions_key_state? || element.obscured?\n\n    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?\n\n    # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs\n    # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981\n    browser_action.release.perform\n    browser_action.click_and_hold(native).move_to(element.native).release.perform\n  end\n\n  def browser_version(to_float: true)\n    caps = capabilities\n    ver = caps[:browser_version] || caps[:version]\n    ver = ver.to_f if to_float\n    ver\n  end\n\n  def chromedriver_fixed_actions_key_state?\n    Gem::Requirement.new('>= 76.0.3809.68').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_supports_displayed_endpoint?\n    Gem::Requirement.new('>= 76.0.3809.25').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_version\n    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument\n  end\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) &&\n      chromedriver_supports_displayed_endpoint? &&\n      !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\nend\n", "language": "Ruby", "function_component": {"name": "click", "signature": "def click(*, **)", "start_line": 33, "end_line": 44}, "metadata": {"module": "", "class_name": "Capybara::Selenium::ChromeNode", "class_signature": "class Capybara::Selenium::ChromeNode < < Capybara::Selenium::Node"}, "task_id": 144}
{"function_name": "send_keys", "file_path": "capybara/lib/capybara/selenium/nodes/chrome_node.rb", "focal_code": "def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/file_input_click_emulation'\n\nclass Capybara::Selenium::ChromeNode < Capybara::Selenium::Node\n  include Html5Drag\n  include FileInputClickEmulation\n\n  def set_text(value, clear: nil, **_unused)\n    super.tap do\n      # React doesn't see the chromedriver element clear\n      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n    end\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if browser_version >= 75.0\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end\n\n  def drop(*args)\n    html5_drop(*args)\n  end\n\n  def click(*, **)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    # chromedriver 74 (at least on mac) raises the wrong error for this\n    if e.message.include?('element click intercepted')\n      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message\n    end\n\n    raise\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\n  def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end\n\nprotected\n\n  def catch_error?(error, errors = nil)\n    # Selenium::WebDriver::Error::UnknownError:\n    #    unknown error: unhandled inspector error: {\"code\":-32000,\"message\":\"Node with given id does not belong to the document\"}\n    super ||\n      (error.is_a?(Selenium::WebDriver::Error::UnknownError) &&\n       error.message.include?('Node with given id does not belong to the document'))\n  end\n\nprivate\n\n  def perform_legacy_drag(element, drop_modifiers)\n    return super if chromedriver_fixed_actions_key_state? || element.obscured?\n\n    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?\n\n    # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs\n    # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981\n    browser_action.release.perform\n    browser_action.click_and_hold(native).move_to(element.native).release.perform\n  end\n\n  def browser_version(to_float: true)\n    caps = capabilities\n    ver = caps[:browser_version] || caps[:version]\n    ver = ver.to_f if to_float\n    ver\n  end\n\n  def chromedriver_fixed_actions_key_state?\n    Gem::Requirement.new('>= 76.0.3809.68').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_supports_displayed_endpoint?\n    Gem::Requirement.new('>= 76.0.3809.25').satisfied_by?(chromedriver_version)\n  end\n\n  def chromedriver_version\n    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument\n  end\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) &&\n      chromedriver_supports_displayed_endpoint? &&\n      !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\nend\n", "language": "Ruby", "function_component": {"name": "send_keys", "signature": "def send_keys(*args)", "start_line": 70, "end_line": 86}, "metadata": {"module": "", "class_name": "Capybara::Selenium::ChromeNode", "class_signature": "class Capybara::Selenium::ChromeNode < < Capybara::Selenium::Node"}, "task_id": 145}
{"function_name": "set_file", "file_path": "capybara/lib/capybara/selenium/nodes/edge_node.rb", "focal_code": "def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if chrome_edge?\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\n\nclass Capybara::Selenium::EdgeNode < Capybara::Selenium::Node\n  include Html5Drag\n\n  def set_text(value, clear: nil, **_unused)\n    return super unless chrome_edge?\n\n    super.tap do\n      # React doesn't see the chromedriver element clear\n      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n    end\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if chrome_edge?\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end\n\n  def drop(*args)\n    return super unless chrome_edge?\n\n    html5_drop(*args)\n  end\n\n  def click(*, **)\n    super\n  rescue Selenium::WebDriver::Error::InvalidArgumentError => e\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    if tag_name == 'input' && type == 'file'\n      raise Selenium::WebDriver::Error::InvalidArgumentError, \"EdgeChrome can't click on file inputs.\\n#{e.message}\"\n    end\n\n    raise\n  end\n\n  def disabled?\n    return super unless chrome_edge?\n\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def select_option\n    return super unless chrome_edge?\n\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless chrome_edge? && native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\n  def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end\n\nprivate\n\n  def browser_version\n    @browser_version ||= begin\n      caps = driver.browser.capabilities\n      (caps[:browser_version] || caps[:version]).to_f\n    end\n  end\n\n  def chrome_edge?\n    browser_version >= 75\n  end\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) &&\n      # chromedriver_supports_displayed_endpoint? &&\n      !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\nend\n", "language": "Ruby", "function_component": {"name": "set_file", "signature": "def set_file(value) # rubocop:disable Naming/AccessorMethodName", "start_line": 17, "end_line": 27}, "metadata": {"module": "", "class_name": "Capybara::Selenium::EdgeNode", "class_signature": "class Capybara::Selenium::EdgeNode < < Capybara::Selenium::Node"}, "task_id": 146}
{"function_name": "send_keys", "file_path": "capybara/lib/capybara/selenium/nodes/edge_node.rb", "focal_code": "def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\n\nclass Capybara::Selenium::EdgeNode < Capybara::Selenium::Node\n  include Html5Drag\n\n  def set_text(value, clear: nil, **_unused)\n    return super unless chrome_edge?\n\n    super.tap do\n      # React doesn't see the chromedriver element clear\n      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n    end\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set\n    if chrome_edge?\n      driver.execute_script(<<~JS, self)\n        if (arguments[0].multiple && arguments[0].files.length){\n          arguments[0].value = null;\n        }\n      JS\n    end\n    super\n  end\n\n  def drop(*args)\n    return super unless chrome_edge?\n\n    html5_drop(*args)\n  end\n\n  def click(*, **)\n    super\n  rescue Selenium::WebDriver::Error::InvalidArgumentError => e\n    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }\n    if tag_name == 'input' && type == 'file'\n      raise Selenium::WebDriver::Error::InvalidArgumentError, \"EdgeChrome can't click on file inputs.\\n#{e.message}\"\n    end\n\n    raise\n  end\n\n  def disabled?\n    return super unless chrome_edge?\n\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def select_option\n    return super unless chrome_edge?\n\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless chrome_edge? && native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\n  def send_keys(*args)\n    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\\p{Emoji Presentation}/) }\n        .each do |contains_emoji, inputs|\n      if contains_emoji\n        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\\p{Emoji Presentation}/) }\n              .each do |emoji, clusters|\n          if emoji\n            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)\n          else\n            super(clusters.join)\n          end\n        end\n      else\n        super(*inputs)\n      end\n    end\n  end\n\nprivate\n\n  def browser_version\n    @browser_version ||= begin\n      caps = driver.browser.capabilities\n      (caps[:browser_version] || caps[:version]).to_f\n    end\n  end\n\n  def chrome_edge?\n    browser_version >= 75\n  end\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) &&\n      # chromedriver_supports_displayed_endpoint? &&\n      !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\nend\n", "language": "Ruby", "function_component": {"name": "send_keys", "signature": "def send_keys(*args)", "start_line": 74, "end_line": 90}, "metadata": {"module": "", "class_name": "Capybara::Selenium::EdgeNode", "class_signature": "class Capybara::Selenium::EdgeNode < < Capybara::Selenium::Node"}, "task_id": 147}
{"function_name": "click", "file_path": "capybara/lib/capybara/selenium/nodes/firefox_node.rb", "focal_code": "def click(keys = [], **options)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - ' \\\n           'see https://github.com/mozilla/geckodriver/issues/1228 - Your test should probably be ' \\\n           'clicking on a table cell like a user would. Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/file_input_click_emulation'\n\nclass Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node\n  include Html5Drag\n  include FileInputClickEmulation\n\n  def click(keys = [], **options)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - ' \\\n           'see https://github.com/mozilla/geckodriver/issues/1228 - Your test should probably be ' \\\n           'clicking on a table cell like a user would. Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # By default files are appended so we have to clear here if its multiple and already set\n    driver.execute_script(<<~JS, self)\n      if (arguments[0].multiple && arguments[0].files.length){\n        arguments[0].value = null;\n      }\n    JS\n    return super if browser_version >= 62.0\n\n    # Workaround lack of support for multiple upload by uploading one at a time\n    path_names = value.to_s.empty? ? [] : Array(value)\n    if (fd = bridge.file_detector) && !driver.browser.respond_to?(:upload)\n      path_names.map! { |path| upload(fd.call([path])) || path }\n    end\n    path_names.each { |path| native.send_keys(path) }\n  end\n\n  def focused?\n    driver.evaluate_script('arguments[0] == document.activeElement', self)\n  end\n\n  def send_keys(*args)\n    # https://github.com/mozilla/geckodriver/issues/846\n    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)\n\n    native.click unless focused?\n\n    _send_keys(args).perform\n  end\n\n  def drop(*args)\n    html5_drop(*args)\n  end\n\n  def hover\n    return super unless browser_version >= 65.0\n\n    # work around issue 2156 - https://github.com/teamcapybara/capybara/issues/2156\n    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\nprivate\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\n\n  def perform_with_options(click_options)\n    # Firefox/marionette has an issue clicking with offset near viewport edge\n    # scroll element to middle just in case\n    scroll_to_center if click_options.coords?\n    super\n  end\n\n  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)\n    case keys\n    when :control, :left_control, :right_control,\n         :alt, :left_alt, :right_alt,\n         :shift, :left_shift, :right_shift,\n         :meta, :left_meta, :right_meta,\n         :command\n      down_keys.press(keys)\n      actions.key_down(keys)\n    when String\n      # https://bugzilla.mozilla.org/show_bug.cgi?id=1405370\n      keys = keys.upcase if (browser_version < 64.0) && down_keys&.include?(:shift)\n      actions.send_keys(keys)\n    when Symbol\n      actions.send_keys(keys)\n    when Array\n      down_keys.push\n      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }\n      down_keys.pop.reverse_each { |key| actions.key_up(key) }\n    else\n      raise ArgumentError, 'Unknown keys type'\n    end\n    actions\n  end\n\n  def upload(local_file)\n    return nil unless local_file\n    raise ArgumentError, \"You may only upload files: #{local_file.inspect}\" unless File.file?(local_file)\n\n    file = ::Selenium::WebDriver::Zipper.zip_file(local_file)\n    bridge.http.call(:post, \"session/#{bridge.session_id}/file\", file: file)['value']\n  end\n\n  def browser_version\n    driver.browser.capabilities[:browser_version].to_f\n  end\nend\n", "language": "Ruby", "function_component": {"name": "click", "signature": "def click(keys = [], **options)", "start_line": 10, "end_line": 20}, "metadata": {"module": "", "class_name": "Capybara::Selenium::FirefoxNode", "class_signature": "class Capybara::Selenium::FirefoxNode < < Capybara::Selenium::Node"}, "task_id": 148}
{"function_name": "set_file", "file_path": "capybara/lib/capybara/selenium/nodes/firefox_node.rb", "focal_code": "def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # By default files are appended so we have to clear here if its multiple and already set\n    driver.execute_script(<<~JS, self)\n      if (arguments[0].multiple && arguments[0].files.length){\n        arguments[0].value = null;\n      }\n    JS\n    return super if browser_version >= 62.0\n\n    # Workaround lack of support for multiple upload by uploading one at a time\n    path_names = value.to_s.empty? ? [] : Array(value)\n    if (fd = bridge.file_detector) && !driver.browser.respond_to?(:upload)\n      path_names.map! { |path| upload(fd.call([path])) || path }\n    end\n    path_names.each { |path| native.send_keys(path) }\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/file_input_click_emulation'\n\nclass Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node\n  include Html5Drag\n  include FileInputClickEmulation\n\n  def click(keys = [], **options)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - ' \\\n           'see https://github.com/mozilla/geckodriver/issues/1228 - Your test should probably be ' \\\n           'clicking on a table cell like a user would. Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # By default files are appended so we have to clear here if its multiple and already set\n    driver.execute_script(<<~JS, self)\n      if (arguments[0].multiple && arguments[0].files.length){\n        arguments[0].value = null;\n      }\n    JS\n    return super if browser_version >= 62.0\n\n    # Workaround lack of support for multiple upload by uploading one at a time\n    path_names = value.to_s.empty? ? [] : Array(value)\n    if (fd = bridge.file_detector) && !driver.browser.respond_to?(:upload)\n      path_names.map! { |path| upload(fd.call([path])) || path }\n    end\n    path_names.each { |path| native.send_keys(path) }\n  end\n\n  def focused?\n    driver.evaluate_script('arguments[0] == document.activeElement', self)\n  end\n\n  def send_keys(*args)\n    # https://github.com/mozilla/geckodriver/issues/846\n    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)\n\n    native.click unless focused?\n\n    _send_keys(args).perform\n  end\n\n  def drop(*args)\n    html5_drop(*args)\n  end\n\n  def hover\n    return super unless browser_version >= 65.0\n\n    # work around issue 2156 - https://github.com/teamcapybara/capybara/issues/2156\n    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.evaluate_script(<<~JS, self)\n      arguments[0].matches(':disabled, select:disabled *, :checked')\n    JS\n    click unless selected_or_disabled\n  end\n\n  def visible?\n    return super unless native_displayed?\n\n    begin\n      bridge.send(:execute, :is_element_displayed, id: native_id)\n    rescue Selenium::WebDriver::Error::UnknownCommandError\n      # If the is_element_displayed command is unknown, no point in trying again\n      driver.options[:native_displayed] = false\n      super\n    end\n  end\n\nprivate\n\n  def native_displayed?\n    (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n  end\n\n  def perform_with_options(click_options)\n    # Firefox/marionette has an issue clicking with offset near viewport edge\n    # scroll element to middle just in case\n    scroll_to_center if click_options.coords?\n    super\n  end\n\n  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)\n    case keys\n    when :control, :left_control, :right_control,\n         :alt, :left_alt, :right_alt,\n         :shift, :left_shift, :right_shift,\n         :meta, :left_meta, :right_meta,\n         :command\n      down_keys.press(keys)\n      actions.key_down(keys)\n    when String\n      # https://bugzilla.mozilla.org/show_bug.cgi?id=1405370\n      keys = keys.upcase if (browser_version < 64.0) && down_keys&.include?(:shift)\n      actions.send_keys(keys)\n    when Symbol\n      actions.send_keys(keys)\n    when Array\n      down_keys.push\n      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }\n      down_keys.pop.reverse_each { |key| actions.key_up(key) }\n    else\n      raise ArgumentError, 'Unknown keys type'\n    end\n    actions\n  end\n\n  def upload(local_file)\n    return nil unless local_file\n    raise ArgumentError, \"You may only upload files: #{local_file.inspect}\" unless File.file?(local_file)\n\n    file = ::Selenium::WebDriver::Zipper.zip_file(local_file)\n    bridge.http.call(:post, \"session/#{bridge.session_id}/file\", file: file)['value']\n  end\n\n  def browser_version\n    driver.browser.capabilities[:browser_version].to_f\n  end\nend\n", "language": "Ruby", "function_component": {"name": "set_file", "signature": "def set_file(value) # rubocop:disable Naming/AccessorMethodName", "start_line": 26, "end_line": 41}, "metadata": {"module": "", "class_name": "Capybara::Selenium::FirefoxNode", "class_signature": "class Capybara::Selenium::FirefoxNode < < Capybara::Selenium::Node"}, "task_id": 149}
{"function_name": "disabled?", "file_path": "capybara/lib/capybara/selenium/nodes/ie_node.rb", "focal_code": "def disabled?\n    # super\n    # optimize to one script call\n    driver.evaluate_script <<~JS.delete(\"\\n\"), self\n      arguments[0].msMatchesSelector('\n        :disabled,\n        select:disabled *,\n        optgroup:disabled *,\n        fieldset[disabled],\n        fieldset[disabled] > *:not(legend),\n        fieldset[disabled] > *:not(legend) *,\n        fieldset[disabled] > legend:nth-of-type(n+2),\n        fieldset[disabled] > legend:nth-of-type(n+2) *\n      ')\n    JS\n  end", "file_content": "# frozen_string_literal: true\n\nrequire 'capybara/selenium/extensions/html5_drag'\n\nclass Capybara::Selenium::IENode < Capybara::Selenium::Node\n  def disabled?\n    # super\n    # optimize to one script call\n    driver.evaluate_script <<~JS.delete(\"\\n\"), self\n      arguments[0].msMatchesSelector('\n        :disabled,\n        select:disabled *,\n        optgroup:disabled *,\n        fieldset[disabled],\n        fieldset[disabled] > *:not(legend),\n        fieldset[disabled] > *:not(legend) *,\n        fieldset[disabled] > legend:nth-of-type(n+2),\n        fieldset[disabled] > legend:nth-of-type(n+2) *\n      ')\n    JS\n  end\nend\n", "language": "Ruby", "function_component": {"name": "disabled?", "signature": "def disabled? # super", "start_line": 6, "end_line": 21}, "metadata": {"module": "", "class_name": "Capybara::Selenium::IENode", "class_signature": "class Capybara::Selenium::IENode < < Capybara::Selenium::Node"}, "task_id": 150}
{"function_name": "click", "file_path": "capybara/lib/capybara/selenium/nodes/safari_node.rb", "focal_code": "def click(keys = [], **options)\n    # driver.execute_script('arguments[0].scrollIntoViewIfNeeded({block: \"center\"})', self)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in safaridriver - ' \\\n           'Your test should probably be clicking on a table cell like a user would. ' \\\n           'Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    raise unless e.instance_of? ::Selenium::WebDriver::Error::WebDriverError\n\n    # Safari doesn't return a specific error here - assume it's an ElementNotInteractableError\n    raise ::Selenium::WebDriver::Error::ElementNotInteractableError,\n          'Non distinct error raised in #click, translated to ElementNotInteractableError for retry'\n  end", "file_content": "# frozen_string_literal: true\n\n# require 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/modifier_keys_stack'\n\nclass Capybara::Selenium::SafariNode < Capybara::Selenium::Node\n  # include Html5Drag\n\n  def click(keys = [], **options)\n    # driver.execute_script('arguments[0].scrollIntoViewIfNeeded({block: \"center\"})', self)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in safaridriver - ' \\\n           'Your test should probably be clicking on a table cell like a user would. ' \\\n           'Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    raise unless e.instance_of? ::Selenium::WebDriver::Error::WebDriverError\n\n    # Safari doesn't return a specific error here - assume it's an ElementNotInteractableError\n    raise ::Selenium::WebDriver::Error::ElementNotInteractableError,\n          'Non distinct error raised in #click, translated to ElementNotInteractableError for retry'\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.execute_script(<<~JS, self)\n      arguments[0].closest('select').scrollIntoView();\n      return arguments[0].matches(':disabled, select:disabled *, :checked');\n    JS\n    click unless selected_or_disabled\n  end\n\n  def unselect_option\n    driver.execute_script(\"arguments[0].closest('select').scrollIntoView()\", self)\n    super\n  end\n\n  def visible_text\n    return '' unless visible?\n\n    vis_text = driver.execute_script('return arguments[0].innerText', self)\n    vis_text.squeeze(' ')\n            .gsub(/[\\ \\n]*\\n[\\ \\n]*/, \"\\n\")\n            .gsub(/\\A[[:space:]&&[^\\u00a0]]+/, '')\n            .gsub(/[[:space:]&&[^\\u00a0]]+\\z/, '')\n            .tr(\"\\u00a0\", ' ')\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # By default files are appended so we have to clear here if its multiple and already set\n    native.clear if multiple? && driver.evaluate_script('arguments[0].files', self).any?\n    super\n  end\n\n  def send_keys(*args)\n    if args.none? { |arg| arg.is_a?(Array) || (arg.is_a?(Symbol) && MODIFIER_KEYS.include?(arg)) }\n      return super(*args.map { |arg| arg == :space ? ' ' : arg })\n    end\n\n    native.click\n    _send_keys(args).perform\n  end\n\n  def set_text(value, clear: nil, **_unused)\n    value = value.to_s\n    if clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys([:control, 'e'], *backspaces, value)\n    else\n      super.tap do\n        # React doesn't see the safaridriver element clear\n        send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n      end\n    end\n  end\n\n  def hover\n    # Workaround issue where hover would sometimes fail - possibly due to mouse not having moved\n    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }\n  end\n\nprivate\n\n  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)\n    case keys\n    when *MODIFIER_KEYS\n      down_keys.press(keys)\n      actions.key_down(keys)\n    when String\n      keys = keys.upcase if down_keys&.include?(:shift)\n      actions.send_keys(keys)\n    when Symbol\n      actions.send_keys(keys)\n    when Array\n      down_keys.push\n      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }\n      down_keys.pop.reverse_each { |key| actions.key_up(key) }\n    else\n      raise ArgumentError, 'Unknown keys type'\n    end\n    actions\n  end\n\n  MODIFIER_KEYS = %i[control left_control right_control\n                     alt left_alt right_alt\n                     shift left_shift right_shift\n                     meta left_meta right_meta\n                     command].freeze\nend\n", "language": "Ruby", "function_component": {"name": "click", "signature": "def click(keys = [], **options)", "start_line": 9, "end_line": 26}, "metadata": {"module": "", "class_name": "Capybara::Selenium::SafariNode", "class_signature": "class Capybara::Selenium::SafariNode < < Capybara::Selenium::Node"}, "task_id": 151}
{"function_name": "set_text", "file_path": "capybara/lib/capybara/selenium/nodes/safari_node.rb", "focal_code": "def set_text(value, clear: nil, **_unused)\n    value = value.to_s\n    if clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys([:control, 'e'], *backspaces, value)\n    else\n      super.tap do\n        # React doesn't see the safaridriver element clear\n        send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\n# require 'capybara/selenium/extensions/html5_drag'\nrequire 'capybara/selenium/extensions/modifier_keys_stack'\n\nclass Capybara::Selenium::SafariNode < Capybara::Selenium::Node\n  # include Html5Drag\n\n  def click(keys = [], **options)\n    # driver.execute_script('arguments[0].scrollIntoViewIfNeeded({block: \"center\"})', self)\n    super\n  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError\n    if tag_name == 'tr'\n      warn 'You are attempting to click a table row which has issues in safaridriver - ' \\\n           'Your test should probably be clicking on a table cell like a user would. ' \\\n           'Clicking the first cell in the row instead.'\n      return find_css('th:first-child,td:first-child')[0].click(keys, **options)\n    end\n    raise\n  rescue ::Selenium::WebDriver::Error::WebDriverError => e\n    raise unless e.instance_of? ::Selenium::WebDriver::Error::WebDriverError\n\n    # Safari doesn't return a specific error here - assume it's an ElementNotInteractableError\n    raise ::Selenium::WebDriver::Error::ElementNotInteractableError,\n          'Non distinct error raised in #click, translated to ElementNotInteractableError for retry'\n  end\n\n  def select_option\n    # To optimize to only one check and then click\n    selected_or_disabled = driver.execute_script(<<~JS, self)\n      arguments[0].closest('select').scrollIntoView();\n      return arguments[0].matches(':disabled, select:disabled *, :checked');\n    JS\n    click unless selected_or_disabled\n  end\n\n  def unselect_option\n    driver.execute_script(\"arguments[0].closest('select').scrollIntoView()\", self)\n    super\n  end\n\n  def visible_text\n    return '' unless visible?\n\n    vis_text = driver.execute_script('return arguments[0].innerText', self)\n    vis_text.squeeze(' ')\n            .gsub(/[\\ \\n]*\\n[\\ \\n]*/, \"\\n\")\n            .gsub(/\\A[[:space:]&&[^\\u00a0]]+/, '')\n            .gsub(/[[:space:]&&[^\\u00a0]]+\\z/, '')\n            .tr(\"\\u00a0\", ' ')\n  end\n\n  def disabled?\n    driver.evaluate_script(\"arguments[0].matches(':disabled, select:disabled *')\", self)\n  end\n\n  def set_file(value) # rubocop:disable Naming/AccessorMethodName\n    # By default files are appended so we have to clear here if its multiple and already set\n    native.clear if multiple? && driver.evaluate_script('arguments[0].files', self).any?\n    super\n  end\n\n  def send_keys(*args)\n    if args.none? { |arg| arg.is_a?(Array) || (arg.is_a?(Symbol) && MODIFIER_KEYS.include?(arg)) }\n      return super(*args.map { |arg| arg == :space ? ' ' : arg })\n    end\n\n    native.click\n    _send_keys(args).perform\n  end\n\n  def set_text(value, clear: nil, **_unused)\n    value = value.to_s\n    if clear == :backspace\n      # Clear field by sending the correct number of backspace keys.\n      backspaces = [:backspace] * self.value.to_s.length\n      send_keys([:control, 'e'], *backspaces, value)\n    else\n      super.tap do\n        # React doesn't see the safaridriver element clear\n        send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?\n      end\n    end\n  end\n\n  def hover\n    # Workaround issue where hover would sometimes fail - possibly due to mouse not having moved\n    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }\n  end\n\nprivate\n\n  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)\n    case keys\n    when *MODIFIER_KEYS\n      down_keys.press(keys)\n      actions.key_down(keys)\n    when String\n      keys = keys.upcase if down_keys&.include?(:shift)\n      actions.send_keys(keys)\n    when Symbol\n      actions.send_keys(keys)\n    when Array\n      down_keys.push\n      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }\n      down_keys.pop.reverse_each { |key| actions.key_up(key) }\n    else\n      raise ArgumentError, 'Unknown keys type'\n    end\n    actions\n  end\n\n  MODIFIER_KEYS = %i[control left_control right_control\n                     alt left_alt right_alt\n                     shift left_shift right_shift\n                     meta left_meta right_meta\n                     command].freeze\nend\n", "language": "Ruby", "function_component": {"name": "set_text", "signature": "def set_text(value, clear: nil, **_unused)", "start_line": 72, "end_line": 84}, "metadata": {"module": "", "class_name": "Capybara::Selenium::SafariNode", "class_signature": "class Capybara::Selenium::SafariNode < < Capybara::Selenium::Node"}, "task_id": 152}
{"function_name": "read_atom", "file_path": "capybara/lib/capybara/selenium/patches/atoms.rb", "focal_code": "def read_atom(function)\n    @atoms ||= Hash.new do |hash, key|\n      hash[key] = begin\n        File.read(File.expand_path(\"../../atoms/#{key}.min.js\", __FILE__))\n      rescue Errno::ENOENT\n        super\n      end\n    end\n    @atoms[function]\n  end", "file_content": "# frozen_string_literal: true\n\nmodule CapybaraAtoms\nprivate\n\n  def read_atom(function)\n    @atoms ||= Hash.new do |hash, key|\n      hash[key] = begin\n        File.read(File.expand_path(\"../../atoms/#{key}.min.js\", __FILE__))\n      rescue Errno::ENOENT\n        super\n      end\n    end\n    @atoms[function]\n  end\nend\n\nSelenium::WebDriver::Remote::Bridge.prepend CapybaraAtoms unless ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']\n", "language": "Ruby", "function_component": {"name": "read_atom", "signature": "def read_atom(function)", "start_line": 6, "end_line": 15}, "metadata": {"module": "CapybaraAtoms", "class_name": "", "class_signature": ""}, "task_id": 153}
{"function_name": "log", "file_path": "capybara/lib/capybara/selenium/patches/logs.rb", "focal_code": "def log(type)\n        data = begin\n          execute :get_log, {}, type: type.to_s\n        rescue ::Selenium::WebDriver::Error::UnknownCommandError\n          execute :get_log_legacy, {}, type: type.to_s\n        end\n\n        Array(data).map do |l|\n          ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')\n        rescue KeyError\n          next\n        end\n      rescue ::Selenium::WebDriver::Error::UnknownCommandError\n        raise NotImplementedError, LOG_MSG\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Capybara\n  module Selenium\n    module ChromeLogs\n      LOG_MSG = <<~MSG\n        Chromedriver 75+ defaults to W3C mode. Please upgrade to chromedriver >= \\\n        75.0.3770.90 if you need to access logs while in W3C compliant mode.\n      MSG\n\n      COMMANDS = {\n        get_available_log_types: [:get, 'session/:session_id/se/log/types'],\n        get_log: [:post, 'session/:session_id/se/log'],\n        get_log_legacy: [:post, 'session/:session_id/log']\n      }.freeze\n\n      def commands(command)\n        COMMANDS[command] || super\n      end\n\n      def available_log_types\n        types = execute :get_available_log_types\n        Array(types).map(&:to_sym)\n      rescue ::Selenium::WebDriver::Error::UnknownCommandError\n        raise NotImplementedError, LOG_MSG\n      end\n\n      def log(type)\n        data = begin\n          execute :get_log, {}, type: type.to_s\n        rescue ::Selenium::WebDriver::Error::UnknownCommandError\n          execute :get_log_legacy, {}, type: type.to_s\n        end\n\n        Array(data).map do |l|\n          ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')\n        rescue KeyError\n          next\n        end\n      rescue ::Selenium::WebDriver::Error::UnknownCommandError\n        raise NotImplementedError, LOG_MSG\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "log", "signature": "def log(type)", "start_line": 28, "end_line": 42}, "metadata": {"module": "Capybara", "class_name": "", "class_signature": ""}, "task_id": 154}
{"function_name": "parse", "file_path": "dotenv/lib/dotenv.rb", "focal_code": "def parse(*filenames, overwrite: false, ignore: true, &block)\n    filenames << \".env\" if filenames.empty?\n    filenames = filenames.reverse if overwrite\n\n    filenames.reduce({}) do |hash, filename|\n      begin\n        env = Environment.new(File.expand_path(filename), overwrite: overwrite)\n        env = block.call(env) if block\n      rescue Errno::ENOENT, Errno::EISDIR\n        raise unless ignore\n      end\n\n      hash.merge! env || {}\n    end\n  end", "file_content": "require \"dotenv/version\"\nrequire \"dotenv/parser\"\nrequire \"dotenv/environment\"\nrequire \"dotenv/missing_keys\"\nrequire \"dotenv/diff\"\n\n# Shim to load environment variables from `.env files into `ENV`.\nmodule Dotenv\n  extend self\n\n  # An internal monitor to synchronize access to ENV in multi-threaded environments.\n  SEMAPHORE = Monitor.new\n  private_constant :SEMAPHORE\n\n  attr_accessor :instrumenter\n\n  # Loads environment variables from one or more `.env` files. See `#parse` for more details.\n  def load(*filenames, overwrite: false, ignore: true)\n    parse(*filenames, overwrite: overwrite, ignore: ignore) do |env|\n      instrument(:load, env: env) do |payload|\n        update(env, overwrite: overwrite)\n      end\n    end\n  end\n\n  # Same as `#load`, but raises Errno::ENOENT if any files don't exist\n  def load!(*filenames)\n    load(*filenames, ignore: false)\n  end\n\n  # same as `#load`, but will overwrite existing values in `ENV`\n  def overwrite(*filenames)\n    load(*filenames, overwrite: true)\n  end\n  alias_method :overload, :overwrite\n\n  # same as `#overwrite`, but raises Errno::ENOENT if any files don't exist\n  def overwrite!(*filenames)\n    load(*filenames, overwrite: true, ignore: false)\n  end\n  alias_method :overload!, :overwrite!\n\n  # Parses the given files, yielding for each file if a block is given.\n  #\n  # @param filenames [String, Array<String>] Files to parse\n  # @param overwrite [Boolean] Overwrite existing `ENV` values\n  # @param ignore [Boolean] Ignore non-existent files\n  # @param block [Proc] Block to yield for each parsed `Dotenv::Environment`\n  # @return [Hash] parsed key/value pairs\n  def parse(*filenames, overwrite: false, ignore: true, &block)\n    filenames << \".env\" if filenames.empty?\n    filenames = filenames.reverse if overwrite\n\n    filenames.reduce({}) do |hash, filename|\n      begin\n        env = Environment.new(File.expand_path(filename), overwrite: overwrite)\n        env = block.call(env) if block\n      rescue Errno::ENOENT, Errno::EISDIR\n        raise unless ignore\n      end\n\n      hash.merge! env || {}\n    end\n  end\n\n  # Save the current `ENV` to be restored later\n  def save\n    instrument(:save) do |payload|\n      @diff = payload[:diff] = Dotenv::Diff.new\n    end\n  end\n\n  # Restore `ENV` to a given state\n  #\n  # @param env [Hash] Hash of keys and values to restore, defaults to the last saved state\n  # @param safe [Boolean] Is it safe to modify `ENV`? Defaults to `true` in the main thread, otherwise raises an error.\n  def restore(env = @diff&.a, safe: Thread.current == Thread.main)\n    # No previously saved or provided state to restore\n    return unless env\n\n    diff = Dotenv::Diff.new(b: env)\n    return unless diff.any?\n\n    unless safe\n      raise ThreadError, <<~EOE.tr(\"\\n\", \" \")\n        Dotenv.restore is not thread safe. Use `Dotenv.modify { }` to update ENV for the duration\n        of the block in a thread safe manner, or call `Dotenv.restore(safe: true)` to ignore\n        this error.\n      EOE\n    end\n    instrument(:restore, diff: diff) { ENV.replace(env) }\n  end\n\n  # Update `ENV` with the given hash of keys and values\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  # @param overwrite [Boolean|:warn] Overwrite existing `ENV` values\n  def update(env = {}, overwrite: false)\n    instrument(:update) do |payload|\n      diff = payload[:diff] = Dotenv::Diff.new do\n        ENV.update(env.transform_keys(&:to_s)) do |key, old_value, new_value|\n          # This block is called when a key exists. Return the new value if overwrite is true.\n          case overwrite\n          when :warn\n            # not printing the value since that could be a secret\n            warn \"Warning: dotenv not overwriting ENV[#{key.inspect}]\"\n            old_value\n          when true then new_value\n          when false then old_value\n          else raise ArgumentError, \"Invalid value for overwrite: #{overwrite.inspect}\"\n          end\n        end\n      end\n      diff.env\n    end\n  end\n\n  # Modify `ENV` for the block and restore it to its previous state afterwards.\n  #\n  # Note that the block is synchronized to prevent concurrent modifications to `ENV`,\n  # so multiple threads will be executed serially.\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  def modify(env = {}, &block)\n    SEMAPHORE.synchronize do\n      diff = Dotenv::Diff.new\n      update(env, overwrite: true)\n      block.call\n    ensure\n      restore(diff.a, safe: true)\n    end\n  end\n\n  def require_keys(*keys)\n    missing_keys = keys.flatten - ::ENV.keys\n    return if missing_keys.empty?\n    raise MissingKeys, missing_keys\n  end\n\n  private\n\n  def instrument(name, payload = {}, &block)\n    if instrumenter\n      instrumenter.instrument(\"#{name}.dotenv\", payload, &block)\n    else\n      block&.call payload\n    end\n  end\nend\n\nrequire \"dotenv/rails\" if defined?(Rails::Railtie)\n", "language": "Ruby", "function_component": {"name": "parse", "signature": "def parse(*filenames, overwrite: false, ignore: true, &block)", "start_line": 50, "end_line": 64}, "metadata": {"module": "Dotenv", "class_name": "", "class_signature": ""}, "task_id": 155}
{"function_name": "restore", "file_path": "dotenv/lib/dotenv.rb", "focal_code": "def restore(env = @diff&.a, safe: Thread.current == Thread.main)\n    # No previously saved or provided state to restore\n    return unless env\n\n    diff = Dotenv::Diff.new(b: env)\n    return unless diff.any?\n\n    unless safe\n      raise ThreadError, <<~EOE.tr(\"\\n\", \" \")\n        Dotenv.restore is not thread safe. Use `Dotenv.modify { }` to update ENV for the duration\n        of the block in a thread safe manner, or call `Dotenv.restore(safe: true)` to ignore\n        this error.\n      EOE\n    end\n    instrument(:restore, diff: diff) { ENV.replace(env) }\n  end", "file_content": "require \"dotenv/version\"\nrequire \"dotenv/parser\"\nrequire \"dotenv/environment\"\nrequire \"dotenv/missing_keys\"\nrequire \"dotenv/diff\"\n\n# Shim to load environment variables from `.env files into `ENV`.\nmodule Dotenv\n  extend self\n\n  # An internal monitor to synchronize access to ENV in multi-threaded environments.\n  SEMAPHORE = Monitor.new\n  private_constant :SEMAPHORE\n\n  attr_accessor :instrumenter\n\n  # Loads environment variables from one or more `.env` files. See `#parse` for more details.\n  def load(*filenames, overwrite: false, ignore: true)\n    parse(*filenames, overwrite: overwrite, ignore: ignore) do |env|\n      instrument(:load, env: env) do |payload|\n        update(env, overwrite: overwrite)\n      end\n    end\n  end\n\n  # Same as `#load`, but raises Errno::ENOENT if any files don't exist\n  def load!(*filenames)\n    load(*filenames, ignore: false)\n  end\n\n  # same as `#load`, but will overwrite existing values in `ENV`\n  def overwrite(*filenames)\n    load(*filenames, overwrite: true)\n  end\n  alias_method :overload, :overwrite\n\n  # same as `#overwrite`, but raises Errno::ENOENT if any files don't exist\n  def overwrite!(*filenames)\n    load(*filenames, overwrite: true, ignore: false)\n  end\n  alias_method :overload!, :overwrite!\n\n  # Parses the given files, yielding for each file if a block is given.\n  #\n  # @param filenames [String, Array<String>] Files to parse\n  # @param overwrite [Boolean] Overwrite existing `ENV` values\n  # @param ignore [Boolean] Ignore non-existent files\n  # @param block [Proc] Block to yield for each parsed `Dotenv::Environment`\n  # @return [Hash] parsed key/value pairs\n  def parse(*filenames, overwrite: false, ignore: true, &block)\n    filenames << \".env\" if filenames.empty?\n    filenames = filenames.reverse if overwrite\n\n    filenames.reduce({}) do |hash, filename|\n      begin\n        env = Environment.new(File.expand_path(filename), overwrite: overwrite)\n        env = block.call(env) if block\n      rescue Errno::ENOENT, Errno::EISDIR\n        raise unless ignore\n      end\n\n      hash.merge! env || {}\n    end\n  end\n\n  # Save the current `ENV` to be restored later\n  def save\n    instrument(:save) do |payload|\n      @diff = payload[:diff] = Dotenv::Diff.new\n    end\n  end\n\n  # Restore `ENV` to a given state\n  #\n  # @param env [Hash] Hash of keys and values to restore, defaults to the last saved state\n  # @param safe [Boolean] Is it safe to modify `ENV`? Defaults to `true` in the main thread, otherwise raises an error.\n  def restore(env = @diff&.a, safe: Thread.current == Thread.main)\n    # No previously saved or provided state to restore\n    return unless env\n\n    diff = Dotenv::Diff.new(b: env)\n    return unless diff.any?\n\n    unless safe\n      raise ThreadError, <<~EOE.tr(\"\\n\", \" \")\n        Dotenv.restore is not thread safe. Use `Dotenv.modify { }` to update ENV for the duration\n        of the block in a thread safe manner, or call `Dotenv.restore(safe: true)` to ignore\n        this error.\n      EOE\n    end\n    instrument(:restore, diff: diff) { ENV.replace(env) }\n  end\n\n  # Update `ENV` with the given hash of keys and values\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  # @param overwrite [Boolean|:warn] Overwrite existing `ENV` values\n  def update(env = {}, overwrite: false)\n    instrument(:update) do |payload|\n      diff = payload[:diff] = Dotenv::Diff.new do\n        ENV.update(env.transform_keys(&:to_s)) do |key, old_value, new_value|\n          # This block is called when a key exists. Return the new value if overwrite is true.\n          case overwrite\n          when :warn\n            # not printing the value since that could be a secret\n            warn \"Warning: dotenv not overwriting ENV[#{key.inspect}]\"\n            old_value\n          when true then new_value\n          when false then old_value\n          else raise ArgumentError, \"Invalid value for overwrite: #{overwrite.inspect}\"\n          end\n        end\n      end\n      diff.env\n    end\n  end\n\n  # Modify `ENV` for the block and restore it to its previous state afterwards.\n  #\n  # Note that the block is synchronized to prevent concurrent modifications to `ENV`,\n  # so multiple threads will be executed serially.\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  def modify(env = {}, &block)\n    SEMAPHORE.synchronize do\n      diff = Dotenv::Diff.new\n      update(env, overwrite: true)\n      block.call\n    ensure\n      restore(diff.a, safe: true)\n    end\n  end\n\n  def require_keys(*keys)\n    missing_keys = keys.flatten - ::ENV.keys\n    return if missing_keys.empty?\n    raise MissingKeys, missing_keys\n  end\n\n  private\n\n  def instrument(name, payload = {}, &block)\n    if instrumenter\n      instrumenter.instrument(\"#{name}.dotenv\", payload, &block)\n    else\n      block&.call payload\n    end\n  end\nend\n\nrequire \"dotenv/rails\" if defined?(Rails::Railtie)\n", "language": "Ruby", "function_component": {"name": "restore", "signature": "def restore(env = @diff&.a, safe: Thread.current == Thread.main)", "start_line": 77, "end_line": 92}, "metadata": {"module": "Dotenv", "class_name": "", "class_signature": ""}, "task_id": 156}
{"function_name": "update", "file_path": "dotenv/lib/dotenv.rb", "focal_code": "def update(env = {}, overwrite: false)\n    instrument(:update) do |payload|\n      diff = payload[:diff] = Dotenv::Diff.new do\n        ENV.update(env.transform_keys(&:to_s)) do |key, old_value, new_value|\n          # This block is called when a key exists. Return the new value if overwrite is true.\n          case overwrite\n          when :warn\n            # not printing the value since that could be a secret\n            warn \"Warning: dotenv not overwriting ENV[#{key.inspect}]\"\n            old_value\n          when true then new_value\n          when false then old_value\n          else raise ArgumentError, \"Invalid value for overwrite: #{overwrite.inspect}\"\n          end\n        end\n      end\n      diff.env\n    end\n  end", "file_content": "require \"dotenv/version\"\nrequire \"dotenv/parser\"\nrequire \"dotenv/environment\"\nrequire \"dotenv/missing_keys\"\nrequire \"dotenv/diff\"\n\n# Shim to load environment variables from `.env files into `ENV`.\nmodule Dotenv\n  extend self\n\n  # An internal monitor to synchronize access to ENV in multi-threaded environments.\n  SEMAPHORE = Monitor.new\n  private_constant :SEMAPHORE\n\n  attr_accessor :instrumenter\n\n  # Loads environment variables from one or more `.env` files. See `#parse` for more details.\n  def load(*filenames, overwrite: false, ignore: true)\n    parse(*filenames, overwrite: overwrite, ignore: ignore) do |env|\n      instrument(:load, env: env) do |payload|\n        update(env, overwrite: overwrite)\n      end\n    end\n  end\n\n  # Same as `#load`, but raises Errno::ENOENT if any files don't exist\n  def load!(*filenames)\n    load(*filenames, ignore: false)\n  end\n\n  # same as `#load`, but will overwrite existing values in `ENV`\n  def overwrite(*filenames)\n    load(*filenames, overwrite: true)\n  end\n  alias_method :overload, :overwrite\n\n  # same as `#overwrite`, but raises Errno::ENOENT if any files don't exist\n  def overwrite!(*filenames)\n    load(*filenames, overwrite: true, ignore: false)\n  end\n  alias_method :overload!, :overwrite!\n\n  # Parses the given files, yielding for each file if a block is given.\n  #\n  # @param filenames [String, Array<String>] Files to parse\n  # @param overwrite [Boolean] Overwrite existing `ENV` values\n  # @param ignore [Boolean] Ignore non-existent files\n  # @param block [Proc] Block to yield for each parsed `Dotenv::Environment`\n  # @return [Hash] parsed key/value pairs\n  def parse(*filenames, overwrite: false, ignore: true, &block)\n    filenames << \".env\" if filenames.empty?\n    filenames = filenames.reverse if overwrite\n\n    filenames.reduce({}) do |hash, filename|\n      begin\n        env = Environment.new(File.expand_path(filename), overwrite: overwrite)\n        env = block.call(env) if block\n      rescue Errno::ENOENT, Errno::EISDIR\n        raise unless ignore\n      end\n\n      hash.merge! env || {}\n    end\n  end\n\n  # Save the current `ENV` to be restored later\n  def save\n    instrument(:save) do |payload|\n      @diff = payload[:diff] = Dotenv::Diff.new\n    end\n  end\n\n  # Restore `ENV` to a given state\n  #\n  # @param env [Hash] Hash of keys and values to restore, defaults to the last saved state\n  # @param safe [Boolean] Is it safe to modify `ENV`? Defaults to `true` in the main thread, otherwise raises an error.\n  def restore(env = @diff&.a, safe: Thread.current == Thread.main)\n    # No previously saved or provided state to restore\n    return unless env\n\n    diff = Dotenv::Diff.new(b: env)\n    return unless diff.any?\n\n    unless safe\n      raise ThreadError, <<~EOE.tr(\"\\n\", \" \")\n        Dotenv.restore is not thread safe. Use `Dotenv.modify { }` to update ENV for the duration\n        of the block in a thread safe manner, or call `Dotenv.restore(safe: true)` to ignore\n        this error.\n      EOE\n    end\n    instrument(:restore, diff: diff) { ENV.replace(env) }\n  end\n\n  # Update `ENV` with the given hash of keys and values\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  # @param overwrite [Boolean|:warn] Overwrite existing `ENV` values\n  def update(env = {}, overwrite: false)\n    instrument(:update) do |payload|\n      diff = payload[:diff] = Dotenv::Diff.new do\n        ENV.update(env.transform_keys(&:to_s)) do |key, old_value, new_value|\n          # This block is called when a key exists. Return the new value if overwrite is true.\n          case overwrite\n          when :warn\n            # not printing the value since that could be a secret\n            warn \"Warning: dotenv not overwriting ENV[#{key.inspect}]\"\n            old_value\n          when true then new_value\n          when false then old_value\n          else raise ArgumentError, \"Invalid value for overwrite: #{overwrite.inspect}\"\n          end\n        end\n      end\n      diff.env\n    end\n  end\n\n  # Modify `ENV` for the block and restore it to its previous state afterwards.\n  #\n  # Note that the block is synchronized to prevent concurrent modifications to `ENV`,\n  # so multiple threads will be executed serially.\n  #\n  # @param env [Hash] Hash of keys and values to set in `ENV`\n  def modify(env = {}, &block)\n    SEMAPHORE.synchronize do\n      diff = Dotenv::Diff.new\n      update(env, overwrite: true)\n      block.call\n    ensure\n      restore(diff.a, safe: true)\n    end\n  end\n\n  def require_keys(*keys)\n    missing_keys = keys.flatten - ::ENV.keys\n    return if missing_keys.empty?\n    raise MissingKeys, missing_keys\n  end\n\n  private\n\n  def instrument(name, payload = {}, &block)\n    if instrumenter\n      instrumenter.instrument(\"#{name}.dotenv\", payload, &block)\n    else\n      block&.call payload\n    end\n  end\nend\n\nrequire \"dotenv/rails\" if defined?(Rails::Railtie)\n", "language": "Ruby", "function_component": {"name": "update", "signature": "def update(env = {}, overwrite: false)", "start_line": 98, "end_line": 116}, "metadata": {"module": "Dotenv", "class_name": "", "class_signature": ""}, "task_id": 157}
{"function_name": "initialize", "file_path": "dotenv/lib/dotenv/cli.rb", "focal_code": "def initialize(argv = [])\n      @argv = argv.dup\n      @filenames = []\n      @ignore = false\n      @overwrite = false\n\n      super(\"Usage: dotenv [options]\")\n      separator \"\"\n\n      on(\"-f FILES\", Array, \"List of env files to parse\") do |list|\n        @filenames = list\n      end\n\n      on(\"-i\", \"--ignore\", \"ignore missing env files\") do\n        @ignore = true\n      end\n\n      on(\"-o\", \"--overwrite\", \"overwrite existing ENV variables\") do\n        @overwrite = true\n      end\n      on(\"--overload\") { @overwrite = true }\n\n      on(\"-h\", \"--help\", \"Display help\") do\n        puts self\n        exit\n      end\n\n      on(\"-v\", \"--version\", \"Show version\") do\n        puts \"dotenv #{Dotenv::VERSION}\"\n        exit\n      end\n\n      on(\"-t\", \"--template=FILE\", \"Create a template env file\") do |file|\n        template = Dotenv::EnvTemplate.new(file)\n        template.create_template\n      end\n\n      order!(@argv)\n    end", "file_content": "require \"dotenv\"\nrequire \"dotenv/version\"\nrequire \"dotenv/template\"\nrequire \"optparse\"\n\nmodule Dotenv\n  # The `dotenv` command line interface. Run `$ dotenv --help` to see usage.\n  class CLI < OptionParser\n    attr_reader :argv, :filenames, :overwrite\n\n    def initialize(argv = [])\n      @argv = argv.dup\n      @filenames = []\n      @ignore = false\n      @overwrite = false\n\n      super(\"Usage: dotenv [options]\")\n      separator \"\"\n\n      on(\"-f FILES\", Array, \"List of env files to parse\") do |list|\n        @filenames = list\n      end\n\n      on(\"-i\", \"--ignore\", \"ignore missing env files\") do\n        @ignore = true\n      end\n\n      on(\"-o\", \"--overwrite\", \"overwrite existing ENV variables\") do\n        @overwrite = true\n      end\n      on(\"--overload\") { @overwrite = true }\n\n      on(\"-h\", \"--help\", \"Display help\") do\n        puts self\n        exit\n      end\n\n      on(\"-v\", \"--version\", \"Show version\") do\n        puts \"dotenv #{Dotenv::VERSION}\"\n        exit\n      end\n\n      on(\"-t\", \"--template=FILE\", \"Create a template env file\") do |file|\n        template = Dotenv::EnvTemplate.new(file)\n        template.create_template\n      end\n\n      order!(@argv)\n    end\n\n    def run\n      Dotenv.load(*@filenames, overwrite: @overwrite, ignore: @ignore)\n    rescue Errno::ENOENT => e\n      abort e.message\n    else\n      exec(*@argv) unless @argv.empty?\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(argv = [])", "start_line": 11, "end_line": 49}, "metadata": {"module": "Dotenv", "class_name": "CLI", "class_signature": "class CLI < < OptionParser"}, "task_id": 158}
{"function_name": "restore", "file_path": "dotenv/lib/dotenv/log_subscriber.rb", "focal_code": "def restore(event)\n      diff = event.payload[:diff]\n\n      removed = diff.removed.keys.map { |key| color(key, :RED) }\n      restored = (diff.changed.keys + diff.added.keys).map { |key| color_var(key) }\n\n      if removed.any? || restored.any?\n        info \"Restored snapshot of #{color_env_constant}\"\n        debug \"Unset #{removed.join(\", \")}\" if removed.any?\n        debug \"Restored #{restored.join(\", \")}\" if restored.any?\n      end\n    end", "file_content": "require \"active_support/log_subscriber\"\n\nmodule Dotenv\n  # Logs instrumented events\n  #\n  # Usage:\n  #   require \"active_support/notifications\"\n  #   require \"dotenv/log_subscriber\"\n  #   Dotenv.instrumenter = ActiveSupport::Notifications\n  #\n  class LogSubscriber < ActiveSupport::LogSubscriber\n    attach_to :dotenv\n\n    def logger\n      Dotenv::Rails.logger\n    end\n\n    def load(event)\n      env = event.payload[:env]\n\n      info \"Loaded #{color_filename(env.filename)}\"\n    end\n\n    def update(event)\n      diff = event.payload[:diff]\n      changed = diff.env.keys.map { |key| color_var(key) }\n      debug \"Set #{changed.join(\", \")}\" if diff.any?\n    end\n\n    def save(event)\n      info \"Saved a snapshot of #{color_env_constant}\"\n    end\n\n    def restore(event)\n      diff = event.payload[:diff]\n\n      removed = diff.removed.keys.map { |key| color(key, :RED) }\n      restored = (diff.changed.keys + diff.added.keys).map { |key| color_var(key) }\n\n      if removed.any? || restored.any?\n        info \"Restored snapshot of #{color_env_constant}\"\n        debug \"Unset #{removed.join(\", \")}\" if removed.any?\n        debug \"Restored #{restored.join(\", \")}\" if restored.any?\n      end\n    end\n\n    private\n\n    def color_filename(filename)\n      color(Pathname.new(filename).relative_path_from(Dotenv::Rails.root.to_s).to_s, :YELLOW)\n    end\n\n    def color_var(name)\n      color(name, :CYAN)\n    end\n\n    def color_env_constant\n      color(\"ENV\", :GREEN)\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "restore", "signature": "def restore(event)", "start_line": 34, "end_line": 45}, "metadata": {"module": "Dotenv", "class_name": "LogSubscriber", "class_signature": "class LogSubscriber < < ActiveSupport::LogSubscriber"}, "task_id": 159}
{"function_name": "call", "file_path": "dotenv/lib/dotenv/parser.rb", "focal_code": "def call\n      @string.scan(LINE) do\n        match = $LAST_MATCH_INFO\n\n        if existing?(match[:key])\n          # Use value from already defined variable\n          @hash[match[:key]] = ENV[match[:key]]\n        elsif match[:export] && !match[:value]\n          # Check for exported variable with no value\n          if !@hash.member?(match[:key])\n            raise FormatError, \"Line #{match.to_s.inspect} has an unset variable\"\n          end\n        else\n          @hash[match[:key]] = parse_value(match[:value] || \"\")\n        end\n      end\n\n      @hash\n    end", "file_content": "require \"dotenv/substitutions/variable\"\nrequire \"dotenv/substitutions/command\" if RUBY_VERSION > \"1.8.7\"\n\nmodule Dotenv\n  # Error raised when encountering a syntax error while parsing a .env file.\n  class FormatError < SyntaxError; end\n\n  # Parses the `.env` file format into key/value pairs.\n  # It allows for variable substitutions, command substitutions, and exporting of variables.\n  class Parser\n    @substitutions = [\n      Dotenv::Substitutions::Command,\n      Dotenv::Substitutions::Variable\n    ]\n\n    LINE = /\n      (?:^|\\A)                # beginning of line\n      \\s*                     # leading whitespace\n      (?<export>export\\s+)?   # optional export\n      (?<key>[\\w.]+)          # key\n      (?:                     # optional separator and value\n        (?:\\s*=\\s*?|:\\s+?)    #   separator\n        (?<value>             #   optional value begin\n          \\s*'(?:\\\\'|[^'])*'  #     single quoted value\n          |                   #     or\n          \\s*\"(?:\\\\\"|[^\"])*\"  #     double quoted value\n          |                   #     or\n          [^\\#\\n]+            #     unquoted value\n        )?                    #   value end\n      )?                      # separator and value end\n      \\s*                     # trailing whitespace\n      (?:\\#.*)?               # optional comment\n      (?:$|\\z)                # end of line\n    /x\n\n    QUOTED_STRING = /\\A(['\"])(.*)\\1\\z/m\n\n    class << self\n      attr_reader :substitutions\n\n      def call(...)\n        new(...).call\n      end\n    end\n\n    def initialize(string, overwrite: false)\n      # Convert line breaks to same format\n      @string = string.gsub(/\\r\\n?/, \"\\n\")\n      @hash = {}\n      @overwrite = overwrite\n    end\n\n    def call\n      @string.scan(LINE) do\n        match = $LAST_MATCH_INFO\n\n        if existing?(match[:key])\n          # Use value from already defined variable\n          @hash[match[:key]] = ENV[match[:key]]\n        elsif match[:export] && !match[:value]\n          # Check for exported variable with no value\n          if !@hash.member?(match[:key])\n            raise FormatError, \"Line #{match.to_s.inspect} has an unset variable\"\n          end\n        else\n          @hash[match[:key]] = parse_value(match[:value] || \"\")\n        end\n      end\n\n      @hash\n    end\n\n    private\n\n    # Determine if a variable is already defined and should not be overwritten.\n    def existing?(key)\n      !@overwrite && key != \"DOTENV_LINEBREAK_MODE\" && ENV.key?(key)\n    end\n\n    def parse_value(value)\n      # Remove surrounding quotes\n      value = value.strip.sub(QUOTED_STRING, '\\2')\n      maybe_quote = Regexp.last_match(1)\n\n      # Expand new lines in double quoted values\n      value = expand_newlines(value) if maybe_quote == '\"'\n\n      # Unescape characters and performs substitutions unless value is single quoted\n      if maybe_quote != \"'\"\n        value = unescape_characters(value)\n        self.class.substitutions.each { |proc| value = proc.call(value, @hash) }\n      end\n\n      value\n    end\n\n    def unescape_characters(value)\n      value.gsub(/\\\\([^$])/, '\\1')\n    end\n\n    def expand_newlines(value)\n      if (@hash[\"DOTENV_LINEBREAK_MODE\"] || ENV[\"DOTENV_LINEBREAK_MODE\"]) == \"legacy\"\n        value.gsub('\\n', \"\\n\").gsub('\\r', \"\\r\")\n      else\n        value.gsub('\\n', \"\\\\\\\\\\\\n\").gsub('\\r', \"\\\\\\\\\\\\r\")\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call @string.scan(LINE) do", "start_line": 53, "end_line": 71}, "metadata": {"module": "Dotenv", "class_name": "Parser", "class_signature": "class Parser"}, "task_id": 160}
{"function_name": "parse_value", "file_path": "dotenv/lib/dotenv/parser.rb", "focal_code": "def parse_value(value)\n      # Remove surrounding quotes\n      value = value.strip.sub(QUOTED_STRING, '\\2')\n      maybe_quote = Regexp.last_match(1)\n\n      # Expand new lines in double quoted values\n      value = expand_newlines(value) if maybe_quote == '\"'\n\n      # Unescape characters and performs substitutions unless value is single quoted\n      if maybe_quote != \"'\"\n        value = unescape_characters(value)\n        self.class.substitutions.each { |proc| value = proc.call(value, @hash) }\n      end\n\n      value\n    end", "file_content": "require \"dotenv/substitutions/variable\"\nrequire \"dotenv/substitutions/command\" if RUBY_VERSION > \"1.8.7\"\n\nmodule Dotenv\n  # Error raised when encountering a syntax error while parsing a .env file.\n  class FormatError < SyntaxError; end\n\n  # Parses the `.env` file format into key/value pairs.\n  # It allows for variable substitutions, command substitutions, and exporting of variables.\n  class Parser\n    @substitutions = [\n      Dotenv::Substitutions::Command,\n      Dotenv::Substitutions::Variable\n    ]\n\n    LINE = /\n      (?:^|\\A)                # beginning of line\n      \\s*                     # leading whitespace\n      (?<export>export\\s+)?   # optional export\n      (?<key>[\\w.]+)          # key\n      (?:                     # optional separator and value\n        (?:\\s*=\\s*?|:\\s+?)    #   separator\n        (?<value>             #   optional value begin\n          \\s*'(?:\\\\'|[^'])*'  #     single quoted value\n          |                   #     or\n          \\s*\"(?:\\\\\"|[^\"])*\"  #     double quoted value\n          |                   #     or\n          [^\\#\\n]+            #     unquoted value\n        )?                    #   value end\n      )?                      # separator and value end\n      \\s*                     # trailing whitespace\n      (?:\\#.*)?               # optional comment\n      (?:$|\\z)                # end of line\n    /x\n\n    QUOTED_STRING = /\\A(['\"])(.*)\\1\\z/m\n\n    class << self\n      attr_reader :substitutions\n\n      def call(...)\n        new(...).call\n      end\n    end\n\n    def initialize(string, overwrite: false)\n      # Convert line breaks to same format\n      @string = string.gsub(/\\r\\n?/, \"\\n\")\n      @hash = {}\n      @overwrite = overwrite\n    end\n\n    def call\n      @string.scan(LINE) do\n        match = $LAST_MATCH_INFO\n\n        if existing?(match[:key])\n          # Use value from already defined variable\n          @hash[match[:key]] = ENV[match[:key]]\n        elsif match[:export] && !match[:value]\n          # Check for exported variable with no value\n          if !@hash.member?(match[:key])\n            raise FormatError, \"Line #{match.to_s.inspect} has an unset variable\"\n          end\n        else\n          @hash[match[:key]] = parse_value(match[:value] || \"\")\n        end\n      end\n\n      @hash\n    end\n\n    private\n\n    # Determine if a variable is already defined and should not be overwritten.\n    def existing?(key)\n      !@overwrite && key != \"DOTENV_LINEBREAK_MODE\" && ENV.key?(key)\n    end\n\n    def parse_value(value)\n      # Remove surrounding quotes\n      value = value.strip.sub(QUOTED_STRING, '\\2')\n      maybe_quote = Regexp.last_match(1)\n\n      # Expand new lines in double quoted values\n      value = expand_newlines(value) if maybe_quote == '\"'\n\n      # Unescape characters and performs substitutions unless value is single quoted\n      if maybe_quote != \"'\"\n        value = unescape_characters(value)\n        self.class.substitutions.each { |proc| value = proc.call(value, @hash) }\n      end\n\n      value\n    end\n\n    def unescape_characters(value)\n      value.gsub(/\\\\([^$])/, '\\1')\n    end\n\n    def expand_newlines(value)\n      if (@hash[\"DOTENV_LINEBREAK_MODE\"] || ENV[\"DOTENV_LINEBREAK_MODE\"]) == \"legacy\"\n        value.gsub('\\n', \"\\n\").gsub('\\r', \"\\r\")\n      else\n        value.gsub('\\n', \"\\\\\\\\\\\\n\").gsub('\\r', \"\\\\\\\\\\\\r\")\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse_value", "signature": "def parse_value(value)", "start_line": 80, "end_line": 95}, "metadata": {"module": "Dotenv", "class_name": "Parser", "class_signature": "class Parser"}, "task_id": 161}
{"function_name": "initialize", "file_path": "dotenv/lib/dotenv/rails.rb", "focal_code": "def initialize\n      super\n      config.dotenv = ActiveSupport::OrderedOptions.new.update(\n        # Rails.logger is not available yet, so we'll save log messages and replay them when it is\n        logger: Dotenv::ReplayLogger.new,\n        overwrite: false,\n        files: [\n          \".env.#{env}.local\",\n          (\".env.local\" unless env.test?),\n          \".env.#{env}\",\n          \".env\"\n        ].compact,\n        autorestore: env.test? && !defined?(ClimateControl) && !defined?(IceAge)\n      )\n    end", "file_content": "# Since rubygems doesn't support optional dependencies, we have to manually check\nunless Gem::Requirement.new(\">= 6.1\").satisfied_by?(Gem::Version.new(Rails.version))\n  warn \"dotenv 3.0 only supports Rails 6.1 or later. Use dotenv ~> 2.0.\"\n  return\nend\n\nrequire \"dotenv/replay_logger\"\nrequire \"dotenv/log_subscriber\"\n\nDotenv.instrumenter = ActiveSupport::Notifications\n\n# Watch all loaded env files with Spring\nActiveSupport::Notifications.subscribe(\"load.dotenv\") do |*args|\n  if defined?(Spring) && Spring.respond_to?(:watch)\n    event = ActiveSupport::Notifications::Event.new(*args)\n    Spring.watch event.payload[:env].filename if Rails.application\n  end\nend\n\nmodule Dotenv\n  # Rails integration for using Dotenv to load ENV variables from a file\n  class Rails < ::Rails::Railtie\n    delegate :files, :files=, :overwrite, :overwrite=, :autorestore, :autorestore=, :logger, to: \"config.dotenv\"\n\n    def initialize\n      super\n      config.dotenv = ActiveSupport::OrderedOptions.new.update(\n        # Rails.logger is not available yet, so we'll save log messages and replay them when it is\n        logger: Dotenv::ReplayLogger.new,\n        overwrite: false,\n        files: [\n          \".env.#{env}.local\",\n          (\".env.local\" unless env.test?),\n          \".env.#{env}\",\n          \".env\"\n        ].compact,\n        autorestore: env.test? && !defined?(ClimateControl) && !defined?(IceAge)\n      )\n    end\n\n    # Public: Load dotenv\n    #\n    # This will get called during the `before_configuration` callback, but you\n    # can manually call `Dotenv::Rails.load` if you needed it sooner.\n    def load\n      Dotenv.load(*files.map { |file| root.join(file).to_s }, overwrite: overwrite)\n    end\n\n    def overload\n      deprecator.warn(\"Dotenv::Rails.overload is deprecated. Set `Dotenv::Rails.overwrite = true` and call Dotenv::Rails.load instead.\")\n      Dotenv.load(*files.map { |file| root.join(file).to_s }, overwrite: true)\n    end\n\n    # Internal: `Rails.root` is nil in Rails 4.1 before the application is\n    # initialized, so this falls back to the `RAILS_ROOT` environment variable,\n    # or the current working directory.\n    def root\n      ::Rails.root || Pathname.new(ENV[\"RAILS_ROOT\"] || Dir.pwd)\n    end\n\n    # Set a new logger and replay logs\n    def logger=(new_logger)\n      logger.replay new_logger if logger.is_a?(ReplayLogger)\n      config.dotenv.logger = new_logger\n    end\n\n    # The current environment that the app is running in.\n    #\n    # When running `rake`, the Rails application is initialized in development, so we have to\n    # check which rake tasks are being run to determine the environment.\n    #\n    # See https://github.com/bkeepers/dotenv/issues/219\n    def env\n      @env ||= if defined?(Rake.application) && Rake.application.top_level_tasks.grep(TEST_RAKE_TASKS).any?\n        env = Rake.application.options.show_tasks ? \"development\" : \"test\"\n        ActiveSupport::EnvironmentInquirer.new(env)\n      else\n        ::Rails.env\n      end\n    end\n    TEST_RAKE_TASKS = /^(default$|test(:|$)|parallel:spec|spec(:|$))/\n\n    def deprecator # :nodoc:\n      @deprecator ||= ActiveSupport::Deprecation.new\n    end\n\n    # Rails uses `#method_missing` to delegate all class methods to the\n    # instance, which means `Kernel#load` gets called here. We don't want that.\n    def self.load\n      instance.load\n    end\n\n    initializer \"dotenv\", after: :initialize_logger do |app|\n      if logger.is_a?(ReplayLogger)\n        self.logger = ActiveSupport::TaggedLogging.new(::Rails.logger).tagged(\"dotenv\")\n      end\n    end\n\n    initializer \"dotenv.deprecator\" do |app|\n      app.deprecators[:dotenv] = deprecator if app.respond_to?(:deprecators)\n    end\n\n    initializer \"dotenv.autorestore\" do |app|\n      require \"dotenv/autorestore\" if autorestore\n    end\n\n    config.before_configuration { load }\n  end\n\n  Railtie = ActiveSupport::Deprecation::DeprecatedConstantProxy.new(\"Dotenv::Railtie\", \"Dotenv::Rails\", Dotenv::Rails.deprecator)\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize super", "start_line": 25, "end_line": 39}, "metadata": {"module": "Dotenv", "class_name": "Rails", "class_signature": "class Rails < < ::Rails::Railtie"}, "task_id": 162}
{"function_name": "create_template", "file_path": "dotenv/lib/dotenv/template.rb", "focal_code": "def create_template\n      File.open(@env_file, \"r\") do |env_file|\n        File.open(\"#{@env_file}.template\", \"w\") do |env_template|\n          env_file.each do |line|\n            if is_comment?(line)\n              env_template.puts line\n            elsif (var = var_defined?(line))\n              if line.match(EXPORT_COMMAND)\n                env_template.puts \"export #{var}=#{var}\"\n              else\n                env_template.puts \"#{var}=#{var}\"\n              end\n            elsif line_blank?(line)\n              env_template.puts\n            end\n          end\n        end\n      end\n    end", "file_content": "module Dotenv\n  EXPORT_COMMAND = \"export \".freeze\n  # Class for creating a template from a env file\n  class EnvTemplate\n    def initialize(env_file)\n      @env_file = env_file\n    end\n\n    def create_template\n      File.open(@env_file, \"r\") do |env_file|\n        File.open(\"#{@env_file}.template\", \"w\") do |env_template|\n          env_file.each do |line|\n            if is_comment?(line)\n              env_template.puts line\n            elsif (var = var_defined?(line))\n              if line.match(EXPORT_COMMAND)\n                env_template.puts \"export #{var}=#{var}\"\n              else\n                env_template.puts \"#{var}=#{var}\"\n              end\n            elsif line_blank?(line)\n              env_template.puts\n            end\n          end\n        end\n      end\n    end\n\n    private\n\n    def is_comment?(line)\n      line.strip.start_with?(\"#\")\n    end\n\n    def var_defined?(line)\n      match = Dotenv::Parser::LINE.match(line)\n      match && match[:key]\n    end\n\n    def line_blank?(line)\n      line.strip.length.zero?\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "create_template", "signature": "def create_template File.open(@env_file, \"r\") do |env_file|", "start_line": 9, "end_line": 27}, "metadata": {"module": "Dotenv", "class_name": "EnvTemplate", "class_signature": "class EnvTemplate"}, "task_id": 163}
{"function_name": "call", "file_path": "dotenv/lib/dotenv/substitutions/command.rb", "focal_code": "def call(value, env)\n          # Process interpolated shell commands\n          value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|\n            # Eliminate opening and closing parentheses\n            command = $LAST_MATCH_INFO[:cmd][1..-2]\n\n            if $LAST_MATCH_INFO[:backslash]\n              # Command is escaped, don't replace it.\n              $LAST_MATCH_INFO[0][1..]\n            else\n              # Execute the command and return the value\n              `#{Variable.call(command, env)}`.chomp\n            end\n          end\n        end", "file_content": "require \"English\"\n\nmodule Dotenv\n  module Substitutions\n    # Substitute shell commands in a value.\n    #\n    #   SHA=$(git rev-parse HEAD)\n    #\n    module Command\n      class << self\n        INTERPOLATED_SHELL_COMMAND = /\n          (?<backslash>\\\\)?   # is it escaped with a backslash?\n          \\$                  # literal $\n          (?<cmd>             # collect command content for eval\n            \\(                # require opening paren\n            (?:[^()]|\\g<cmd>)+  # allow any number of non-parens, or balanced\n                              # parens (by nesting the <cmd> expression\n                              # recursively)\n            \\)                # require closing paren\n          )\n        /x\n\n        def call(value, env)\n          # Process interpolated shell commands\n          value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|\n            # Eliminate opening and closing parentheses\n            command = $LAST_MATCH_INFO[:cmd][1..-2]\n\n            if $LAST_MATCH_INFO[:backslash]\n              # Command is escaped, don't replace it.\n              $LAST_MATCH_INFO[0][1..]\n            else\n              # Execute the command and return the value\n              `#{Variable.call(command, env)}`.chomp\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(value, env)", "start_line": 23, "end_line": 37}, "metadata": {"module": "Dotenv", "class_name": "", "class_signature": ""}, "task_id": 164}
{"function_name": "call", "file_path": "dotenv/lib/dotenv/substitutions/variable.rb", "focal_code": "def call(value, env)\n          value.gsub(VARIABLE) do |variable|\n            match = $LAST_MATCH_INFO\n\n            if match[1] == \"\\\\\"\n              variable[1..]\n            elsif match[3]\n              env[match[3]] || ENV[match[3]] || \"\"\n            else\n              variable\n            end\n          end\n        end", "file_content": "require \"English\"\n\nmodule Dotenv\n  module Substitutions\n    # Substitute variables in a value.\n    #\n    #   HOST=example.com\n    #   URL=\"https://$HOST\"\n    #\n    module Variable\n      class << self\n        VARIABLE = /\n          (\\\\)?         # is it escaped with a backslash?\n          (\\$)          # literal $\n          (?!\\()        # shouldn't be followed by parenthesis\n          \\{?           # allow brace wrapping\n          ([A-Z0-9_]+)? # optional alpha nums\n          \\}?           # closing brace\n        /xi\n\n        def call(value, env)\n          value.gsub(VARIABLE) do |variable|\n            match = $LAST_MATCH_INFO\n\n            if match[1] == \"\\\\\"\n              variable[1..]\n            elsif match[3]\n              env[match[3]] || ENV[match[3]] || \"\"\n            else\n              variable\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(value, env)", "start_line": 21, "end_line": 33}, "metadata": {"module": "Dotenv", "class_name": "", "class_signature": ""}, "task_id": 165}
{"function_name": "dig", "file_path": "hashie/lib/hashie/array.rb", "focal_code": "def dig(*indexes)\n        converted_indexes = indexes.map do |idx|\n          begin\n            Integer(idx)\n          rescue ArgumentError\n            idx\n          end\n        end\n        super(*converted_indexes)\n      end", "file_content": "require 'hashie/extensions/array/pretty_inspect'\nrequire 'hashie/extensions/ruby_version_check'\n\nmodule Hashie\n  class Array < ::Array\n    include Hashie::Extensions::Array::PrettyInspect\n    include Hashie::Extensions::RubyVersionCheck\n    with_minimum_ruby('2.3.0') do\n      def dig(*indexes)\n        converted_indexes = indexes.map do |idx|\n          begin\n            Integer(idx)\n          rescue ArgumentError\n            idx\n          end\n        end\n        super(*converted_indexes)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "dig", "signature": "def dig(*indexes)", "start_line": 9, "end_line": 18}, "metadata": {"module": "Hashie", "class_name": "Array", "class_signature": "class Array < < ::Array"}, "task_id": 166}
{"function_name": "merge_store", "file_path": "hashie/lib/hashie/clash.rb", "focal_code": "def merge_store(key, *args) #:nodoc:\n      case args.length\n      when 1\n        val = args.first\n        val = self.class.new(self[key]).merge(val) if self[key].is_a?(::Hash) && val.is_a?(::Hash)\n      else\n        val = args\n      end\n\n      self[key.to_sym] = val\n      self\n    end", "file_content": "require 'hashie/hash'\n\nmodule Hashie\n  #\n  # A Clash is a \"Chainable Lazy Hash\". Inspired by libraries such as Arel,\n  # a Clash allows you to chain together method arguments to build a\n  # hash, something that's especially useful if you're doing something\n  # like constructing a complex options hash. Here's a basic example:\n  #\n  #     c = Hashie::Clash.new.conditions(:foo => 'bar').order(:created_at)\n  #     c # => {:conditions => {:foo => 'bar'}, :order => :created_at}\n  #\n  # Clash provides another way to create sub-hashes by using bang notation.\n  # You can dive into a sub-hash by providing a key with a bang and dive\n  # back out again with the _end! method. Example:\n  #\n  #     c = Hashie::Clash.new.conditions!.foo('bar').baz(123)._end!.order(:created_at)\n  #     c # => { conditions: { foo: 'bar', baz: 123 }, order: :created_at}\n  #\n  # Because the primary functionality of Clash is to build options objects,\n  # all keys are converted to symbols since many libraries expect symbols explicitly\n  # for keys.\n  #\n  class Clash < ::Hash\n    class ChainError < ::StandardError; end\n    # The parent Clash if this Clash was created via chaining.\n    attr_reader :_parent\n\n    # Initialize a new clash by passing in a Hash to\n    # convert and, optionally, the parent to which this\n    # Clash is chained.\n    def initialize(other_hash = {}, parent = nil)\n      @_parent = parent\n      other_hash.each_pair do |k, v|\n        self[k.to_sym] = v\n      end\n    end\n\n    # Jump back up a level if you are using bang method\n    # chaining. For example:\n    #\n    # c = Hashie::Clash.new.foo('bar')\n    # c.baz!.foo(123) # => c[:baz]\n    # c.baz!._end! # => c\n    def _end!\n      _parent\n    end\n\n    def id(*args) #:nodoc:\n      method_missing(:id, *args)\n    end\n\n    def merge_store(key, *args) #:nodoc:\n      case args.length\n      when 1\n        val = args.first\n        val = self.class.new(self[key]).merge(val) if self[key].is_a?(::Hash) && val.is_a?(::Hash)\n      else\n        val = args\n      end\n\n      self[key.to_sym] = val\n      self\n    end\n\n    def method_missing(name, *args) #:nodoc:\n      if args.empty? && name.to_s.end_with?('!')\n        key = name[0...-1].to_sym\n\n        case self[key]\n        when NilClass\n          self[key] = self.class.new({}, self)\n        when Clash\n          self[key]\n        when Hash\n          self[key] = self.class.new(self[key], self)\n        else\n          raise ChainError, 'Tried to chain into a non-hash key.'\n        end\n      elsif args.any?\n        merge_store(name, *args)\n      else\n        super\n      end\n    end\n\n    def respond_to_missing?(method_name, _include_private = false)\n      method_name = method_name.to_s\n\n      if method_name.end_with?('!')\n        key = method_name[0...-1].to_sym\n        [NilClass, Clash, Hash].include?(self[key].class)\n      else\n        true\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "merge_store", "signature": "def merge_store(key, *args) #:nodoc:", "start_line": 53, "end_line": 64}, "metadata": {"module": "Hashie", "class_name": "Clash", "class_signature": "class Clash < < ::Hash"}, "task_id": 167}
{"function_name": "method_missing", "file_path": "hashie/lib/hashie/clash.rb", "focal_code": "def method_missing(name, *args) #:nodoc:\n      if args.empty? && name.to_s.end_with?('!')\n        key = name[0...-1].to_sym\n\n        case self[key]\n        when NilClass\n          self[key] = self.class.new({}, self)\n        when Clash\n          self[key]\n        when Hash\n          self[key] = self.class.new(self[key], self)\n        else\n          raise ChainError, 'Tried to chain into a non-hash key.'\n        end\n      elsif args.any?\n        merge_store(name, *args)\n      else\n        super\n      end\n    end", "file_content": "require 'hashie/hash'\n\nmodule Hashie\n  #\n  # A Clash is a \"Chainable Lazy Hash\". Inspired by libraries such as Arel,\n  # a Clash allows you to chain together method arguments to build a\n  # hash, something that's especially useful if you're doing something\n  # like constructing a complex options hash. Here's a basic example:\n  #\n  #     c = Hashie::Clash.new.conditions(:foo => 'bar').order(:created_at)\n  #     c # => {:conditions => {:foo => 'bar'}, :order => :created_at}\n  #\n  # Clash provides another way to create sub-hashes by using bang notation.\n  # You can dive into a sub-hash by providing a key with a bang and dive\n  # back out again with the _end! method. Example:\n  #\n  #     c = Hashie::Clash.new.conditions!.foo('bar').baz(123)._end!.order(:created_at)\n  #     c # => { conditions: { foo: 'bar', baz: 123 }, order: :created_at}\n  #\n  # Because the primary functionality of Clash is to build options objects,\n  # all keys are converted to symbols since many libraries expect symbols explicitly\n  # for keys.\n  #\n  class Clash < ::Hash\n    class ChainError < ::StandardError; end\n    # The parent Clash if this Clash was created via chaining.\n    attr_reader :_parent\n\n    # Initialize a new clash by passing in a Hash to\n    # convert and, optionally, the parent to which this\n    # Clash is chained.\n    def initialize(other_hash = {}, parent = nil)\n      @_parent = parent\n      other_hash.each_pair do |k, v|\n        self[k.to_sym] = v\n      end\n    end\n\n    # Jump back up a level if you are using bang method\n    # chaining. For example:\n    #\n    # c = Hashie::Clash.new.foo('bar')\n    # c.baz!.foo(123) # => c[:baz]\n    # c.baz!._end! # => c\n    def _end!\n      _parent\n    end\n\n    def id(*args) #:nodoc:\n      method_missing(:id, *args)\n    end\n\n    def merge_store(key, *args) #:nodoc:\n      case args.length\n      when 1\n        val = args.first\n        val = self.class.new(self[key]).merge(val) if self[key].is_a?(::Hash) && val.is_a?(::Hash)\n      else\n        val = args\n      end\n\n      self[key.to_sym] = val\n      self\n    end\n\n    def method_missing(name, *args) #:nodoc:\n      if args.empty? && name.to_s.end_with?('!')\n        key = name[0...-1].to_sym\n\n        case self[key]\n        when NilClass\n          self[key] = self.class.new({}, self)\n        when Clash\n          self[key]\n        when Hash\n          self[key] = self.class.new(self[key], self)\n        else\n          raise ChainError, 'Tried to chain into a non-hash key.'\n        end\n      elsif args.any?\n        merge_store(name, *args)\n      else\n        super\n      end\n    end\n\n    def respond_to_missing?(method_name, _include_private = false)\n      method_name = method_name.to_s\n\n      if method_name.end_with?('!')\n        key = method_name[0...-1].to_sym\n        [NilClass, Clash, Hash].include?(self[key].class)\n      else\n        true\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, *args) #:nodoc:", "start_line": 66, "end_line": 85}, "metadata": {"module": "Hashie", "class_name": "Clash", "class_signature": "class Clash < < ::Hash"}, "task_id": 168}
{"function_name": "property", "file_path": "hashie/lib/hashie/dash.rb", "focal_code": "def self.property(property_name, options = {})\n      properties << property_name\n\n      if options.key?(:default)\n        defaults[property_name] = options[:default]\n      elsif defaults.key?(property_name)\n        defaults.delete property_name\n      end\n\n      define_getter_for(property_name)\n      define_setter_for(property_name)\n\n      @subclasses.each { |klass| klass.property(property_name, options) } if defined? @subclasses\n\n      condition = options.delete(:required)\n      if condition\n        message = options.delete(:message) || \"is required for #{name}.\"\n        required_properties[property_name] = { condition: condition, message: message }\n      elsif options.key?(:message)\n        raise ArgumentError, 'The :message option should be used with :required option.'\n      end\n    end", "file_content": "require 'hashie/hash'\nrequire 'set'\n\nmodule Hashie\n  # A Dash is a 'defined' or 'discrete' Hash, that is, a Hash\n  # that has a set of defined keys that are accessible (with\n  # optional defaults) and only those keys may be set or read.\n  #\n  # Dashes are useful when you need to create a very simple\n  # lightweight data object that needs even fewer options and\n  # resources than something like a DataMapper resource.\n  #\n  # It is preferable to a Struct because of the in-class\n  # API for defining properties as well as per-property defaults.\n  class Dash < Hash\n    include Hashie::Extensions::PrettyInspect\n\n    alias to_s inspect\n\n    # Defines a property on the Dash. Options are\n    # as follows:\n    #\n    # * <tt>:default</tt> - Specify a default value for this property,\n    #   to be returned before a value is set on the property in a new\n    #   Dash.\n    #\n    # * <tt>:required</tt> - Specify the value as required for this\n    #   property, to raise an error if a value is unset in a new or\n    #   existing Dash. If a Proc is provided, it will be run in the\n    #   context of the Dash instance. If a Symbol is provided, the\n    #   property it represents must not be nil. The property is only\n    #   required if the value is truthy.\n    #\n    # * <tt>:message</tt> - Specify custom error message for required property\n    #\n    def self.property(property_name, options = {})\n      properties << property_name\n\n      if options.key?(:default)\n        defaults[property_name] = options[:default]\n      elsif defaults.key?(property_name)\n        defaults.delete property_name\n      end\n\n      define_getter_for(property_name)\n      define_setter_for(property_name)\n\n      @subclasses.each { |klass| klass.property(property_name, options) } if defined? @subclasses\n\n      condition = options.delete(:required)\n      if condition\n        message = options.delete(:message) || \"is required for #{name}.\"\n        required_properties[property_name] = { condition: condition, message: message }\n      elsif options.key?(:message)\n        raise ArgumentError, 'The :message option should be used with :required option.'\n      end\n    end\n\n    class << self\n      attr_reader :properties, :defaults\n      attr_reader :getters\n      attr_reader :required_properties\n    end\n    instance_variable_set('@properties', Set.new)\n    instance_variable_set('@getters', Set.new)\n    instance_variable_set('@defaults', {})\n    instance_variable_set('@required_properties', {})\n\n    def self.inherited(klass)\n      super\n      (@subclasses ||= Set.new) << klass\n      klass.instance_variable_set('@properties', properties.dup)\n      klass.instance_variable_set('@getters', getters.dup)\n      klass.instance_variable_set('@defaults', defaults.dup)\n      klass.instance_variable_set('@required_properties', required_properties.dup)\n    end\n\n    # Check to see if the specified property has already been\n    # defined.\n    def self.property?(name)\n      properties.include? name\n    end\n\n    # Check to see if the specified property is\n    # required.\n    def self.required?(name)\n      required_properties.key? name\n    end\n\n    private_class_method def self.define_getter_for(property_name)\n      return if getters.include?(property_name)\n      define_method(property_name) { |&block| self.[](property_name, &block) }\n      getters << property_name\n    end\n\n    private_class_method def self.define_setter_for(property_name)\n      setter = :\"#{property_name}=\"\n      return if instance_methods.include?(setter)\n      define_method(setter) { |value| self.[]=(property_name, value) }\n    end\n\n    # You may initialize a Dash with an attributes hash\n    # just like you would many other kinds of data objects.\n    def initialize(attributes = {}, &block)\n      super(&block)\n\n      initialize_attributes(attributes)\n      assert_required_attributes_set!\n    end\n\n    alias _regular_reader []\n    alias _regular_writer []=\n    private :_regular_reader, :_regular_writer\n\n    # Retrieve a value from the Dash (will return the\n    # property's default value if it hasn't been set).\n    def [](property)\n      assert_property_exists! property\n      value = super(property)\n      # If the value is a lambda, proc, or whatever answers to call, eval the thing!\n      if value.is_a? Proc\n        self[property] = value.call # Set the result of the call as a value\n      else\n        yield value if block_given?\n        value\n      end\n    end\n\n    # Set a value on the Dash in a Hash-like way. Only works\n    # on pre-existing properties.\n    def []=(property, value)\n      assert_property_required! property, value\n      assert_property_exists! property\n      super(property, value)\n    end\n\n    def merge(other_hash)\n      new_dash = dup\n      other_hash.each do |k, v|\n        new_dash[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      new_dash\n    end\n\n    def merge!(other_hash)\n      other_hash.each do |k, v|\n        self[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      self\n    end\n\n    def replace(other_hash)\n      other_hash = self.class.defaults.merge(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def to_h\n      defaults = ::Hash[self.class.properties.map { |prop| [prop, self.class.defaults[prop]] }]\n\n      defaults.merge(self)\n    end\n    alias to_hash to_h\n\n    def update_attributes!(attributes)\n      update_attributes(attributes)\n\n      self.class.defaults.each_pair do |prop, value|\n        next unless fetch(prop, nil).nil?\n        self[prop] = begin\n          val = value.dup\n          if val.is_a?(Proc)\n            val.arity == 1 ? val.call(self) : val.call\n          else\n            val\n          end\n        rescue TypeError\n          value\n        end\n      end\n\n      assert_required_attributes_set!\n    end\n\n    private\n\n    def initialize_attributes(attributes)\n      return unless attributes\n\n      cleaned_attributes = attributes.reject { |_attr, value| value.nil? }\n      update_attributes!(cleaned_attributes)\n    end\n\n    def update_attributes(attributes)\n      return unless attributes\n\n      attributes.each_pair do |att, value|\n        self[att] = value\n      end\n    end\n\n    def assert_property_exists!(property)\n      fail_no_property_error!(property) unless self.class.property?(property)\n    end\n\n    def assert_required_attributes_set!\n      self.class.required_properties.each_key do |required_property|\n        assert_property_set!(required_property)\n      end\n    end\n\n    def assert_property_set!(property)\n      fail_property_required_error!(property) if send(property).nil? && required?(property)\n    end\n\n    def assert_property_required!(property, value)\n      fail_property_required_error!(property) if value.nil? && required?(property)\n    end\n\n    def fail_property_required_error!(property)\n      raise ArgumentError,\n            \"The property '#{property}' #{self.class.required_properties[property][:message]}\"\n    end\n\n    def fail_no_property_error!(property)\n      raise NoMethodError, \"The property '#{property}' is not defined for #{self.class.name}.\"\n    end\n\n    def required?(property)\n      return false unless self.class.required?(property)\n\n      condition = self.class.required_properties[property][:condition]\n      case condition\n      when Proc   then !!instance_exec(&condition)\n      when Symbol then !!send(condition)\n      else             !!condition\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "property", "signature": "def self.property(property_name, options = {})", "start_line": 36, "end_line": 57}, "metadata": {"module": "Hashie", "class_name": "Dash", "class_signature": "class Dash < < Hash"}, "task_id": 169}
{"function_name": "[]", "file_path": "hashie/lib/hashie/dash.rb", "focal_code": "def [](property)\n      assert_property_exists! property\n      value = super(property)\n      # If the value is a lambda, proc, or whatever answers to call, eval the thing!\n      if value.is_a? Proc\n        self[property] = value.call # Set the result of the call as a value\n      else\n        yield value if block_given?\n        value\n      end\n    end", "file_content": "require 'hashie/hash'\nrequire 'set'\n\nmodule Hashie\n  # A Dash is a 'defined' or 'discrete' Hash, that is, a Hash\n  # that has a set of defined keys that are accessible (with\n  # optional defaults) and only those keys may be set or read.\n  #\n  # Dashes are useful when you need to create a very simple\n  # lightweight data object that needs even fewer options and\n  # resources than something like a DataMapper resource.\n  #\n  # It is preferable to a Struct because of the in-class\n  # API for defining properties as well as per-property defaults.\n  class Dash < Hash\n    include Hashie::Extensions::PrettyInspect\n\n    alias to_s inspect\n\n    # Defines a property on the Dash. Options are\n    # as follows:\n    #\n    # * <tt>:default</tt> - Specify a default value for this property,\n    #   to be returned before a value is set on the property in a new\n    #   Dash.\n    #\n    # * <tt>:required</tt> - Specify the value as required for this\n    #   property, to raise an error if a value is unset in a new or\n    #   existing Dash. If a Proc is provided, it will be run in the\n    #   context of the Dash instance. If a Symbol is provided, the\n    #   property it represents must not be nil. The property is only\n    #   required if the value is truthy.\n    #\n    # * <tt>:message</tt> - Specify custom error message for required property\n    #\n    def self.property(property_name, options = {})\n      properties << property_name\n\n      if options.key?(:default)\n        defaults[property_name] = options[:default]\n      elsif defaults.key?(property_name)\n        defaults.delete property_name\n      end\n\n      define_getter_for(property_name)\n      define_setter_for(property_name)\n\n      @subclasses.each { |klass| klass.property(property_name, options) } if defined? @subclasses\n\n      condition = options.delete(:required)\n      if condition\n        message = options.delete(:message) || \"is required for #{name}.\"\n        required_properties[property_name] = { condition: condition, message: message }\n      elsif options.key?(:message)\n        raise ArgumentError, 'The :message option should be used with :required option.'\n      end\n    end\n\n    class << self\n      attr_reader :properties, :defaults\n      attr_reader :getters\n      attr_reader :required_properties\n    end\n    instance_variable_set('@properties', Set.new)\n    instance_variable_set('@getters', Set.new)\n    instance_variable_set('@defaults', {})\n    instance_variable_set('@required_properties', {})\n\n    def self.inherited(klass)\n      super\n      (@subclasses ||= Set.new) << klass\n      klass.instance_variable_set('@properties', properties.dup)\n      klass.instance_variable_set('@getters', getters.dup)\n      klass.instance_variable_set('@defaults', defaults.dup)\n      klass.instance_variable_set('@required_properties', required_properties.dup)\n    end\n\n    # Check to see if the specified property has already been\n    # defined.\n    def self.property?(name)\n      properties.include? name\n    end\n\n    # Check to see if the specified property is\n    # required.\n    def self.required?(name)\n      required_properties.key? name\n    end\n\n    private_class_method def self.define_getter_for(property_name)\n      return if getters.include?(property_name)\n      define_method(property_name) { |&block| self.[](property_name, &block) }\n      getters << property_name\n    end\n\n    private_class_method def self.define_setter_for(property_name)\n      setter = :\"#{property_name}=\"\n      return if instance_methods.include?(setter)\n      define_method(setter) { |value| self.[]=(property_name, value) }\n    end\n\n    # You may initialize a Dash with an attributes hash\n    # just like you would many other kinds of data objects.\n    def initialize(attributes = {}, &block)\n      super(&block)\n\n      initialize_attributes(attributes)\n      assert_required_attributes_set!\n    end\n\n    alias _regular_reader []\n    alias _regular_writer []=\n    private :_regular_reader, :_regular_writer\n\n    # Retrieve a value from the Dash (will return the\n    # property's default value if it hasn't been set).\n    def [](property)\n      assert_property_exists! property\n      value = super(property)\n      # If the value is a lambda, proc, or whatever answers to call, eval the thing!\n      if value.is_a? Proc\n        self[property] = value.call # Set the result of the call as a value\n      else\n        yield value if block_given?\n        value\n      end\n    end\n\n    # Set a value on the Dash in a Hash-like way. Only works\n    # on pre-existing properties.\n    def []=(property, value)\n      assert_property_required! property, value\n      assert_property_exists! property\n      super(property, value)\n    end\n\n    def merge(other_hash)\n      new_dash = dup\n      other_hash.each do |k, v|\n        new_dash[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      new_dash\n    end\n\n    def merge!(other_hash)\n      other_hash.each do |k, v|\n        self[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      self\n    end\n\n    def replace(other_hash)\n      other_hash = self.class.defaults.merge(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def to_h\n      defaults = ::Hash[self.class.properties.map { |prop| [prop, self.class.defaults[prop]] }]\n\n      defaults.merge(self)\n    end\n    alias to_hash to_h\n\n    def update_attributes!(attributes)\n      update_attributes(attributes)\n\n      self.class.defaults.each_pair do |prop, value|\n        next unless fetch(prop, nil).nil?\n        self[prop] = begin\n          val = value.dup\n          if val.is_a?(Proc)\n            val.arity == 1 ? val.call(self) : val.call\n          else\n            val\n          end\n        rescue TypeError\n          value\n        end\n      end\n\n      assert_required_attributes_set!\n    end\n\n    private\n\n    def initialize_attributes(attributes)\n      return unless attributes\n\n      cleaned_attributes = attributes.reject { |_attr, value| value.nil? }\n      update_attributes!(cleaned_attributes)\n    end\n\n    def update_attributes(attributes)\n      return unless attributes\n\n      attributes.each_pair do |att, value|\n        self[att] = value\n      end\n    end\n\n    def assert_property_exists!(property)\n      fail_no_property_error!(property) unless self.class.property?(property)\n    end\n\n    def assert_required_attributes_set!\n      self.class.required_properties.each_key do |required_property|\n        assert_property_set!(required_property)\n      end\n    end\n\n    def assert_property_set!(property)\n      fail_property_required_error!(property) if send(property).nil? && required?(property)\n    end\n\n    def assert_property_required!(property, value)\n      fail_property_required_error!(property) if value.nil? && required?(property)\n    end\n\n    def fail_property_required_error!(property)\n      raise ArgumentError,\n            \"The property '#{property}' #{self.class.required_properties[property][:message]}\"\n    end\n\n    def fail_no_property_error!(property)\n      raise NoMethodError, \"The property '#{property}' is not defined for #{self.class.name}.\"\n    end\n\n    def required?(property)\n      return false unless self.class.required?(property)\n\n      condition = self.class.required_properties[property][:condition]\n      case condition\n      when Proc   then !!instance_exec(&condition)\n      when Symbol then !!send(condition)\n      else             !!condition\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "[]", "signature": "def [](property)", "start_line": 117, "end_line": 127}, "metadata": {"module": "Hashie", "class_name": "Dash", "class_signature": "class Dash < < Hash"}, "task_id": 170}
{"function_name": "update_attributes!", "file_path": "hashie/lib/hashie/dash.rb", "focal_code": "def update_attributes!(attributes)\n      update_attributes(attributes)\n\n      self.class.defaults.each_pair do |prop, value|\n        next unless fetch(prop, nil).nil?\n        self[prop] = begin\n          val = value.dup\n          if val.is_a?(Proc)\n            val.arity == 1 ? val.call(self) : val.call\n          else\n            val\n          end\n        rescue TypeError\n          value\n        end\n      end\n\n      assert_required_attributes_set!\n    end", "file_content": "require 'hashie/hash'\nrequire 'set'\n\nmodule Hashie\n  # A Dash is a 'defined' or 'discrete' Hash, that is, a Hash\n  # that has a set of defined keys that are accessible (with\n  # optional defaults) and only those keys may be set or read.\n  #\n  # Dashes are useful when you need to create a very simple\n  # lightweight data object that needs even fewer options and\n  # resources than something like a DataMapper resource.\n  #\n  # It is preferable to a Struct because of the in-class\n  # API for defining properties as well as per-property defaults.\n  class Dash < Hash\n    include Hashie::Extensions::PrettyInspect\n\n    alias to_s inspect\n\n    # Defines a property on the Dash. Options are\n    # as follows:\n    #\n    # * <tt>:default</tt> - Specify a default value for this property,\n    #   to be returned before a value is set on the property in a new\n    #   Dash.\n    #\n    # * <tt>:required</tt> - Specify the value as required for this\n    #   property, to raise an error if a value is unset in a new or\n    #   existing Dash. If a Proc is provided, it will be run in the\n    #   context of the Dash instance. If a Symbol is provided, the\n    #   property it represents must not be nil. The property is only\n    #   required if the value is truthy.\n    #\n    # * <tt>:message</tt> - Specify custom error message for required property\n    #\n    def self.property(property_name, options = {})\n      properties << property_name\n\n      if options.key?(:default)\n        defaults[property_name] = options[:default]\n      elsif defaults.key?(property_name)\n        defaults.delete property_name\n      end\n\n      define_getter_for(property_name)\n      define_setter_for(property_name)\n\n      @subclasses.each { |klass| klass.property(property_name, options) } if defined? @subclasses\n\n      condition = options.delete(:required)\n      if condition\n        message = options.delete(:message) || \"is required for #{name}.\"\n        required_properties[property_name] = { condition: condition, message: message }\n      elsif options.key?(:message)\n        raise ArgumentError, 'The :message option should be used with :required option.'\n      end\n    end\n\n    class << self\n      attr_reader :properties, :defaults\n      attr_reader :getters\n      attr_reader :required_properties\n    end\n    instance_variable_set('@properties', Set.new)\n    instance_variable_set('@getters', Set.new)\n    instance_variable_set('@defaults', {})\n    instance_variable_set('@required_properties', {})\n\n    def self.inherited(klass)\n      super\n      (@subclasses ||= Set.new) << klass\n      klass.instance_variable_set('@properties', properties.dup)\n      klass.instance_variable_set('@getters', getters.dup)\n      klass.instance_variable_set('@defaults', defaults.dup)\n      klass.instance_variable_set('@required_properties', required_properties.dup)\n    end\n\n    # Check to see if the specified property has already been\n    # defined.\n    def self.property?(name)\n      properties.include? name\n    end\n\n    # Check to see if the specified property is\n    # required.\n    def self.required?(name)\n      required_properties.key? name\n    end\n\n    private_class_method def self.define_getter_for(property_name)\n      return if getters.include?(property_name)\n      define_method(property_name) { |&block| self.[](property_name, &block) }\n      getters << property_name\n    end\n\n    private_class_method def self.define_setter_for(property_name)\n      setter = :\"#{property_name}=\"\n      return if instance_methods.include?(setter)\n      define_method(setter) { |value| self.[]=(property_name, value) }\n    end\n\n    # You may initialize a Dash with an attributes hash\n    # just like you would many other kinds of data objects.\n    def initialize(attributes = {}, &block)\n      super(&block)\n\n      initialize_attributes(attributes)\n      assert_required_attributes_set!\n    end\n\n    alias _regular_reader []\n    alias _regular_writer []=\n    private :_regular_reader, :_regular_writer\n\n    # Retrieve a value from the Dash (will return the\n    # property's default value if it hasn't been set).\n    def [](property)\n      assert_property_exists! property\n      value = super(property)\n      # If the value is a lambda, proc, or whatever answers to call, eval the thing!\n      if value.is_a? Proc\n        self[property] = value.call # Set the result of the call as a value\n      else\n        yield value if block_given?\n        value\n      end\n    end\n\n    # Set a value on the Dash in a Hash-like way. Only works\n    # on pre-existing properties.\n    def []=(property, value)\n      assert_property_required! property, value\n      assert_property_exists! property\n      super(property, value)\n    end\n\n    def merge(other_hash)\n      new_dash = dup\n      other_hash.each do |k, v|\n        new_dash[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      new_dash\n    end\n\n    def merge!(other_hash)\n      other_hash.each do |k, v|\n        self[k] = block_given? ? yield(k, self[k], v) : v\n      end\n      self\n    end\n\n    def replace(other_hash)\n      other_hash = self.class.defaults.merge(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def to_h\n      defaults = ::Hash[self.class.properties.map { |prop| [prop, self.class.defaults[prop]] }]\n\n      defaults.merge(self)\n    end\n    alias to_hash to_h\n\n    def update_attributes!(attributes)\n      update_attributes(attributes)\n\n      self.class.defaults.each_pair do |prop, value|\n        next unless fetch(prop, nil).nil?\n        self[prop] = begin\n          val = value.dup\n          if val.is_a?(Proc)\n            val.arity == 1 ? val.call(self) : val.call\n          else\n            val\n          end\n        rescue TypeError\n          value\n        end\n      end\n\n      assert_required_attributes_set!\n    end\n\n    private\n\n    def initialize_attributes(attributes)\n      return unless attributes\n\n      cleaned_attributes = attributes.reject { |_attr, value| value.nil? }\n      update_attributes!(cleaned_attributes)\n    end\n\n    def update_attributes(attributes)\n      return unless attributes\n\n      attributes.each_pair do |att, value|\n        self[att] = value\n      end\n    end\n\n    def assert_property_exists!(property)\n      fail_no_property_error!(property) unless self.class.property?(property)\n    end\n\n    def assert_required_attributes_set!\n      self.class.required_properties.each_key do |required_property|\n        assert_property_set!(required_property)\n      end\n    end\n\n    def assert_property_set!(property)\n      fail_property_required_error!(property) if send(property).nil? && required?(property)\n    end\n\n    def assert_property_required!(property, value)\n      fail_property_required_error!(property) if value.nil? && required?(property)\n    end\n\n    def fail_property_required_error!(property)\n      raise ArgumentError,\n            \"The property '#{property}' #{self.class.required_properties[property][:message]}\"\n    end\n\n    def fail_no_property_error!(property)\n      raise NoMethodError, \"The property '#{property}' is not defined for #{self.class.name}.\"\n    end\n\n    def required?(property)\n      return false unless self.class.required?(property)\n\n      condition = self.class.required_properties[property][:condition]\n      case condition\n      when Proc   then !!instance_exec(&condition)\n      when Symbol then !!send(condition)\n      else             !!condition\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "update_attributes!", "signature": "def update_attributes!(attributes)", "start_line": 166, "end_line": 184}, "metadata": {"module": "Hashie", "class_name": "Dash", "class_signature": "class Dash < < Hash"}, "task_id": 171}
{"function_name": "to_hash", "file_path": "hashie/lib/hashie/hash.rb", "focal_code": "def to_hash(options = {})\n      out = {}\n      each_key do |k|\n        assignment_key =\n          if options[:stringify_keys]\n            k.to_s\n          elsif options[:symbolize_keys] && k.respond_to?(:to_sym)\n            k.to_sym\n          else\n            k\n          end\n        if self[k].is_a?(Array)\n          out[assignment_key] ||= []\n          self[k].each do |array_object|\n            out[assignment_key] << maybe_convert_to_hash(array_object, options)\n          end\n        else\n          out[assignment_key] = maybe_convert_to_hash(self[k], options)\n        end\n      end\n      out\n    end", "file_content": "require 'hashie/extensions/stringify_keys'\nrequire 'hashie/extensions/pretty_inspect'\n\nmodule Hashie\n  # A Hashie Hash is simply a Hash that has convenience\n  # functions baked in such as stringify_keys that may\n  # not be available in all libraries.\n  class Hash < ::Hash\n    include Hashie::Extensions::PrettyInspect\n    include Hashie::Extensions::StringifyKeys\n\n    # Convert this hash into a Mash\n    def to_mash\n      ::Hashie::Mash.new(self)\n    end\n\n    # Converts a mash back to a hash (with stringified or symbolized keys)\n    def to_hash(options = {})\n      out = {}\n      each_key do |k|\n        assignment_key =\n          if options[:stringify_keys]\n            k.to_s\n          elsif options[:symbolize_keys] && k.respond_to?(:to_sym)\n            k.to_sym\n          else\n            k\n          end\n        if self[k].is_a?(Array)\n          out[assignment_key] ||= []\n          self[k].each do |array_object|\n            out[assignment_key] << maybe_convert_to_hash(array_object, options)\n          end\n        else\n          out[assignment_key] = maybe_convert_to_hash(self[k], options)\n        end\n      end\n      out\n    end\n\n    # The C generator for the json gem doesn't like mashies\n    def to_json(*args)\n      to_hash.to_json(*args)\n    end\n\n    private\n\n    def maybe_convert_to_hash(object, options)\n      return object unless object.is_a?(Hash) || object.respond_to?(:to_hash)\n\n      flexibly_convert_to_hash(object, options)\n    end\n\n    def flexibly_convert_to_hash(object, options = {})\n      if object.method(:to_hash).arity.zero?\n        object.to_hash\n      else\n        object.to_hash(options)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "to_hash", "signature": "def to_hash(options = {})", "start_line": 18, "end_line": 39}, "metadata": {"module": "Hashie", "class_name": "Hash", "class_signature": "class Hash < < ::Hash"}, "task_id": 172}
{"function_name": "method_missing", "file_path": "hashie/lib/hashie/mash.rb", "focal_code": "def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing\n      return self.[](method_name, &blk) if key?(method_name)\n      name, suffix = method_name_and_suffix(method_name)\n      case suffix\n      when '='.freeze\n        assign_property(name, args.first)\n      when '?'.freeze\n        !!self[name]\n      when '!'.freeze\n        initializing_reader(name)\n      when '_'.freeze\n        underbang_reader(name)\n      else\n        self[method_name]\n      end\n    end", "file_content": "require 'hashie/hash'\nrequire 'hashie/array'\nrequire 'hashie/utils'\nrequire 'hashie/logger'\nrequire 'hashie/extensions/key_conflict_warning'\n\nmodule Hashie\n  # Mash allows you to create pseudo-objects that have method-like\n  # accessors for hash keys. This is useful for such implementations\n  # as an API-accessing library that wants to fake robust objects\n  # without the overhead of actually doing so. Think of it as OpenStruct\n  # with some additional goodies.\n  #\n  # A Mash will look at the methods you pass it and perform operations\n  # based on the following rules:\n  #\n  # * No punctuation: Returns the value of the hash for that key, or nil if none exists.\n  # * Assignment (<tt>=</tt>): Sets the attribute of the given method name.\n  # * Truthiness (<tt>?</tt>): Returns true or false depending on the truthiness of\n  #   the attribute, or false if the key is not set.\n  # * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it\n  #   as \"touch\" for mashes.\n  # * Under Bang (<tt>_</tt>): Like Bang, but returns a new Mash rather than creating a key.\n  #   Used to test existence in deep Mashes.\n  #\n  # == Basic Example\n  #\n  #   mash = Mash.new\n  #   mash.name? # => false\n  #   mash.name = \"Bob\"\n  #   mash.name # => \"Bob\"\n  #   mash.name? # => true\n  #\n  # == Hash Conversion  Example\n  #\n  #   hash = {:a => {:b => 23, :d => {:e => \"abc\"}}, :f => [{:g => 44, :h => 29}, 12]}\n  #   mash = Mash.new(hash)\n  #   mash.a.b # => 23\n  #   mash.a.d.e # => \"abc\"\n  #   mash.f.first.g # => 44\n  #   mash.f.last # => 12\n  #\n  # == Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author! # => <Mash>\n  #\n  #   mash = Mash.new\n  #   mash.author!.name = \"Michael Bleigh\"\n  #   mash.author # => <Mash name=\"Michael Bleigh\">\n  #\n  # == Under Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author_ # => <Mash>\n  #   mash.author_.name # => nil\n  #\n  #   mash = Mash.new\n  #   mash.author_.name = \"Michael Bleigh\"  (assigned to temp object)\n  #   mash.author # => <Mash>\n  #\n  class Mash < Hash\n    include Hashie::Extensions::RubyVersionCheck\n    extend Hashie::Extensions::KeyConflictWarning\n\n    ALLOWED_SUFFIXES = %w[? ! = _].freeze\n\n    def self.load(path, options = {})\n      @_mashes ||= new\n\n      return @_mashes[path] if @_mashes.key?(path)\n      raise ArgumentError, \"The following file doesn't exist: #{path}\" unless File.file?(path)\n\n      options = options.dup\n      parser = options.delete(:parser) { Hashie::Extensions::Parsers::YamlErbParser }\n      @_mashes[path] = new(parser.perform(path, options)).freeze\n    end\n\n    def to_module(mash_method_name = :settings)\n      mash = self\n      Module.new do |m|\n        m.send :define_method, mash_method_name.to_sym do\n          mash\n        end\n      end\n    end\n\n    def with_accessors!\n      extend Hashie::Extensions::Mash::DefineAccessors\n    end\n\n    alias to_s inspect\n\n    # If you pass in an existing hash, it will\n    # convert it to a Mash including recursively\n    # descending into arrays and hashes, converting\n    # them as well.\n    def initialize(source_hash = nil, default = nil, &blk)\n      deep_update(source_hash) if source_hash\n      default ? super(default) : super(&blk)\n    end\n\n    # Creates a new anonymous subclass with key conflict\n    # warnings disabled. You may pass an array of method\n    # symbols to restrict the disabled warnings to.\n    # Hashie::Mash.quiet.new(hash) all warnings disabled.\n    # Hashie::Mash.quiet(:zip).new(hash) only zip warning\n    # is disabled.\n    def self.quiet(*method_keys)\n      @memoized_classes ||= {}\n      @memoized_classes[method_keys] ||= Class.new(self) do\n        disable_warnings(*method_keys)\n      end\n    end\n\n    class << self; alias [] new; end\n\n    alias regular_reader []\n    alias regular_writer []=\n\n    # Retrieves an attribute set in the Mash. Will convert a key passed in\n    # as a symbol to a string before retrieving.\n    def custom_reader(key)\n      default_proc.call(self, key) if default_proc && !key?(key)\n      value = regular_reader(convert_key(key))\n      yield value if block_given?\n      value\n    end\n\n    # Sets an attribute in the Mash. Symbol keys will be converted to\n    # strings before being set, and Hashes will be converted into Mashes\n    # for nesting purposes.\n    def custom_writer(key, value, convert = true) #:nodoc:\n      log_built_in_message(key) if key.respond_to?(:to_sym) && log_collision?(key.to_sym)\n      regular_writer(convert_key(key), convert ? convert_value(value) : value)\n    end\n\n    alias [] custom_reader\n    alias []= custom_writer\n\n    # This is the bang method reader, it will return a new Mash\n    # if there isn't a value already assigned to the key requested.\n    def initializing_reader(key)\n      ck = convert_key(key)\n      regular_writer(ck, self.class.new) unless key?(ck)\n      regular_reader(ck)\n    end\n\n    # This is the under bang method reader, it will return a temporary new Mash\n    # if there isn't a value already assigned to the key requested.\n    def underbang_reader(key)\n      ck = convert_key(key)\n      if key?(ck)\n        regular_reader(ck)\n      else\n        self.class.new\n      end\n    end\n\n    def fetch(key, *args)\n      super(convert_key(key), *args)\n    end\n\n    def delete(key)\n      super(convert_key(key))\n    end\n\n    def values_at(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    # Returns a new instance of the class it was called on, using its keys as\n    # values, and its values as keys. The new values and keys will always be\n    # strings.\n    def invert\n      self.class.new(super)\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns false.\n    def reject(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns true.\n    def select(&blk)\n      self.class.new(super(&blk))\n    end\n\n    alias regular_dup dup\n    # Duplicates the current mash as a new mash.\n    def dup\n      self.class.new(self, default, &default_proc)\n    end\n\n    alias regular_key? key?\n    def key?(key)\n      super(convert_key(key))\n    end\n    alias has_key? key?\n    alias include? key?\n    alias member? key?\n\n    if with_minimum_ruby?('2.6.0')\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(*other_hashes, &blk)\n        dup.deep_update(*other_hashes, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(*other_hashes, &blk)\n        other_hashes.each do |other_hash|\n          _deep_update(other_hash, &blk)\n        end\n        self\n      end\n    else\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(other_hash, &blk)\n        dup.deep_update(other_hash, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(other_hash, &blk)\n        _deep_update(other_hash, &blk)\n        self\n      end\n    end\n\n    # Alias these lexically so they get the correctly defined\n    # #deep_merge and #deep_update based on ruby version.\n    alias merge deep_merge\n    alias deep_merge! deep_update\n    alias update deep_update\n    alias merge! update\n\n    def _deep_update(other_hash, &blk)\n      other_hash.each_pair do |k, v|\n        key = convert_key(k)\n        if v.is_a?(::Hash) && key?(key) && regular_reader(key).is_a?(Mash)\n          custom_reader(key).deep_update(v, &blk)\n        else\n          value = convert_value(v, true)\n          value = convert_value(yield(key, self[k], value), true) if blk && key?(k)\n          custom_writer(key, value, false)\n        end\n      end\n    end\n    private :_deep_update\n\n    # Assigns a value to a key\n    def assign_property(name, value)\n      self[name] = value\n    end\n\n    # Performs a shallow_update on a duplicate of the current mash\n    def shallow_merge(other_hash)\n      dup.shallow_update(other_hash)\n    end\n\n    # Merges (non-recursively) the hash from the argument,\n    # changing the receiving hash\n    def shallow_update(other_hash)\n      other_hash.each_pair do |k, v|\n        regular_writer(convert_key(k), convert_value(v, true))\n      end\n      self\n    end\n\n    def replace(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def respond_to_missing?(method_name, *args)\n      return true if key?(method_name)\n      suffix = method_suffix(method_name)\n      if suffix\n        true\n      else\n        super\n      end\n    end\n\n    def prefix_method?(method_name)\n      method_name = method_name.to_s\n      method_name.end_with?(*ALLOWED_SUFFIXES) && key?(method_name.chop)\n    end\n\n    def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing\n      return self.[](method_name, &blk) if key?(method_name)\n      name, suffix = method_name_and_suffix(method_name)\n      case suffix\n      when '='.freeze\n        assign_property(name, args.first)\n      when '?'.freeze\n        !!self[name]\n      when '!'.freeze\n        initializing_reader(name)\n      when '_'.freeze\n        underbang_reader(name)\n      else\n        self[method_name]\n      end\n    end\n\n    # play nice with ActiveSupport Array#extract_options!\n    def extractable_options?\n      true\n    end\n\n    # another ActiveSupport method, see issue #270\n    def reverse_merge(other_hash)\n      self.class.new(other_hash).merge(self)\n    end\n\n    def dig(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    def transform_values(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, with nil values\n    # removed.\n    def compact\n      self.class.new(super)\n    end\n\n    with_minimum_ruby('2.5.0') do\n      def slice(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n\n      def transform_keys(&blk)\n        self.class.new(super(&blk))\n      end\n    end\n\n    with_minimum_ruby('3.0.0') do\n      def except(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n    end\n\n    protected\n\n    def method_name_and_suffix(method_name)\n      method_name = method_name.to_s\n      if method_name.end_with?(*ALLOWED_SUFFIXES)\n        [method_name[0..-2], method_name[-1]]\n      else\n        [method_name[0..-1], nil]\n      end\n    end\n\n    def method_suffix(method_name)\n      method_name = method_name.to_s\n      method_name[-1] if method_name.end_with?(*ALLOWED_SUFFIXES)\n    end\n\n    def convert_key(key) #:nodoc:\n      key.respond_to?(:to_sym) ? key.to_s : key\n    end\n\n    def convert_value(val, duping = false) #:nodoc:\n      case val\n      when self.class\n        val.dup\n      when Hash\n        duping ? val.dup : val\n      when ::Hash\n        val = val.dup if duping\n        self.class.new(val)\n      when ::Array\n        Array.new(val.map { |e| convert_value(e) })\n      else\n        val\n      end\n    end\n\n    private\n\n    def log_built_in_message(method_key)\n      return if self.class.disable_warnings?(method_key)\n\n      method_information = Hashie::Utils.method_information(method(method_key))\n\n      Hashie.logger.warn(\n        'You are setting a key that conflicts with a built-in method ' \\\n        \"#{self.class}##{method_key} #{method_information}. \" \\\n        'This can cause unexpected behavior when accessing the key as a ' \\\n        'property. You can still access the key via the #[] method.'\n      )\n    end\n\n    def log_collision?(method_key)\n      return unless method_key.is_a?(String) || method_key.is_a?(Symbol)\n      return unless respond_to?(method_key)\n\n      _, suffix = method_name_and_suffix(method_key)\n\n      (!suffix || suffix == '='.freeze) &&\n        !self.class.disable_warnings?(method_key) &&\n        !(regular_key?(method_key) || regular_key?(method_key.to_s))\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing", "start_line": 298, "end_line": 313}, "metadata": {"module": "Hashie", "class_name": "Mash", "class_signature": "class Mash < < Hash"}, "task_id": 173}
{"function_name": "convert_value", "file_path": "hashie/lib/hashie/mash.rb", "focal_code": "def convert_value(val, duping = false) #:nodoc:\n      case val\n      when self.class\n        val.dup\n      when Hash\n        duping ? val.dup : val\n      when ::Hash\n        val = val.dup if duping\n        self.class.new(val)\n      when ::Array\n        Array.new(val.map { |e| convert_value(e) })\n      else\n        val\n      end\n    end", "file_content": "require 'hashie/hash'\nrequire 'hashie/array'\nrequire 'hashie/utils'\nrequire 'hashie/logger'\nrequire 'hashie/extensions/key_conflict_warning'\n\nmodule Hashie\n  # Mash allows you to create pseudo-objects that have method-like\n  # accessors for hash keys. This is useful for such implementations\n  # as an API-accessing library that wants to fake robust objects\n  # without the overhead of actually doing so. Think of it as OpenStruct\n  # with some additional goodies.\n  #\n  # A Mash will look at the methods you pass it and perform operations\n  # based on the following rules:\n  #\n  # * No punctuation: Returns the value of the hash for that key, or nil if none exists.\n  # * Assignment (<tt>=</tt>): Sets the attribute of the given method name.\n  # * Truthiness (<tt>?</tt>): Returns true or false depending on the truthiness of\n  #   the attribute, or false if the key is not set.\n  # * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it\n  #   as \"touch\" for mashes.\n  # * Under Bang (<tt>_</tt>): Like Bang, but returns a new Mash rather than creating a key.\n  #   Used to test existence in deep Mashes.\n  #\n  # == Basic Example\n  #\n  #   mash = Mash.new\n  #   mash.name? # => false\n  #   mash.name = \"Bob\"\n  #   mash.name # => \"Bob\"\n  #   mash.name? # => true\n  #\n  # == Hash Conversion  Example\n  #\n  #   hash = {:a => {:b => 23, :d => {:e => \"abc\"}}, :f => [{:g => 44, :h => 29}, 12]}\n  #   mash = Mash.new(hash)\n  #   mash.a.b # => 23\n  #   mash.a.d.e # => \"abc\"\n  #   mash.f.first.g # => 44\n  #   mash.f.last # => 12\n  #\n  # == Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author! # => <Mash>\n  #\n  #   mash = Mash.new\n  #   mash.author!.name = \"Michael Bleigh\"\n  #   mash.author # => <Mash name=\"Michael Bleigh\">\n  #\n  # == Under Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author_ # => <Mash>\n  #   mash.author_.name # => nil\n  #\n  #   mash = Mash.new\n  #   mash.author_.name = \"Michael Bleigh\"  (assigned to temp object)\n  #   mash.author # => <Mash>\n  #\n  class Mash < Hash\n    include Hashie::Extensions::RubyVersionCheck\n    extend Hashie::Extensions::KeyConflictWarning\n\n    ALLOWED_SUFFIXES = %w[? ! = _].freeze\n\n    def self.load(path, options = {})\n      @_mashes ||= new\n\n      return @_mashes[path] if @_mashes.key?(path)\n      raise ArgumentError, \"The following file doesn't exist: #{path}\" unless File.file?(path)\n\n      options = options.dup\n      parser = options.delete(:parser) { Hashie::Extensions::Parsers::YamlErbParser }\n      @_mashes[path] = new(parser.perform(path, options)).freeze\n    end\n\n    def to_module(mash_method_name = :settings)\n      mash = self\n      Module.new do |m|\n        m.send :define_method, mash_method_name.to_sym do\n          mash\n        end\n      end\n    end\n\n    def with_accessors!\n      extend Hashie::Extensions::Mash::DefineAccessors\n    end\n\n    alias to_s inspect\n\n    # If you pass in an existing hash, it will\n    # convert it to a Mash including recursively\n    # descending into arrays and hashes, converting\n    # them as well.\n    def initialize(source_hash = nil, default = nil, &blk)\n      deep_update(source_hash) if source_hash\n      default ? super(default) : super(&blk)\n    end\n\n    # Creates a new anonymous subclass with key conflict\n    # warnings disabled. You may pass an array of method\n    # symbols to restrict the disabled warnings to.\n    # Hashie::Mash.quiet.new(hash) all warnings disabled.\n    # Hashie::Mash.quiet(:zip).new(hash) only zip warning\n    # is disabled.\n    def self.quiet(*method_keys)\n      @memoized_classes ||= {}\n      @memoized_classes[method_keys] ||= Class.new(self) do\n        disable_warnings(*method_keys)\n      end\n    end\n\n    class << self; alias [] new; end\n\n    alias regular_reader []\n    alias regular_writer []=\n\n    # Retrieves an attribute set in the Mash. Will convert a key passed in\n    # as a symbol to a string before retrieving.\n    def custom_reader(key)\n      default_proc.call(self, key) if default_proc && !key?(key)\n      value = regular_reader(convert_key(key))\n      yield value if block_given?\n      value\n    end\n\n    # Sets an attribute in the Mash. Symbol keys will be converted to\n    # strings before being set, and Hashes will be converted into Mashes\n    # for nesting purposes.\n    def custom_writer(key, value, convert = true) #:nodoc:\n      log_built_in_message(key) if key.respond_to?(:to_sym) && log_collision?(key.to_sym)\n      regular_writer(convert_key(key), convert ? convert_value(value) : value)\n    end\n\n    alias [] custom_reader\n    alias []= custom_writer\n\n    # This is the bang method reader, it will return a new Mash\n    # if there isn't a value already assigned to the key requested.\n    def initializing_reader(key)\n      ck = convert_key(key)\n      regular_writer(ck, self.class.new) unless key?(ck)\n      regular_reader(ck)\n    end\n\n    # This is the under bang method reader, it will return a temporary new Mash\n    # if there isn't a value already assigned to the key requested.\n    def underbang_reader(key)\n      ck = convert_key(key)\n      if key?(ck)\n        regular_reader(ck)\n      else\n        self.class.new\n      end\n    end\n\n    def fetch(key, *args)\n      super(convert_key(key), *args)\n    end\n\n    def delete(key)\n      super(convert_key(key))\n    end\n\n    def values_at(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    # Returns a new instance of the class it was called on, using its keys as\n    # values, and its values as keys. The new values and keys will always be\n    # strings.\n    def invert\n      self.class.new(super)\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns false.\n    def reject(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns true.\n    def select(&blk)\n      self.class.new(super(&blk))\n    end\n\n    alias regular_dup dup\n    # Duplicates the current mash as a new mash.\n    def dup\n      self.class.new(self, default, &default_proc)\n    end\n\n    alias regular_key? key?\n    def key?(key)\n      super(convert_key(key))\n    end\n    alias has_key? key?\n    alias include? key?\n    alias member? key?\n\n    if with_minimum_ruby?('2.6.0')\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(*other_hashes, &blk)\n        dup.deep_update(*other_hashes, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(*other_hashes, &blk)\n        other_hashes.each do |other_hash|\n          _deep_update(other_hash, &blk)\n        end\n        self\n      end\n    else\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(other_hash, &blk)\n        dup.deep_update(other_hash, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(other_hash, &blk)\n        _deep_update(other_hash, &blk)\n        self\n      end\n    end\n\n    # Alias these lexically so they get the correctly defined\n    # #deep_merge and #deep_update based on ruby version.\n    alias merge deep_merge\n    alias deep_merge! deep_update\n    alias update deep_update\n    alias merge! update\n\n    def _deep_update(other_hash, &blk)\n      other_hash.each_pair do |k, v|\n        key = convert_key(k)\n        if v.is_a?(::Hash) && key?(key) && regular_reader(key).is_a?(Mash)\n          custom_reader(key).deep_update(v, &blk)\n        else\n          value = convert_value(v, true)\n          value = convert_value(yield(key, self[k], value), true) if blk && key?(k)\n          custom_writer(key, value, false)\n        end\n      end\n    end\n    private :_deep_update\n\n    # Assigns a value to a key\n    def assign_property(name, value)\n      self[name] = value\n    end\n\n    # Performs a shallow_update on a duplicate of the current mash\n    def shallow_merge(other_hash)\n      dup.shallow_update(other_hash)\n    end\n\n    # Merges (non-recursively) the hash from the argument,\n    # changing the receiving hash\n    def shallow_update(other_hash)\n      other_hash.each_pair do |k, v|\n        regular_writer(convert_key(k), convert_value(v, true))\n      end\n      self\n    end\n\n    def replace(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def respond_to_missing?(method_name, *args)\n      return true if key?(method_name)\n      suffix = method_suffix(method_name)\n      if suffix\n        true\n      else\n        super\n      end\n    end\n\n    def prefix_method?(method_name)\n      method_name = method_name.to_s\n      method_name.end_with?(*ALLOWED_SUFFIXES) && key?(method_name.chop)\n    end\n\n    def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing\n      return self.[](method_name, &blk) if key?(method_name)\n      name, suffix = method_name_and_suffix(method_name)\n      case suffix\n      when '='.freeze\n        assign_property(name, args.first)\n      when '?'.freeze\n        !!self[name]\n      when '!'.freeze\n        initializing_reader(name)\n      when '_'.freeze\n        underbang_reader(name)\n      else\n        self[method_name]\n      end\n    end\n\n    # play nice with ActiveSupport Array#extract_options!\n    def extractable_options?\n      true\n    end\n\n    # another ActiveSupport method, see issue #270\n    def reverse_merge(other_hash)\n      self.class.new(other_hash).merge(self)\n    end\n\n    def dig(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    def transform_values(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, with nil values\n    # removed.\n    def compact\n      self.class.new(super)\n    end\n\n    with_minimum_ruby('2.5.0') do\n      def slice(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n\n      def transform_keys(&blk)\n        self.class.new(super(&blk))\n      end\n    end\n\n    with_minimum_ruby('3.0.0') do\n      def except(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n    end\n\n    protected\n\n    def method_name_and_suffix(method_name)\n      method_name = method_name.to_s\n      if method_name.end_with?(*ALLOWED_SUFFIXES)\n        [method_name[0..-2], method_name[-1]]\n      else\n        [method_name[0..-1], nil]\n      end\n    end\n\n    def method_suffix(method_name)\n      method_name = method_name.to_s\n      method_name[-1] if method_name.end_with?(*ALLOWED_SUFFIXES)\n    end\n\n    def convert_key(key) #:nodoc:\n      key.respond_to?(:to_sym) ? key.to_s : key\n    end\n\n    def convert_value(val, duping = false) #:nodoc:\n      case val\n      when self.class\n        val.dup\n      when Hash\n        duping ? val.dup : val\n      when ::Hash\n        val = val.dup if duping\n        self.class.new(val)\n      when ::Array\n        Array.new(val.map { |e| convert_value(e) })\n      else\n        val\n      end\n    end\n\n    private\n\n    def log_built_in_message(method_key)\n      return if self.class.disable_warnings?(method_key)\n\n      method_information = Hashie::Utils.method_information(method(method_key))\n\n      Hashie.logger.warn(\n        'You are setting a key that conflicts with a built-in method ' \\\n        \"#{self.class}##{method_key} #{method_information}. \" \\\n        'This can cause unexpected behavior when accessing the key as a ' \\\n        'property. You can still access the key via the #[] method.'\n      )\n    end\n\n    def log_collision?(method_key)\n      return unless method_key.is_a?(String) || method_key.is_a?(Symbol)\n      return unless respond_to?(method_key)\n\n      _, suffix = method_name_and_suffix(method_key)\n\n      (!suffix || suffix == '='.freeze) &&\n        !self.class.disable_warnings?(method_key) &&\n        !(regular_key?(method_key) || regular_key?(method_key.to_s))\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "convert_value", "signature": "def convert_value(val, duping = false) #:nodoc:", "start_line": 377, "end_line": 391}, "metadata": {"module": "Hashie", "class_name": "Mash", "class_signature": "class Mash < < Hash"}, "task_id": 174}
{"function_name": "log_built_in_message", "file_path": "hashie/lib/hashie/mash.rb", "focal_code": "def log_built_in_message(method_key)\n      return if self.class.disable_warnings?(method_key)\n\n      method_information = Hashie::Utils.method_information(method(method_key))\n\n      Hashie.logger.warn(\n        'You are setting a key that conflicts with a built-in method ' \\\n        \"#{self.class}##{method_key} #{method_information}. \" \\\n        'This can cause unexpected behavior when accessing the key as a ' \\\n        'property. You can still access the key via the #[] method.'\n      )\n    end", "file_content": "require 'hashie/hash'\nrequire 'hashie/array'\nrequire 'hashie/utils'\nrequire 'hashie/logger'\nrequire 'hashie/extensions/key_conflict_warning'\n\nmodule Hashie\n  # Mash allows you to create pseudo-objects that have method-like\n  # accessors for hash keys. This is useful for such implementations\n  # as an API-accessing library that wants to fake robust objects\n  # without the overhead of actually doing so. Think of it as OpenStruct\n  # with some additional goodies.\n  #\n  # A Mash will look at the methods you pass it and perform operations\n  # based on the following rules:\n  #\n  # * No punctuation: Returns the value of the hash for that key, or nil if none exists.\n  # * Assignment (<tt>=</tt>): Sets the attribute of the given method name.\n  # * Truthiness (<tt>?</tt>): Returns true or false depending on the truthiness of\n  #   the attribute, or false if the key is not set.\n  # * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it\n  #   as \"touch\" for mashes.\n  # * Under Bang (<tt>_</tt>): Like Bang, but returns a new Mash rather than creating a key.\n  #   Used to test existence in deep Mashes.\n  #\n  # == Basic Example\n  #\n  #   mash = Mash.new\n  #   mash.name? # => false\n  #   mash.name = \"Bob\"\n  #   mash.name # => \"Bob\"\n  #   mash.name? # => true\n  #\n  # == Hash Conversion  Example\n  #\n  #   hash = {:a => {:b => 23, :d => {:e => \"abc\"}}, :f => [{:g => 44, :h => 29}, 12]}\n  #   mash = Mash.new(hash)\n  #   mash.a.b # => 23\n  #   mash.a.d.e # => \"abc\"\n  #   mash.f.first.g # => 44\n  #   mash.f.last # => 12\n  #\n  # == Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author! # => <Mash>\n  #\n  #   mash = Mash.new\n  #   mash.author!.name = \"Michael Bleigh\"\n  #   mash.author # => <Mash name=\"Michael Bleigh\">\n  #\n  # == Under Bang Example\n  #\n  #   mash = Mash.new\n  #   mash.author # => nil\n  #   mash.author_ # => <Mash>\n  #   mash.author_.name # => nil\n  #\n  #   mash = Mash.new\n  #   mash.author_.name = \"Michael Bleigh\"  (assigned to temp object)\n  #   mash.author # => <Mash>\n  #\n  class Mash < Hash\n    include Hashie::Extensions::RubyVersionCheck\n    extend Hashie::Extensions::KeyConflictWarning\n\n    ALLOWED_SUFFIXES = %w[? ! = _].freeze\n\n    def self.load(path, options = {})\n      @_mashes ||= new\n\n      return @_mashes[path] if @_mashes.key?(path)\n      raise ArgumentError, \"The following file doesn't exist: #{path}\" unless File.file?(path)\n\n      options = options.dup\n      parser = options.delete(:parser) { Hashie::Extensions::Parsers::YamlErbParser }\n      @_mashes[path] = new(parser.perform(path, options)).freeze\n    end\n\n    def to_module(mash_method_name = :settings)\n      mash = self\n      Module.new do |m|\n        m.send :define_method, mash_method_name.to_sym do\n          mash\n        end\n      end\n    end\n\n    def with_accessors!\n      extend Hashie::Extensions::Mash::DefineAccessors\n    end\n\n    alias to_s inspect\n\n    # If you pass in an existing hash, it will\n    # convert it to a Mash including recursively\n    # descending into arrays and hashes, converting\n    # them as well.\n    def initialize(source_hash = nil, default = nil, &blk)\n      deep_update(source_hash) if source_hash\n      default ? super(default) : super(&blk)\n    end\n\n    # Creates a new anonymous subclass with key conflict\n    # warnings disabled. You may pass an array of method\n    # symbols to restrict the disabled warnings to.\n    # Hashie::Mash.quiet.new(hash) all warnings disabled.\n    # Hashie::Mash.quiet(:zip).new(hash) only zip warning\n    # is disabled.\n    def self.quiet(*method_keys)\n      @memoized_classes ||= {}\n      @memoized_classes[method_keys] ||= Class.new(self) do\n        disable_warnings(*method_keys)\n      end\n    end\n\n    class << self; alias [] new; end\n\n    alias regular_reader []\n    alias regular_writer []=\n\n    # Retrieves an attribute set in the Mash. Will convert a key passed in\n    # as a symbol to a string before retrieving.\n    def custom_reader(key)\n      default_proc.call(self, key) if default_proc && !key?(key)\n      value = regular_reader(convert_key(key))\n      yield value if block_given?\n      value\n    end\n\n    # Sets an attribute in the Mash. Symbol keys will be converted to\n    # strings before being set, and Hashes will be converted into Mashes\n    # for nesting purposes.\n    def custom_writer(key, value, convert = true) #:nodoc:\n      log_built_in_message(key) if key.respond_to?(:to_sym) && log_collision?(key.to_sym)\n      regular_writer(convert_key(key), convert ? convert_value(value) : value)\n    end\n\n    alias [] custom_reader\n    alias []= custom_writer\n\n    # This is the bang method reader, it will return a new Mash\n    # if there isn't a value already assigned to the key requested.\n    def initializing_reader(key)\n      ck = convert_key(key)\n      regular_writer(ck, self.class.new) unless key?(ck)\n      regular_reader(ck)\n    end\n\n    # This is the under bang method reader, it will return a temporary new Mash\n    # if there isn't a value already assigned to the key requested.\n    def underbang_reader(key)\n      ck = convert_key(key)\n      if key?(ck)\n        regular_reader(ck)\n      else\n        self.class.new\n      end\n    end\n\n    def fetch(key, *args)\n      super(convert_key(key), *args)\n    end\n\n    def delete(key)\n      super(convert_key(key))\n    end\n\n    def values_at(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    # Returns a new instance of the class it was called on, using its keys as\n    # values, and its values as keys. The new values and keys will always be\n    # strings.\n    def invert\n      self.class.new(super)\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns false.\n    def reject(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, containing elements\n    # for which the given block returns true.\n    def select(&blk)\n      self.class.new(super(&blk))\n    end\n\n    alias regular_dup dup\n    # Duplicates the current mash as a new mash.\n    def dup\n      self.class.new(self, default, &default_proc)\n    end\n\n    alias regular_key? key?\n    def key?(key)\n      super(convert_key(key))\n    end\n    alias has_key? key?\n    alias include? key?\n    alias member? key?\n\n    if with_minimum_ruby?('2.6.0')\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(*other_hashes, &blk)\n        dup.deep_update(*other_hashes, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(*other_hashes, &blk)\n        other_hashes.each do |other_hash|\n          _deep_update(other_hash, &blk)\n        end\n        self\n      end\n    else\n      # Performs a deep_update on a duplicate of the\n      # current mash.\n      def deep_merge(other_hash, &blk)\n        dup.deep_update(other_hash, &blk)\n      end\n\n      # Recursively merges this mash with the passed\n      # in hash, merging each hash in the hierarchy.\n      def deep_update(other_hash, &blk)\n        _deep_update(other_hash, &blk)\n        self\n      end\n    end\n\n    # Alias these lexically so they get the correctly defined\n    # #deep_merge and #deep_update based on ruby version.\n    alias merge deep_merge\n    alias deep_merge! deep_update\n    alias update deep_update\n    alias merge! update\n\n    def _deep_update(other_hash, &blk)\n      other_hash.each_pair do |k, v|\n        key = convert_key(k)\n        if v.is_a?(::Hash) && key?(key) && regular_reader(key).is_a?(Mash)\n          custom_reader(key).deep_update(v, &blk)\n        else\n          value = convert_value(v, true)\n          value = convert_value(yield(key, self[k], value), true) if blk && key?(k)\n          custom_writer(key, value, false)\n        end\n      end\n    end\n    private :_deep_update\n\n    # Assigns a value to a key\n    def assign_property(name, value)\n      self[name] = value\n    end\n\n    # Performs a shallow_update on a duplicate of the current mash\n    def shallow_merge(other_hash)\n      dup.shallow_update(other_hash)\n    end\n\n    # Merges (non-recursively) the hash from the argument,\n    # changing the receiving hash\n    def shallow_update(other_hash)\n      other_hash.each_pair do |k, v|\n        regular_writer(convert_key(k), convert_value(v, true))\n      end\n      self\n    end\n\n    def replace(other_hash)\n      (keys - other_hash.keys).each { |key| delete(key) }\n      other_hash.each { |key, value| self[key] = value }\n      self\n    end\n\n    def respond_to_missing?(method_name, *args)\n      return true if key?(method_name)\n      suffix = method_suffix(method_name)\n      if suffix\n        true\n      else\n        super\n      end\n    end\n\n    def prefix_method?(method_name)\n      method_name = method_name.to_s\n      method_name.end_with?(*ALLOWED_SUFFIXES) && key?(method_name.chop)\n    end\n\n    def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing\n      return self.[](method_name, &blk) if key?(method_name)\n      name, suffix = method_name_and_suffix(method_name)\n      case suffix\n      when '='.freeze\n        assign_property(name, args.first)\n      when '?'.freeze\n        !!self[name]\n      when '!'.freeze\n        initializing_reader(name)\n      when '_'.freeze\n        underbang_reader(name)\n      else\n        self[method_name]\n      end\n    end\n\n    # play nice with ActiveSupport Array#extract_options!\n    def extractable_options?\n      true\n    end\n\n    # another ActiveSupport method, see issue #270\n    def reverse_merge(other_hash)\n      self.class.new(other_hash).merge(self)\n    end\n\n    def dig(*keys)\n      super(*keys.map { |key| convert_key(key) })\n    end\n\n    def transform_values(&blk)\n      self.class.new(super(&blk))\n    end\n\n    # Returns a new instance of the class it was called on, with nil values\n    # removed.\n    def compact\n      self.class.new(super)\n    end\n\n    with_minimum_ruby('2.5.0') do\n      def slice(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n\n      def transform_keys(&blk)\n        self.class.new(super(&blk))\n      end\n    end\n\n    with_minimum_ruby('3.0.0') do\n      def except(*keys)\n        string_keys = keys.map { |key| convert_key(key) }\n        self.class.new(super(*string_keys))\n      end\n    end\n\n    protected\n\n    def method_name_and_suffix(method_name)\n      method_name = method_name.to_s\n      if method_name.end_with?(*ALLOWED_SUFFIXES)\n        [method_name[0..-2], method_name[-1]]\n      else\n        [method_name[0..-1], nil]\n      end\n    end\n\n    def method_suffix(method_name)\n      method_name = method_name.to_s\n      method_name[-1] if method_name.end_with?(*ALLOWED_SUFFIXES)\n    end\n\n    def convert_key(key) #:nodoc:\n      key.respond_to?(:to_sym) ? key.to_s : key\n    end\n\n    def convert_value(val, duping = false) #:nodoc:\n      case val\n      when self.class\n        val.dup\n      when Hash\n        duping ? val.dup : val\n      when ::Hash\n        val = val.dup if duping\n        self.class.new(val)\n      when ::Array\n        Array.new(val.map { |e| convert_value(e) })\n      else\n        val\n      end\n    end\n\n    private\n\n    def log_built_in_message(method_key)\n      return if self.class.disable_warnings?(method_key)\n\n      method_information = Hashie::Utils.method_information(method(method_key))\n\n      Hashie.logger.warn(\n        'You are setting a key that conflicts with a built-in method ' \\\n        \"#{self.class}##{method_key} #{method_information}. \" \\\n        'This can cause unexpected behavior when accessing the key as a ' \\\n        'property. You can still access the key via the #[] method.'\n      )\n    end\n\n    def log_collision?(method_key)\n      return unless method_key.is_a?(String) || method_key.is_a?(Symbol)\n      return unless respond_to?(method_key)\n\n      _, suffix = method_name_and_suffix(method_key)\n\n      (!suffix || suffix == '='.freeze) &&\n        !self.class.disable_warnings?(method_key) &&\n        !(regular_key?(method_key) || regular_key?(method_key.to_s))\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "log_built_in_message", "signature": "def log_built_in_message(method_key)", "start_line": 395, "end_line": 406}, "metadata": {"module": "Hashie", "class_name": "Mash", "class_signature": "class Mash < < Hash"}, "task_id": 175}
{"function_name": "fetch", "file_path": "hashie/lib/hashie/rash.rb", "focal_code": "def fetch(*args)\n      raise ArgumentError, \"Expected 1-2 arguments, got #{args.length}\" \\\n        unless (1..2).cover?(args.length)\n\n      key, default = args\n\n      all(key) do |value|\n        return value\n      end\n\n      if block_given?\n        yield key\n      elsif default\n        default\n      else\n        raise KeyError, \"key not found: #{key.inspect}\"\n      end\n    end", "file_content": "module Hashie\n  #\n  # Rash is a Hash whose keys can be Regexps, or Ranges, which will\n  # match many input keys.\n  #\n  # A good use case for this class is routing URLs in a web framework.\n  # The Rash's keys match URL patterns, and the values specify actions\n  # which can handle the URL. When the Rash's value is proc, the proc\n  # will be automatically called with the regexp's matched groups as\n  # block arguments.\n  #\n  # Usage example:\n  #\n  #     greeting = Hashie::Rash.new( /^Mr./ => \"Hello sir!\", /^Mrs./ => \"Evening, madame.\" )\n  #     greeting[\"Mr. Steve Austin\"] #=> \"Hello sir!\"\n  #     greeting[\"Mrs. Steve Austin\"] #=> \"Evening, madame.\"\n  #\n  # Note: The Rash is automatically optimized every 500 accesses\n  #       (Regexps get sorted by how often they get matched).\n  #       If this is too low or too high, you can tune it by\n  #       setting: `rash.optimize_every = n`\n  #\n  class Rash\n    attr_accessor :optimize_every\n\n    def initialize(initial = {})\n      @hash           = {}\n      @regexes        = []\n      @ranges         = []\n      @regex_counts   = Hash.new(0)\n      @optimize_every = 500\n      @lookups        = 0\n\n      update(initial)\n    end\n\n    def update(other)\n      other.each do |key, value|\n        self[key] = value\n      end\n\n      self\n    end\n\n    def []=(key, value)\n      case key\n      when Regexp\n        # key = normalize_regex(key)  # this used to just do: /#{regexp}/\n        @regexes << key\n      when Range\n        @ranges << key\n      end\n      @hash[key] = value\n    end\n\n    #\n    # Return the first thing that matches the key.\n    #\n    def [](key)\n      all(key).first\n    end\n\n    #\n    # Raise (or yield) unless something matches the key.\n    #\n    def fetch(*args)\n      raise ArgumentError, \"Expected 1-2 arguments, got #{args.length}\" \\\n        unless (1..2).cover?(args.length)\n\n      key, default = args\n\n      all(key) do |value|\n        return value\n      end\n\n      if block_given?\n        yield key\n      elsif default\n        default\n      else\n        raise KeyError, \"key not found: #{key.inspect}\"\n      end\n    end\n\n    #\n    # Return everything that matches the query.\n    #\n    def all(query)\n      return to_enum(:all, query) unless block_given?\n\n      if @hash.include? query\n        yield @hash[query]\n        return\n      end\n\n      case query\n      when String\n        optimize_if_necessary!\n\n        # see if any of the regexps match the string\n        @regexes.each do |regex|\n          match = regex.match(query)\n          next unless match\n          @regex_counts[regex] += 1\n          value = @hash[regex]\n          if value.respond_to? :call\n            yield value.call(match)\n          else\n            yield value\n          end\n        end\n\n      when Numeric\n        # see if any of the ranges match the integer\n        @ranges.each do |range|\n          yield @hash[range] if range.cover? query\n        end\n\n      when Regexp\n        # Reverse operation: `rash[/regexp/]` returns all string keys matching the regexp\n        @hash.each do |key, val|\n          yield val if key.is_a?(String) && query =~ key\n        end\n      end\n    end\n\n    def method_missing(*args, &block)\n      @hash.send(*args, &block) || super\n    end\n\n    def respond_to_missing?(method_name, _include_private = false)\n      @hash.respond_to?(method_name)\n    end\n\n    private\n\n    def optimize_if_necessary!\n      return unless (@lookups += 1) >= @optimize_every\n      @regexes = @regexes.sort_by { |regex| -@regex_counts[regex] }\n      @lookups = 0\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "fetch", "signature": "def fetch(*args)", "start_line": 66, "end_line": 83}, "metadata": {"module": "Hashie", "class_name": "Rash", "class_signature": "class Rash"}, "task_id": 176}
{"function_name": "all", "file_path": "hashie/lib/hashie/rash.rb", "focal_code": "def all(query)\n      return to_enum(:all, query) unless block_given?\n\n      if @hash.include? query\n        yield @hash[query]\n        return\n      end\n\n      case query\n      when String\n        optimize_if_necessary!\n\n        # see if any of the regexps match the string\n        @regexes.each do |regex|\n          match = regex.match(query)\n          next unless match\n          @regex_counts[regex] += 1\n          value = @hash[regex]\n          if value.respond_to? :call\n            yield value.call(match)\n          else\n            yield value\n          end\n        end\n\n      when Numeric\n        # see if any of the ranges match the integer\n        @ranges.each do |range|\n          yield @hash[range] if range.cover? query\n        end\n\n      when Regexp\n        # Reverse operation: `rash[/regexp/]` returns all string keys matching the regexp\n        @hash.each do |key, val|\n          yield val if key.is_a?(String) && query =~ key\n        end\n      end\n    end", "file_content": "module Hashie\n  #\n  # Rash is a Hash whose keys can be Regexps, or Ranges, which will\n  # match many input keys.\n  #\n  # A good use case for this class is routing URLs in a web framework.\n  # The Rash's keys match URL patterns, and the values specify actions\n  # which can handle the URL. When the Rash's value is proc, the proc\n  # will be automatically called with the regexp's matched groups as\n  # block arguments.\n  #\n  # Usage example:\n  #\n  #     greeting = Hashie::Rash.new( /^Mr./ => \"Hello sir!\", /^Mrs./ => \"Evening, madame.\" )\n  #     greeting[\"Mr. Steve Austin\"] #=> \"Hello sir!\"\n  #     greeting[\"Mrs. Steve Austin\"] #=> \"Evening, madame.\"\n  #\n  # Note: The Rash is automatically optimized every 500 accesses\n  #       (Regexps get sorted by how often they get matched).\n  #       If this is too low or too high, you can tune it by\n  #       setting: `rash.optimize_every = n`\n  #\n  class Rash\n    attr_accessor :optimize_every\n\n    def initialize(initial = {})\n      @hash           = {}\n      @regexes        = []\n      @ranges         = []\n      @regex_counts   = Hash.new(0)\n      @optimize_every = 500\n      @lookups        = 0\n\n      update(initial)\n    end\n\n    def update(other)\n      other.each do |key, value|\n        self[key] = value\n      end\n\n      self\n    end\n\n    def []=(key, value)\n      case key\n      when Regexp\n        # key = normalize_regex(key)  # this used to just do: /#{regexp}/\n        @regexes << key\n      when Range\n        @ranges << key\n      end\n      @hash[key] = value\n    end\n\n    #\n    # Return the first thing that matches the key.\n    #\n    def [](key)\n      all(key).first\n    end\n\n    #\n    # Raise (or yield) unless something matches the key.\n    #\n    def fetch(*args)\n      raise ArgumentError, \"Expected 1-2 arguments, got #{args.length}\" \\\n        unless (1..2).cover?(args.length)\n\n      key, default = args\n\n      all(key) do |value|\n        return value\n      end\n\n      if block_given?\n        yield key\n      elsif default\n        default\n      else\n        raise KeyError, \"key not found: #{key.inspect}\"\n      end\n    end\n\n    #\n    # Return everything that matches the query.\n    #\n    def all(query)\n      return to_enum(:all, query) unless block_given?\n\n      if @hash.include? query\n        yield @hash[query]\n        return\n      end\n\n      case query\n      when String\n        optimize_if_necessary!\n\n        # see if any of the regexps match the string\n        @regexes.each do |regex|\n          match = regex.match(query)\n          next unless match\n          @regex_counts[regex] += 1\n          value = @hash[regex]\n          if value.respond_to? :call\n            yield value.call(match)\n          else\n            yield value\n          end\n        end\n\n      when Numeric\n        # see if any of the ranges match the integer\n        @ranges.each do |range|\n          yield @hash[range] if range.cover? query\n        end\n\n      when Regexp\n        # Reverse operation: `rash[/regexp/]` returns all string keys matching the regexp\n        @hash.each do |key, val|\n          yield val if key.is_a?(String) && query =~ key\n        end\n      end\n    end\n\n    def method_missing(*args, &block)\n      @hash.send(*args, &block) || super\n    end\n\n    def respond_to_missing?(method_name, _include_private = false)\n      @hash.respond_to?(method_name)\n    end\n\n    private\n\n    def optimize_if_necessary!\n      return unless (@lookups += 1) >= @optimize_every\n      @regexes = @regexes.sort_by { |regex| -@regex_counts[regex] }\n      @lookups = 0\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "all", "signature": "def all(query)", "start_line": 88, "end_line": 125}, "metadata": {"module": "Hashie", "class_name": "Rash", "class_signature": "class Rash"}, "task_id": 177}
{"function_name": "set_value_with_coercion", "file_path": "hashie/lib/hashie/extensions/coercion.rb", "focal_code": "def set_value_with_coercion(key, value)\n          into = self.class.key_coercion(key) || self.class.value_coercion(value)\n\n          unless value.nil? || into.nil?\n            begin\n              value = self.class.fetch_coercion(into).call(value)\n            rescue NoMethodError, TypeError => e\n              raise CoercionError.new(key, value, into, e.message)\n            end\n          end\n\n          set_value_without_coercion(key, value)\n        end", "file_content": "module Hashie\n  class CoercionError < StandardError\n    def initialize(key, value, into, message)\n      super(\"Cannot coerce property #{key.inspect} from #{value.class} to #{into}: #{message}\")\n    end\n  end\n\n  module Extensions\n    module Coercion\n      CORE_TYPES = {\n        Integer    => :to_i,\n        Float      => :to_f,\n        Complex    => :to_c,\n        Rational   => :to_r,\n        String     => :to_s,\n        Symbol     => :to_sym\n      }.freeze\n\n      ABSTRACT_CORE_TYPES =\n        { Numeric => [Integer, Float, Complex, Rational] }\n\n      def self.included(base)\n        base.send :include, InstanceMethods\n        base.extend ClassMethods\n        unless base.method_defined?(:set_value_without_coercion)\n          base.send :alias_method, :set_value_without_coercion, :[]=\n        end\n        base.send :alias_method, :[]=, :set_value_with_coercion\n      end\n\n      module InstanceMethods\n        def set_value_with_coercion(key, value)\n          into = self.class.key_coercion(key) || self.class.value_coercion(value)\n\n          unless value.nil? || into.nil?\n            begin\n              value = self.class.fetch_coercion(into).call(value)\n            rescue NoMethodError, TypeError => e\n              raise CoercionError.new(key, value, into, e.message)\n            end\n          end\n\n          set_value_without_coercion(key, value)\n        end\n\n        def custom_writer(key, value, _convert = true)\n          self[key] = value\n        end\n\n        def replace(other_hash)\n          (keys - other_hash.keys).each { |key| delete(key) }\n          other_hash.each { |key, value| self[key] = value }\n          self\n        end\n      end\n\n      module ClassMethods\n        attr_writer :key_coercions\n        protected :key_coercions=\n\n        # Set up a coercion rule such that any time the specified\n        # key is set it will be coerced into the specified class.\n        # Coercion will occur by first attempting to call Class.coerce\n        # and then by calling Class.new with the value as an argument\n        # in either case.\n        #\n        # @param [Object] key the key or array of keys you would like to be coerced.\n        # @param [Class] into the class into which you want the key(s) coerced.\n        #\n        # @example Coerce a \"user\" subhash into a User object\n        #   class Tweet < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_key :user, User\n        #   end\n        def coerce_key(*attrs)\n          into = attrs.pop\n          attrs.each { |key| key_coercions[key] = into }\n        end\n\n        alias coerce_keys coerce_key\n\n        # Returns a hash of any existing key coercions.\n        def key_coercions\n          @key_coercions ||= {}\n        end\n\n        # Returns the specific key coercion for the specified key,\n        # if one exists.\n        def key_coercion(key)\n          key_coercions[key.to_sym]\n        end\n\n        # Set up a coercion rule such that any time a value of the\n        # specified type is set it will be coerced into the specified\n        # class.\n        #\n        # @param [Class] from the type you would like coerced.\n        # @param [Class] into the class into which you would like the value coerced.\n        # @option options [Boolean] :strict (true) whether use exact source class\n        #   only or include ancestors\n        #\n        # @example Coerce all hashes into this special type of hash\n        #   class SpecialHash < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_value Hash, SpecialHash\n        #\n        #     def initialize(hash = {})\n        #       super\n        #       hash.each_pair do |k,v|\n        #         self[k] = v\n        #       end\n        #     end\n        #   end\n        def coerce_value(from, into, options = {})\n          options = { strict: true }.merge(options)\n\n          if ABSTRACT_CORE_TYPES.key? from\n            ABSTRACT_CORE_TYPES[from].each do |type|\n              coerce_value type, into, options\n            end\n          end\n\n          if options[:strict]\n            strict_value_coercions[from] = into\n          else\n            while from.superclass && from.superclass != Object\n              lenient_value_coercions[from] = into\n              from = from.superclass\n            end\n          end\n        end\n\n        # Return all value coercions that have the :strict rule as true.\n        def strict_value_coercions\n          @strict_value_coercions ||= {}\n        end\n\n        # Return all value coercions that have the :strict rule as false.\n        def lenient_value_coercions\n          @lenient_value_coercions ||= {}\n        end\n\n        # Fetch the value coercion, if any, for the specified object.\n        def value_coercion(value)\n          from = value.class\n          strict_value_coercions[from] || lenient_value_coercions[from]\n        end\n\n        def fetch_coercion(type)\n          return type if type.is_a? Proc\n          coercion_cache[type]\n        end\n\n        def coercion_cache\n          @coercion_cache ||= ::Hash.new do |hash, type|\n            hash[type] = build_coercion(type)\n          end\n        end\n\n        def build_coercion(type)\n          if type.is_a? Enumerable\n            if type.class == ::Hash\n              type, key_type, value_type = type.class, *type.first\n              build_hash_coercion(type, key_type, value_type)\n            else\n              value_type = type.first\n              type = type.class\n              build_container_coercion(type, value_type)\n            end\n          elsif CORE_TYPES.key? type\n            build_core_type_coercion(type)\n          elsif type.respond_to? :coerce\n            lambda do |value|\n              return value if value.is_a? type\n              type.coerce(value)\n            end\n          elsif type.respond_to? :new\n            lambda do |value|\n              return value if value.is_a? type\n              type.new(value)\n            end\n          else\n            raise TypeError, \"#{type} is not a coercable type\"\n          end\n        end\n\n        def build_hash_coercion(type, key_type, value_type)\n          key_coerce = fetch_coercion(key_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type[value.map { |k, v| [key_coerce.call(k), value_coerce.call(v)] }]\n          end\n        end\n\n        def build_container_coercion(type, value_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type.new(value.map { |v| value_coerce.call(v) })\n          end\n        end\n\n        def build_core_type_coercion(type)\n          name = CORE_TYPES[type]\n          lambda do |value|\n            return value if value.is_a? type\n            return value.send(name)\n          end\n        end\n\n        def inherited(klass)\n          super\n\n          klass.key_coercions = key_coercions.dup\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "set_value_with_coercion", "signature": "def set_value_with_coercion(key, value)", "start_line": 32, "end_line": 44}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 178}
{"function_name": "coerce_value", "file_path": "hashie/lib/hashie/extensions/coercion.rb", "focal_code": "def coerce_value(from, into, options = {})\n          options = { strict: true }.merge(options)\n\n          if ABSTRACT_CORE_TYPES.key? from\n            ABSTRACT_CORE_TYPES[from].each do |type|\n              coerce_value type, into, options\n            end\n          end\n\n          if options[:strict]\n            strict_value_coercions[from] = into\n          else\n            while from.superclass && from.superclass != Object\n              lenient_value_coercions[from] = into\n              from = from.superclass\n            end\n          end\n        end", "file_content": "module Hashie\n  class CoercionError < StandardError\n    def initialize(key, value, into, message)\n      super(\"Cannot coerce property #{key.inspect} from #{value.class} to #{into}: #{message}\")\n    end\n  end\n\n  module Extensions\n    module Coercion\n      CORE_TYPES = {\n        Integer    => :to_i,\n        Float      => :to_f,\n        Complex    => :to_c,\n        Rational   => :to_r,\n        String     => :to_s,\n        Symbol     => :to_sym\n      }.freeze\n\n      ABSTRACT_CORE_TYPES =\n        { Numeric => [Integer, Float, Complex, Rational] }\n\n      def self.included(base)\n        base.send :include, InstanceMethods\n        base.extend ClassMethods\n        unless base.method_defined?(:set_value_without_coercion)\n          base.send :alias_method, :set_value_without_coercion, :[]=\n        end\n        base.send :alias_method, :[]=, :set_value_with_coercion\n      end\n\n      module InstanceMethods\n        def set_value_with_coercion(key, value)\n          into = self.class.key_coercion(key) || self.class.value_coercion(value)\n\n          unless value.nil? || into.nil?\n            begin\n              value = self.class.fetch_coercion(into).call(value)\n            rescue NoMethodError, TypeError => e\n              raise CoercionError.new(key, value, into, e.message)\n            end\n          end\n\n          set_value_without_coercion(key, value)\n        end\n\n        def custom_writer(key, value, _convert = true)\n          self[key] = value\n        end\n\n        def replace(other_hash)\n          (keys - other_hash.keys).each { |key| delete(key) }\n          other_hash.each { |key, value| self[key] = value }\n          self\n        end\n      end\n\n      module ClassMethods\n        attr_writer :key_coercions\n        protected :key_coercions=\n\n        # Set up a coercion rule such that any time the specified\n        # key is set it will be coerced into the specified class.\n        # Coercion will occur by first attempting to call Class.coerce\n        # and then by calling Class.new with the value as an argument\n        # in either case.\n        #\n        # @param [Object] key the key or array of keys you would like to be coerced.\n        # @param [Class] into the class into which you want the key(s) coerced.\n        #\n        # @example Coerce a \"user\" subhash into a User object\n        #   class Tweet < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_key :user, User\n        #   end\n        def coerce_key(*attrs)\n          into = attrs.pop\n          attrs.each { |key| key_coercions[key] = into }\n        end\n\n        alias coerce_keys coerce_key\n\n        # Returns a hash of any existing key coercions.\n        def key_coercions\n          @key_coercions ||= {}\n        end\n\n        # Returns the specific key coercion for the specified key,\n        # if one exists.\n        def key_coercion(key)\n          key_coercions[key.to_sym]\n        end\n\n        # Set up a coercion rule such that any time a value of the\n        # specified type is set it will be coerced into the specified\n        # class.\n        #\n        # @param [Class] from the type you would like coerced.\n        # @param [Class] into the class into which you would like the value coerced.\n        # @option options [Boolean] :strict (true) whether use exact source class\n        #   only or include ancestors\n        #\n        # @example Coerce all hashes into this special type of hash\n        #   class SpecialHash < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_value Hash, SpecialHash\n        #\n        #     def initialize(hash = {})\n        #       super\n        #       hash.each_pair do |k,v|\n        #         self[k] = v\n        #       end\n        #     end\n        #   end\n        def coerce_value(from, into, options = {})\n          options = { strict: true }.merge(options)\n\n          if ABSTRACT_CORE_TYPES.key? from\n            ABSTRACT_CORE_TYPES[from].each do |type|\n              coerce_value type, into, options\n            end\n          end\n\n          if options[:strict]\n            strict_value_coercions[from] = into\n          else\n            while from.superclass && from.superclass != Object\n              lenient_value_coercions[from] = into\n              from = from.superclass\n            end\n          end\n        end\n\n        # Return all value coercions that have the :strict rule as true.\n        def strict_value_coercions\n          @strict_value_coercions ||= {}\n        end\n\n        # Return all value coercions that have the :strict rule as false.\n        def lenient_value_coercions\n          @lenient_value_coercions ||= {}\n        end\n\n        # Fetch the value coercion, if any, for the specified object.\n        def value_coercion(value)\n          from = value.class\n          strict_value_coercions[from] || lenient_value_coercions[from]\n        end\n\n        def fetch_coercion(type)\n          return type if type.is_a? Proc\n          coercion_cache[type]\n        end\n\n        def coercion_cache\n          @coercion_cache ||= ::Hash.new do |hash, type|\n            hash[type] = build_coercion(type)\n          end\n        end\n\n        def build_coercion(type)\n          if type.is_a? Enumerable\n            if type.class == ::Hash\n              type, key_type, value_type = type.class, *type.first\n              build_hash_coercion(type, key_type, value_type)\n            else\n              value_type = type.first\n              type = type.class\n              build_container_coercion(type, value_type)\n            end\n          elsif CORE_TYPES.key? type\n            build_core_type_coercion(type)\n          elsif type.respond_to? :coerce\n            lambda do |value|\n              return value if value.is_a? type\n              type.coerce(value)\n            end\n          elsif type.respond_to? :new\n            lambda do |value|\n              return value if value.is_a? type\n              type.new(value)\n            end\n          else\n            raise TypeError, \"#{type} is not a coercable type\"\n          end\n        end\n\n        def build_hash_coercion(type, key_type, value_type)\n          key_coerce = fetch_coercion(key_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type[value.map { |k, v| [key_coerce.call(k), value_coerce.call(v)] }]\n          end\n        end\n\n        def build_container_coercion(type, value_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type.new(value.map { |v| value_coerce.call(v) })\n          end\n        end\n\n        def build_core_type_coercion(type)\n          name = CORE_TYPES[type]\n          lambda do |value|\n            return value if value.is_a? type\n            return value.send(name)\n          end\n        end\n\n        def inherited(klass)\n          super\n\n          klass.key_coercions = key_coercions.dup\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "coerce_value", "signature": "def coerce_value(from, into, options = {})", "start_line": 114, "end_line": 131}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 179}
{"function_name": "build_coercion", "file_path": "hashie/lib/hashie/extensions/coercion.rb", "focal_code": "def build_coercion(type)\n          if type.is_a? Enumerable\n            if type.class == ::Hash\n              type, key_type, value_type = type.class, *type.first\n              build_hash_coercion(type, key_type, value_type)\n            else\n              value_type = type.first\n              type = type.class\n              build_container_coercion(type, value_type)\n            end\n          elsif CORE_TYPES.key? type\n            build_core_type_coercion(type)\n          elsif type.respond_to? :coerce\n            lambda do |value|\n              return value if value.is_a? type\n              type.coerce(value)\n            end\n          elsif type.respond_to? :new\n            lambda do |value|\n              return value if value.is_a? type\n              type.new(value)\n            end\n          else\n            raise TypeError, \"#{type} is not a coercable type\"\n          end\n        end", "file_content": "module Hashie\n  class CoercionError < StandardError\n    def initialize(key, value, into, message)\n      super(\"Cannot coerce property #{key.inspect} from #{value.class} to #{into}: #{message}\")\n    end\n  end\n\n  module Extensions\n    module Coercion\n      CORE_TYPES = {\n        Integer    => :to_i,\n        Float      => :to_f,\n        Complex    => :to_c,\n        Rational   => :to_r,\n        String     => :to_s,\n        Symbol     => :to_sym\n      }.freeze\n\n      ABSTRACT_CORE_TYPES =\n        { Numeric => [Integer, Float, Complex, Rational] }\n\n      def self.included(base)\n        base.send :include, InstanceMethods\n        base.extend ClassMethods\n        unless base.method_defined?(:set_value_without_coercion)\n          base.send :alias_method, :set_value_without_coercion, :[]=\n        end\n        base.send :alias_method, :[]=, :set_value_with_coercion\n      end\n\n      module InstanceMethods\n        def set_value_with_coercion(key, value)\n          into = self.class.key_coercion(key) || self.class.value_coercion(value)\n\n          unless value.nil? || into.nil?\n            begin\n              value = self.class.fetch_coercion(into).call(value)\n            rescue NoMethodError, TypeError => e\n              raise CoercionError.new(key, value, into, e.message)\n            end\n          end\n\n          set_value_without_coercion(key, value)\n        end\n\n        def custom_writer(key, value, _convert = true)\n          self[key] = value\n        end\n\n        def replace(other_hash)\n          (keys - other_hash.keys).each { |key| delete(key) }\n          other_hash.each { |key, value| self[key] = value }\n          self\n        end\n      end\n\n      module ClassMethods\n        attr_writer :key_coercions\n        protected :key_coercions=\n\n        # Set up a coercion rule such that any time the specified\n        # key is set it will be coerced into the specified class.\n        # Coercion will occur by first attempting to call Class.coerce\n        # and then by calling Class.new with the value as an argument\n        # in either case.\n        #\n        # @param [Object] key the key or array of keys you would like to be coerced.\n        # @param [Class] into the class into which you want the key(s) coerced.\n        #\n        # @example Coerce a \"user\" subhash into a User object\n        #   class Tweet < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_key :user, User\n        #   end\n        def coerce_key(*attrs)\n          into = attrs.pop\n          attrs.each { |key| key_coercions[key] = into }\n        end\n\n        alias coerce_keys coerce_key\n\n        # Returns a hash of any existing key coercions.\n        def key_coercions\n          @key_coercions ||= {}\n        end\n\n        # Returns the specific key coercion for the specified key,\n        # if one exists.\n        def key_coercion(key)\n          key_coercions[key.to_sym]\n        end\n\n        # Set up a coercion rule such that any time a value of the\n        # specified type is set it will be coerced into the specified\n        # class.\n        #\n        # @param [Class] from the type you would like coerced.\n        # @param [Class] into the class into which you would like the value coerced.\n        # @option options [Boolean] :strict (true) whether use exact source class\n        #   only or include ancestors\n        #\n        # @example Coerce all hashes into this special type of hash\n        #   class SpecialHash < Hash\n        #     include Hashie::Extensions::Coercion\n        #     coerce_value Hash, SpecialHash\n        #\n        #     def initialize(hash = {})\n        #       super\n        #       hash.each_pair do |k,v|\n        #         self[k] = v\n        #       end\n        #     end\n        #   end\n        def coerce_value(from, into, options = {})\n          options = { strict: true }.merge(options)\n\n          if ABSTRACT_CORE_TYPES.key? from\n            ABSTRACT_CORE_TYPES[from].each do |type|\n              coerce_value type, into, options\n            end\n          end\n\n          if options[:strict]\n            strict_value_coercions[from] = into\n          else\n            while from.superclass && from.superclass != Object\n              lenient_value_coercions[from] = into\n              from = from.superclass\n            end\n          end\n        end\n\n        # Return all value coercions that have the :strict rule as true.\n        def strict_value_coercions\n          @strict_value_coercions ||= {}\n        end\n\n        # Return all value coercions that have the :strict rule as false.\n        def lenient_value_coercions\n          @lenient_value_coercions ||= {}\n        end\n\n        # Fetch the value coercion, if any, for the specified object.\n        def value_coercion(value)\n          from = value.class\n          strict_value_coercions[from] || lenient_value_coercions[from]\n        end\n\n        def fetch_coercion(type)\n          return type if type.is_a? Proc\n          coercion_cache[type]\n        end\n\n        def coercion_cache\n          @coercion_cache ||= ::Hash.new do |hash, type|\n            hash[type] = build_coercion(type)\n          end\n        end\n\n        def build_coercion(type)\n          if type.is_a? Enumerable\n            if type.class == ::Hash\n              type, key_type, value_type = type.class, *type.first\n              build_hash_coercion(type, key_type, value_type)\n            else\n              value_type = type.first\n              type = type.class\n              build_container_coercion(type, value_type)\n            end\n          elsif CORE_TYPES.key? type\n            build_core_type_coercion(type)\n          elsif type.respond_to? :coerce\n            lambda do |value|\n              return value if value.is_a? type\n              type.coerce(value)\n            end\n          elsif type.respond_to? :new\n            lambda do |value|\n              return value if value.is_a? type\n              type.new(value)\n            end\n          else\n            raise TypeError, \"#{type} is not a coercable type\"\n          end\n        end\n\n        def build_hash_coercion(type, key_type, value_type)\n          key_coerce = fetch_coercion(key_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type[value.map { |k, v| [key_coerce.call(k), value_coerce.call(v)] }]\n          end\n        end\n\n        def build_container_coercion(type, value_type)\n          value_coerce = fetch_coercion(value_type)\n          lambda do |value|\n            type.new(value.map { |v| value_coerce.call(v) })\n          end\n        end\n\n        def build_core_type_coercion(type)\n          name = CORE_TYPES[type]\n          lambda do |value|\n            return value if value.is_a? type\n            return value.send(name)\n          end\n        end\n\n        def inherited(klass)\n          super\n\n          klass.key_coercions = key_coercions.dup\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "build_coercion", "signature": "def build_coercion(type)", "start_line": 160, "end_line": 185}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 180}
{"function_name": "deep_fetch", "file_path": "hashie/lib/hashie/extensions/deep_fetch.rb", "focal_code": "def deep_fetch(*args, &block)\n        args.reduce(self) do |obj, arg|\n          begin\n            arg = Integer(arg) if obj.is_a? Array\n            obj.fetch(arg)\n          rescue ArgumentError, IndexError, NoMethodError => e\n            break yield(arg) if block\n            raise UndefinedPathError,\n                  \"Could not fetch path (#{args.join(' > ')}) at #{arg}\", e.backtrace\n          end\n        end\n      end", "file_content": "module Hashie\n  module Extensions\n    # Searches a deeply nested datastructure for a key path, and returns the associated value.\n    #\n    #  options = { user: { location: { address: '123 Street' } } }\n    #  options.deep_fetch :user, :location, :address #=> '123 Street'\n    #\n    # If a block is provided its value will be returned if the key does not exist.\n    #\n    #  options.deep_fetch(:user, :non_existent_key) { 'a value' } #=> 'a value'\n    #\n    # This is particularly useful for fetching values from deeply nested api responses\n    #   or params hashes.\n    module DeepFetch\n      class UndefinedPathError < StandardError; end\n\n      def deep_fetch(*args, &block)\n        args.reduce(self) do |obj, arg|\n          begin\n            arg = Integer(arg) if obj.is_a? Array\n            obj.fetch(arg)\n          rescue ArgumentError, IndexError, NoMethodError => e\n            break yield(arg) if block\n            raise UndefinedPathError,\n                  \"Could not fetch path (#{args.join(' > ')}) at #{arg}\", e.backtrace\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "deep_fetch", "signature": "def deep_fetch(*args, &block)", "start_line": 17, "end_line": 28}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 181}
{"function_name": "included", "file_path": "hashie/lib/hashie/extensions/indifferent_access.rb", "focal_code": "def self.included(base)\n        Hashie::Extensions::Dash::IndifferentAccess.maybe_extend(base)\n\n        base.class_eval do\n          alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)\n          alias_method :[]=, :indifferent_writer\n          alias_method :store, :indifferent_writer\n          %w[default update replace fetch delete key? values_at].each do |m|\n            alias_method \"regular_#{m}\", m unless method_defined?(\"regular_#{m}\")\n            alias_method m, \"indifferent_#{m}\"\n          end\n\n          %w[include? member? has_key?].each do |key_alias|\n            alias_method key_alias, :indifferent_key?\n          end\n\n          class << self\n            def [](*)\n              super.convert!\n            end\n\n            def try_convert(*)\n              (hash = super) && self[hash]\n            end\n          end\n        end\n      end", "file_content": "module Hashie\n  module Extensions\n    # IndifferentAccess gives you the ability to not care\n    # whether your hash has string or symbol keys. Made famous\n    # in Rails for accessing query and POST parameters, this\n    # is a handy tool for making sure your hash has maximum\n    # utility.\n    #\n    # One unique feature of this mixin is that it will recursively\n    # inject itself into sub-hash instances without modifying\n    # the actual class of the sub-hash.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MergeInitializer\n    #     include Hashie::Extensions::IndifferentAccess\n    #   end\n    #\n    #   h = MyHash.new(:foo => 'bar', 'baz' => 'blip')\n    #   h['foo'] # => 'bar'\n    #   h[:foo]  # => 'bar'\n    #   h[:baz]  # => 'blip'\n    #   h['baz'] # => 'blip'\n    #\n    module IndifferentAccess\n      include Hashie::Extensions::RubyVersionCheck\n\n      # @api private\n      def self.convert_key(key)\n        key.to_s\n      end\n\n      def self.included(base)\n        Hashie::Extensions::Dash::IndifferentAccess.maybe_extend(base)\n\n        base.class_eval do\n          alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)\n          alias_method :[]=, :indifferent_writer\n          alias_method :store, :indifferent_writer\n          %w[default update replace fetch delete key? values_at].each do |m|\n            alias_method \"regular_#{m}\", m unless method_defined?(\"regular_#{m}\")\n            alias_method m, \"indifferent_#{m}\"\n          end\n\n          %w[include? member? has_key?].each do |key_alias|\n            alias_method key_alias, :indifferent_key?\n          end\n\n          class << self\n            def [](*)\n              super.convert!\n            end\n\n            def try_convert(*)\n              (hash = super) && self[hash]\n            end\n          end\n        end\n      end\n\n      # This will inject indifferent access into an instance of\n      # a hash without modifying the actual class. This is what\n      # allows IndifferentAccess to spread to sub-hashes.\n      def self.inject!(hash)\n        (class << hash; self; end).send :include, IndifferentAccess\n        hash.convert!\n      end\n\n      # Injects indifferent access into a duplicate of the hash\n      # provided. See #inject!\n      def self.inject(hash)\n        inject!(hash.dup)\n      end\n\n      def convert_key(key)\n        IndifferentAccess.convert_key(key)\n      end\n\n      # Iterates through the keys and values, reconverting them to\n      # their proper indifferent state. Used when IndifferentAccess\n      # is injecting itself into member hashes.\n      def convert!\n        keys.each do |k| # rubocop:disable Performance/HashEachMethods\n          indifferent_writer k, regular_delete(k)\n        end\n        self\n      end\n\n      def indifferent_value(value)\n        if hash_lacking_indifference?(value)\n          IndifferentAccess.inject!(value)\n        elsif value.is_a?(::Array)\n          value.replace(value.map { |e| indifferent_value(e) })\n        else\n          value\n        end\n      end\n\n      def indifferent_default(key = nil)\n        return self[convert_key(key)] if key?(key)\n        regular_default(key)\n      end\n\n      def indifferent_update(other_hash)\n        return regular_update(other_hash) if hash_with_indifference?(other_hash)\n        other_hash.each_pair do |k, v|\n          self[k] = v\n        end\n      end\n\n      def indifferent_writer(key, value)\n        regular_writer convert_key(key), indifferent_value(value)\n      end\n\n      def indifferent_fetch(key, *args, &block)\n        regular_fetch convert_key(key), *args, &block\n      end\n\n      def indifferent_delete(key)\n        regular_delete convert_key(key)\n      end\n\n      def indifferent_key?(key)\n        regular_key? convert_key(key)\n      end\n\n      def indifferent_values_at(*indices)\n        indices.map { |i| self[i] }\n      end\n\n      def indifferent_access?\n        true\n      end\n\n      def indifferent_replace(other_hash)\n        (keys - other_hash.keys).each { |key| delete(key) }\n        other_hash.each { |key, value| self[key] = value }\n        self\n      end\n\n      def merge(*args)\n        result = super\n        return IndifferentAccess.inject!(result) if hash_lacking_indifference?(result)\n        result.convert!\n      end\n\n      def merge!(*)\n        super.convert!\n      end\n\n      def to_hash\n        {}.tap do |result|\n          each_pair { |key, value| result[key] = value }\n\n          if default_proc\n            result.default_proc = default_proc\n          else\n            result.default = default\n          end\n        end\n      end\n\n      with_minimum_ruby('2.5.0') do\n        def slice(*keys)\n          string_keys = keys.map { |key| convert_key(key) }\n          super(*string_keys)\n        end\n      end\n\n      with_minimum_ruby('3.0.0') do\n        def except(*keys)\n          string_keys = keys.map { |key| convert_key(key) }\n          super(*string_keys)\n        end\n      end\n\n      protected\n\n      def hash_lacking_indifference?(other)\n        other.is_a?(::Hash) &&\n          !(other.respond_to?(:indifferent_access?) &&\n            other.indifferent_access?)\n      end\n\n      def hash_with_indifference?(other)\n        other.is_a?(::Hash) &&\n          other.respond_to?(:indifferent_access?) &&\n          other.indifferent_access?\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "included", "signature": "def self.included(base)", "start_line": 33, "end_line": 59}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 182}
{"function_name": "to_hash", "file_path": "hashie/lib/hashie/extensions/indifferent_access.rb", "focal_code": "def to_hash\n        {}.tap do |result|\n          each_pair { |key, value| result[key] = value }\n\n          if default_proc\n            result.default_proc = default_proc\n          else\n            result.default = default\n          end\n        end\n      end", "file_content": "module Hashie\n  module Extensions\n    # IndifferentAccess gives you the ability to not care\n    # whether your hash has string or symbol keys. Made famous\n    # in Rails for accessing query and POST parameters, this\n    # is a handy tool for making sure your hash has maximum\n    # utility.\n    #\n    # One unique feature of this mixin is that it will recursively\n    # inject itself into sub-hash instances without modifying\n    # the actual class of the sub-hash.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MergeInitializer\n    #     include Hashie::Extensions::IndifferentAccess\n    #   end\n    #\n    #   h = MyHash.new(:foo => 'bar', 'baz' => 'blip')\n    #   h['foo'] # => 'bar'\n    #   h[:foo]  # => 'bar'\n    #   h[:baz]  # => 'blip'\n    #   h['baz'] # => 'blip'\n    #\n    module IndifferentAccess\n      include Hashie::Extensions::RubyVersionCheck\n\n      # @api private\n      def self.convert_key(key)\n        key.to_s\n      end\n\n      def self.included(base)\n        Hashie::Extensions::Dash::IndifferentAccess.maybe_extend(base)\n\n        base.class_eval do\n          alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)\n          alias_method :[]=, :indifferent_writer\n          alias_method :store, :indifferent_writer\n          %w[default update replace fetch delete key? values_at].each do |m|\n            alias_method \"regular_#{m}\", m unless method_defined?(\"regular_#{m}\")\n            alias_method m, \"indifferent_#{m}\"\n          end\n\n          %w[include? member? has_key?].each do |key_alias|\n            alias_method key_alias, :indifferent_key?\n          end\n\n          class << self\n            def [](*)\n              super.convert!\n            end\n\n            def try_convert(*)\n              (hash = super) && self[hash]\n            end\n          end\n        end\n      end\n\n      # This will inject indifferent access into an instance of\n      # a hash without modifying the actual class. This is what\n      # allows IndifferentAccess to spread to sub-hashes.\n      def self.inject!(hash)\n        (class << hash; self; end).send :include, IndifferentAccess\n        hash.convert!\n      end\n\n      # Injects indifferent access into a duplicate of the hash\n      # provided. See #inject!\n      def self.inject(hash)\n        inject!(hash.dup)\n      end\n\n      def convert_key(key)\n        IndifferentAccess.convert_key(key)\n      end\n\n      # Iterates through the keys and values, reconverting them to\n      # their proper indifferent state. Used when IndifferentAccess\n      # is injecting itself into member hashes.\n      def convert!\n        keys.each do |k| # rubocop:disable Performance/HashEachMethods\n          indifferent_writer k, regular_delete(k)\n        end\n        self\n      end\n\n      def indifferent_value(value)\n        if hash_lacking_indifference?(value)\n          IndifferentAccess.inject!(value)\n        elsif value.is_a?(::Array)\n          value.replace(value.map { |e| indifferent_value(e) })\n        else\n          value\n        end\n      end\n\n      def indifferent_default(key = nil)\n        return self[convert_key(key)] if key?(key)\n        regular_default(key)\n      end\n\n      def indifferent_update(other_hash)\n        return regular_update(other_hash) if hash_with_indifference?(other_hash)\n        other_hash.each_pair do |k, v|\n          self[k] = v\n        end\n      end\n\n      def indifferent_writer(key, value)\n        regular_writer convert_key(key), indifferent_value(value)\n      end\n\n      def indifferent_fetch(key, *args, &block)\n        regular_fetch convert_key(key), *args, &block\n      end\n\n      def indifferent_delete(key)\n        regular_delete convert_key(key)\n      end\n\n      def indifferent_key?(key)\n        regular_key? convert_key(key)\n      end\n\n      def indifferent_values_at(*indices)\n        indices.map { |i| self[i] }\n      end\n\n      def indifferent_access?\n        true\n      end\n\n      def indifferent_replace(other_hash)\n        (keys - other_hash.keys).each { |key| delete(key) }\n        other_hash.each { |key, value| self[key] = value }\n        self\n      end\n\n      def merge(*args)\n        result = super\n        return IndifferentAccess.inject!(result) if hash_lacking_indifference?(result)\n        result.convert!\n      end\n\n      def merge!(*)\n        super.convert!\n      end\n\n      def to_hash\n        {}.tap do |result|\n          each_pair { |key, value| result[key] = value }\n\n          if default_proc\n            result.default_proc = default_proc\n          else\n            result.default = default\n          end\n        end\n      end\n\n      with_minimum_ruby('2.5.0') do\n        def slice(*keys)\n          string_keys = keys.map { |key| convert_key(key) }\n          super(*string_keys)\n        end\n      end\n\n      with_minimum_ruby('3.0.0') do\n        def except(*keys)\n          string_keys = keys.map { |key| convert_key(key) }\n          super(*string_keys)\n        end\n      end\n\n      protected\n\n      def hash_lacking_indifference?(other)\n        other.is_a?(::Hash) &&\n          !(other.respond_to?(:indifferent_access?) &&\n            other.indifferent_access?)\n      end\n\n      def hash_with_indifference?(other)\n        other.is_a?(::Hash) &&\n          other.respond_to?(:indifferent_access?) &&\n          other.indifferent_access?\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "to_hash", "signature": "def to_hash {}.tap do |result|", "start_line": 151, "end_line": 161}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 183}
{"function_name": "method_missing", "file_path": "hashie/lib/hashie/extensions/method_access.rb", "focal_code": "def method_missing(name, *args)\n        if key?(name)\n          self[name]\n        else\n          sname = name.to_s\n          if key?(sname)\n            self[sname]\n          elsif sname[-1] == '?'\n            kname = sname[0..-2]\n            key?(kname) || key?(kname.to_sym)\n          else\n            super\n          end\n        end\n      end", "file_content": "module Hashie\n  module Extensions\n    # MethodReader allows you to access keys of the hash\n    # via method calls. This gives you an OStruct like way\n    # to access your hash's keys. It will recognize keys\n    # either as strings or symbols.\n    #\n    # Note that while nil keys will be returned as nil,\n    # undefined keys will raise NoMethodErrors. Also note that\n    # #respond_to? has been patched to appropriately recognize\n    # key methods.\n    #\n    # @example\n    #   class User < Hash\n    #     include Hashie::Extensions::MethodReader\n    #   end\n    #\n    #   user = User.new\n    #   user['first_name'] = 'Michael'\n    #   user.first_name # => 'Michael'\n    #\n    #   user[:last_name] = 'Bleigh'\n    #   user.last_name # => 'Bleigh'\n    #\n    #   user[:birthday] = nil\n    #   user.birthday # => nil\n    #\n    #   user.not_declared # => NoMethodError\n    module MethodReader\n      def respond_to_missing?(name, include_private = false)\n        return true if key?(name.to_s) || key?(name.to_sym)\n        super\n      end\n\n      def method_missing(name, *args)\n        if key?(name)\n          self[name]\n        else\n          sname = name.to_s\n          if key?(sname)\n            self[sname]\n          elsif sname[-1] == '?'\n            kname = sname[0..-2]\n            key?(kname) || key?(kname.to_sym)\n          else\n            super\n          end\n        end\n      end\n    end\n\n    # MethodWriter gives you #key_name= shortcuts for\n    # writing to your hash. Keys are written as strings,\n    # override #convert_key if you would like to have symbols\n    # or something else.\n    #\n    # Note that MethodWriter also overrides #respond_to such\n    # that any #method_name= will respond appropriately as true.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodWriter\n    #   end\n    #\n    #   h = MyHash.new\n    #   h.awesome = 'sauce'\n    #   h['awesome'] # => 'sauce'\n    #\n    module MethodWriter\n      def respond_to_missing?(name, include_private = false)\n        return true if name.to_s =~ /=$/\n        super\n      end\n\n      def method_missing(name, *args)\n        if args.size == 1 && name.to_s =~ /(.*)=$/\n          return self[convert_key(Regexp.last_match[1])] = args.first\n        end\n\n        super\n      end\n\n      def convert_key(key)\n        key.to_s\n      end\n    end\n\n    # MethodQuery gives you the ability to check for the truthiness\n    # of a key via method calls. Note that it will return false if\n    # the key is set to a non-truthful value, not if the key isn't\n    # set at all. Use #key? for checking if a key has been set.\n    #\n    # MethodQuery will check against both string and symbol names\n    # of the method for existing keys. It also patches #respond_to\n    # to appropriately detect the query methods.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodQuery\n    #   end\n    #\n    #   h = MyHash.new\n    #   h['abc'] = 123\n    #   h.abc? # => true\n    #   h['def'] = nil\n    #   h.def? # => false\n    #   h.hji? # => NoMethodError\n    module MethodQuery\n      def respond_to_missing?(name, include_private = false)\n        if query_method?(name) && indifferent_key?(key_from_query_method(name))\n          true\n        else\n          super\n        end\n      end\n\n      def method_missing(name, *args)\n        return super unless args.empty?\n\n        if query_method?(name)\n          key = key_from_query_method(name)\n          if indifferent_key?(key)\n            !!(self[key] || self[key.to_sym])\n          else\n            super\n          end\n        else\n          super\n        end\n      end\n\n      private\n\n      def indifferent_key?(name)\n        name = name.to_s\n        key?(name) || key?(name.to_sym)\n      end\n\n      def key_from_query_method(query_method)\n        query_method.to_s[0..-2]\n      end\n\n      def query_method?(name)\n        name.to_s.end_with?('?')\n      end\n    end\n\n    # A macro module that will automatically include MethodReader,\n    # MethodWriter, and MethodQuery, giving you the ability to read,\n    # write, and query keys in a hash using method call shortcuts.\n    module MethodAccess\n      def self.included(base)\n        [MethodReader, MethodWriter, MethodQuery].each do |mod|\n          base.send :include, mod\n        end\n      end\n    end\n\n    # A module shared between MethodOverridingWriter and MethodOverridingInitializer\n    # to contained shared logic. This module aids in redefining existing hash methods.\n    module RedefineMethod\n      protected\n\n      def method?(name)\n        methods.map(&:to_s).include?(name)\n      end\n\n      def redefine_method(method_name)\n        eigenclass = class << self; self; end\n        eigenclass.__send__(:alias_method, \"__#{method_name}\", method_name)\n        eigenclass.__send__(:define_method, method_name, -> { self[method_name] })\n      end\n    end\n\n    # MethodOverridingWriter gives you #key_name= shortcuts for\n    # writing to your hash. It allows methods to be overridden by\n    # #key_name= shortcuts and aliases those methods with two\n    # leading underscores.\n    #\n    # Keys are written as strings. Override #convert_key if you\n    # would like to have symbols or something else.\n    #\n    # Note that MethodOverridingWriter also overrides\n    # #respond_to_missing? such that any #method_name= will respond\n    # appropriately as true.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodOverridingWriter\n    #   end\n    #\n    #   h = MyHash.new\n    #   h.awesome = 'sauce'\n    #   h['awesome'] # => 'sauce'\n    #   h.zip = 'a-dee-doo-dah'\n    #   h.zip # => 'a-dee-doo-dah'\n    #   h.__zip # => [[['awesome', 'sauce'], ['zip', 'a-dee-doo-dah']]]\n    #\n    module MethodOverridingWriter\n      include RedefineMethod\n\n      def convert_key(key)\n        key.to_s\n      end\n\n      def method_missing(name, *args)\n        if args.size == 1 && name.to_s =~ /(.*)=$/\n          key = Regexp.last_match[1]\n          redefine_method(key) if method?(key) && !already_overridden?(key)\n          return self[convert_key(key)] = args.first\n        end\n\n        super\n      end\n\n      def respond_to_missing?(name, include_private = false)\n        return true if name.to_s.end_with?('=')\n        super\n      end\n\n      protected\n\n      def already_overridden?(name)\n        method?(\"__#{name}\")\n      end\n    end\n\n    # A macro module that will automatically include MethodReader,\n    # MethodOverridingWriter, and MethodQuery, giving you the ability\n    # to read, write, and query keys in a hash using method call\n    # shortcuts that can override object methods. Any overridden\n    # object method is automatically aliased with two leading\n    # underscores.\n    module MethodAccessWithOverride\n      def self.included(base)\n        [MethodReader, MethodOverridingWriter,\n         MethodQuery, MethodOverridingInitializer].each do |mod|\n          base.send :include, mod\n        end\n      end\n    end\n\n    # MethodOverridingInitializer allows you to override default hash\n    # methods when passing in values from an existing hash. The overridden\n    # methods are aliased with two leading underscores.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodOverridingInitializer\n    #   end\n    #\n    #   h = MyHash.new(zip: 'a-dee-doo-dah')\n    #   h.zip # => 'a-dee-doo-dah'\n    #   h.__zip # => [[['zip', 'a-dee-doo-dah']]]\n    module MethodOverridingInitializer\n      include RedefineMethod\n\n      def initialize(hash = {})\n        hash.each do |key, value|\n          skey = key.to_s\n          redefine_method(skey) if method?(skey)\n          self[skey] = value\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, *args)", "start_line": 35, "end_line": 49}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 184}
{"function_name": "method_missing", "file_path": "hashie/lib/hashie/extensions/method_access.rb", "focal_code": "def method_missing(name, *args)\n        return super unless args.empty?\n\n        if query_method?(name)\n          key = key_from_query_method(name)\n          if indifferent_key?(key)\n            !!(self[key] || self[key.to_sym])\n          else\n            super\n          end\n        else\n          super\n        end\n      end", "file_content": "module Hashie\n  module Extensions\n    # MethodReader allows you to access keys of the hash\n    # via method calls. This gives you an OStruct like way\n    # to access your hash's keys. It will recognize keys\n    # either as strings or symbols.\n    #\n    # Note that while nil keys will be returned as nil,\n    # undefined keys will raise NoMethodErrors. Also note that\n    # #respond_to? has been patched to appropriately recognize\n    # key methods.\n    #\n    # @example\n    #   class User < Hash\n    #     include Hashie::Extensions::MethodReader\n    #   end\n    #\n    #   user = User.new\n    #   user['first_name'] = 'Michael'\n    #   user.first_name # => 'Michael'\n    #\n    #   user[:last_name] = 'Bleigh'\n    #   user.last_name # => 'Bleigh'\n    #\n    #   user[:birthday] = nil\n    #   user.birthday # => nil\n    #\n    #   user.not_declared # => NoMethodError\n    module MethodReader\n      def respond_to_missing?(name, include_private = false)\n        return true if key?(name.to_s) || key?(name.to_sym)\n        super\n      end\n\n      def method_missing(name, *args)\n        if key?(name)\n          self[name]\n        else\n          sname = name.to_s\n          if key?(sname)\n            self[sname]\n          elsif sname[-1] == '?'\n            kname = sname[0..-2]\n            key?(kname) || key?(kname.to_sym)\n          else\n            super\n          end\n        end\n      end\n    end\n\n    # MethodWriter gives you #key_name= shortcuts for\n    # writing to your hash. Keys are written as strings,\n    # override #convert_key if you would like to have symbols\n    # or something else.\n    #\n    # Note that MethodWriter also overrides #respond_to such\n    # that any #method_name= will respond appropriately as true.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodWriter\n    #   end\n    #\n    #   h = MyHash.new\n    #   h.awesome = 'sauce'\n    #   h['awesome'] # => 'sauce'\n    #\n    module MethodWriter\n      def respond_to_missing?(name, include_private = false)\n        return true if name.to_s =~ /=$/\n        super\n      end\n\n      def method_missing(name, *args)\n        if args.size == 1 && name.to_s =~ /(.*)=$/\n          return self[convert_key(Regexp.last_match[1])] = args.first\n        end\n\n        super\n      end\n\n      def convert_key(key)\n        key.to_s\n      end\n    end\n\n    # MethodQuery gives you the ability to check for the truthiness\n    # of a key via method calls. Note that it will return false if\n    # the key is set to a non-truthful value, not if the key isn't\n    # set at all. Use #key? for checking if a key has been set.\n    #\n    # MethodQuery will check against both string and symbol names\n    # of the method for existing keys. It also patches #respond_to\n    # to appropriately detect the query methods.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodQuery\n    #   end\n    #\n    #   h = MyHash.new\n    #   h['abc'] = 123\n    #   h.abc? # => true\n    #   h['def'] = nil\n    #   h.def? # => false\n    #   h.hji? # => NoMethodError\n    module MethodQuery\n      def respond_to_missing?(name, include_private = false)\n        if query_method?(name) && indifferent_key?(key_from_query_method(name))\n          true\n        else\n          super\n        end\n      end\n\n      def method_missing(name, *args)\n        return super unless args.empty?\n\n        if query_method?(name)\n          key = key_from_query_method(name)\n          if indifferent_key?(key)\n            !!(self[key] || self[key.to_sym])\n          else\n            super\n          end\n        else\n          super\n        end\n      end\n\n      private\n\n      def indifferent_key?(name)\n        name = name.to_s\n        key?(name) || key?(name.to_sym)\n      end\n\n      def key_from_query_method(query_method)\n        query_method.to_s[0..-2]\n      end\n\n      def query_method?(name)\n        name.to_s.end_with?('?')\n      end\n    end\n\n    # A macro module that will automatically include MethodReader,\n    # MethodWriter, and MethodQuery, giving you the ability to read,\n    # write, and query keys in a hash using method call shortcuts.\n    module MethodAccess\n      def self.included(base)\n        [MethodReader, MethodWriter, MethodQuery].each do |mod|\n          base.send :include, mod\n        end\n      end\n    end\n\n    # A module shared between MethodOverridingWriter and MethodOverridingInitializer\n    # to contained shared logic. This module aids in redefining existing hash methods.\n    module RedefineMethod\n      protected\n\n      def method?(name)\n        methods.map(&:to_s).include?(name)\n      end\n\n      def redefine_method(method_name)\n        eigenclass = class << self; self; end\n        eigenclass.__send__(:alias_method, \"__#{method_name}\", method_name)\n        eigenclass.__send__(:define_method, method_name, -> { self[method_name] })\n      end\n    end\n\n    # MethodOverridingWriter gives you #key_name= shortcuts for\n    # writing to your hash. It allows methods to be overridden by\n    # #key_name= shortcuts and aliases those methods with two\n    # leading underscores.\n    #\n    # Keys are written as strings. Override #convert_key if you\n    # would like to have symbols or something else.\n    #\n    # Note that MethodOverridingWriter also overrides\n    # #respond_to_missing? such that any #method_name= will respond\n    # appropriately as true.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodOverridingWriter\n    #   end\n    #\n    #   h = MyHash.new\n    #   h.awesome = 'sauce'\n    #   h['awesome'] # => 'sauce'\n    #   h.zip = 'a-dee-doo-dah'\n    #   h.zip # => 'a-dee-doo-dah'\n    #   h.__zip # => [[['awesome', 'sauce'], ['zip', 'a-dee-doo-dah']]]\n    #\n    module MethodOverridingWriter\n      include RedefineMethod\n\n      def convert_key(key)\n        key.to_s\n      end\n\n      def method_missing(name, *args)\n        if args.size == 1 && name.to_s =~ /(.*)=$/\n          key = Regexp.last_match[1]\n          redefine_method(key) if method?(key) && !already_overridden?(key)\n          return self[convert_key(key)] = args.first\n        end\n\n        super\n      end\n\n      def respond_to_missing?(name, include_private = false)\n        return true if name.to_s.end_with?('=')\n        super\n      end\n\n      protected\n\n      def already_overridden?(name)\n        method?(\"__#{name}\")\n      end\n    end\n\n    # A macro module that will automatically include MethodReader,\n    # MethodOverridingWriter, and MethodQuery, giving you the ability\n    # to read, write, and query keys in a hash using method call\n    # shortcuts that can override object methods. Any overridden\n    # object method is automatically aliased with two leading\n    # underscores.\n    module MethodAccessWithOverride\n      def self.included(base)\n        [MethodReader, MethodOverridingWriter,\n         MethodQuery, MethodOverridingInitializer].each do |mod|\n          base.send :include, mod\n        end\n      end\n    end\n\n    # MethodOverridingInitializer allows you to override default hash\n    # methods when passing in values from an existing hash. The overridden\n    # methods are aliased with two leading underscores.\n    #\n    # @example\n    #   class MyHash < Hash\n    #     include Hashie::Extensions::MethodOverridingInitializer\n    #   end\n    #\n    #   h = MyHash.new(zip: 'a-dee-doo-dah')\n    #   h.zip # => 'a-dee-doo-dah'\n    #   h.__zip # => [[['zip', 'a-dee-doo-dah']]]\n    module MethodOverridingInitializer\n      include RedefineMethod\n\n      def initialize(hash = {})\n        hash.each do |key, value|\n          skey = key.to_s\n          redefine_method(skey) if method?(skey)\n          self[skey] = value\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, *args)", "start_line": 117, "end_line": 130}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 185}
{"function_name": "<=>", "file_path": "hashie/lib/hashie/extensions/ruby_version.rb", "focal_code": "def <=>(other)\n        lhsegments = segments\n        rhsegments = other.segments\n\n        lhsize = lhsegments.size\n        rhsize = rhsegments.size\n        limit  = (lhsize > rhsize ? lhsize : rhsize) - 1\n\n        i = 0\n\n        while i <= limit\n          lhs = lhsegments[i] || 0\n          rhs = rhsegments[i] || 0\n          i += 1\n\n          next      if lhs == rhs\n          return -1 if lhs.is_a?(String) && rhs.is_a?(Numeric)\n          return  1 if lhs.is_a?(Numeric) && rhs.is_a?(String)\n\n          return lhs <=> rhs\n        end\n\n        0\n      end", "file_content": "# Copyright (c) Chad Fowler, Rich Kilmer, Jim Weirich and others.\n# Portions copyright (c) Engine Yard and Andre Arko\n#\n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# 'Software'), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish,\n# distribute, sublicense, and/or sell copies of the Software, and to\n# permit persons to whom the Software is furnished to do so, subject to\n# the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n\nmodule Hashie\n  module Extensions\n    class RubyVersion\n      include Comparable\n\n      attr_accessor :segments\n\n      def initialize(version)\n        @segments = split_to_segments(version)\n      end\n\n      def <=>(other)\n        lhsegments = segments\n        rhsegments = other.segments\n\n        lhsize = lhsegments.size\n        rhsize = rhsegments.size\n        limit  = (lhsize > rhsize ? lhsize : rhsize) - 1\n\n        i = 0\n\n        while i <= limit\n          lhs = lhsegments[i] || 0\n          rhs = rhsegments[i] || 0\n          i += 1\n\n          next      if lhs == rhs\n          return -1 if lhs.is_a?(String) && rhs.is_a?(Numeric)\n          return  1 if lhs.is_a?(Numeric) && rhs.is_a?(String)\n\n          return lhs <=> rhs\n        end\n\n        0\n      end\n\n      private\n\n      def split_to_segments(version)\n        version.scan(/[0-9]+|[a-z]+/i).map do |segment|\n          /^\\d+$/ =~ segment ? segment.to_i : segment\n        end.freeze\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "<=>", "signature": "def <", "start_line": 26, "end_line": 49}, "metadata": {"module": "Hashie", "class_name": "RubyVersion", "class_signature": "class RubyVersion"}, "task_id": 186}
{"function_name": "stringify_keys_recursively!", "file_path": "hashie/lib/hashie/extensions/stringify_keys.rb", "focal_code": "def stringify_keys_recursively!(object)\n          case object\n          when self.class\n            stringify_keys!(object)\n          when ::Array\n            object.each do |i|\n              stringify_keys_recursively!(i)\n            end\n          when ::Hash\n            stringify_keys!(object)\n          end\n        end", "file_content": "module Hashie\n  module Extensions\n    module StringifyKeys\n      # Convert all keys in the hash to strings.\n      #\n      # @example\n      #   test = {:abc => 'def'}\n      #   test.stringify_keys!\n      #   test # => {'abc' => 'def'}\n      def stringify_keys!\n        StringifyKeys.stringify_keys!(self)\n        self\n      end\n\n      # Return a new hash with all keys converted\n      # to strings.\n      def stringify_keys\n        StringifyKeys.stringify_keys(self)\n      end\n\n      module ClassMethods\n        # Stringify all keys recursively within nested\n        # hashes and arrays.\n        # @api private\n        def stringify_keys_recursively!(object)\n          case object\n          when self.class\n            stringify_keys!(object)\n          when ::Array\n            object.each do |i|\n              stringify_keys_recursively!(i)\n            end\n          when ::Hash\n            stringify_keys!(object)\n          end\n        end\n\n        # Convert all keys in the hash to strings.\n        #\n        # @param [::Hash] hash\n        # @example\n        #   test = {:abc => 'def'}\n        #   test.stringify_keys!\n        #   test # => {'abc' => 'def'}\n        def stringify_keys!(hash)\n          hash.extend(Hashie::Extensions::StringifyKeys) unless hash.respond_to?(:stringify_keys!)\n          hash.keys.each do |k| # rubocop:disable Performance/HashEachMethods\n            stringify_keys_recursively!(hash[k])\n            hash[k.to_s] = hash.delete(k)\n          end\n          hash\n        end\n\n        # Return a copy of hash with all keys converted\n        # to strings.\n        # @param [::Hash] hash\n        def stringify_keys(hash)\n          copy = hash.dup\n          copy.extend(Hashie::Extensions::StringifyKeys) unless copy.respond_to?(:stringify_keys!)\n          copy.tap do |new_hash|\n            stringify_keys!(new_hash)\n          end\n        end\n      end\n\n      class << self\n        include ClassMethods\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "stringify_keys_recursively!", "signature": "def stringify_keys_recursively!(object)", "start_line": 25, "end_line": 36}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 187}
{"function_name": "symbolize_keys_recursively!", "file_path": "hashie/lib/hashie/extensions/symbolize_keys.rb", "focal_code": "def symbolize_keys_recursively!(object)\n          case object\n          when self.class\n            symbolize_keys!(object)\n          when ::Array\n            object.each do |i|\n              symbolize_keys_recursively!(i)\n            end\n          when ::Hash\n            symbolize_keys!(object)\n          end\n        end", "file_content": "module Hashie\n  module Extensions\n    module SymbolizeKeys\n      # Convert all keys in the hash to symbols.\n      #\n      # @example\n      #   test = {'abc' => 'def'}\n      #   test.symbolize_keys!\n      #   test # => {:abc => 'def'}\n      def symbolize_keys!\n        SymbolizeKeys.symbolize_keys!(self)\n        self\n      end\n\n      # Return a new hash with all keys converted\n      # to symbols.\n      def symbolize_keys\n        SymbolizeKeys.symbolize_keys(self)\n      end\n\n      module ClassMethods\n        # Symbolize all keys recursively within nested\n        # hashes and arrays.\n        # @api private\n        def symbolize_keys_recursively!(object)\n          case object\n          when self.class\n            symbolize_keys!(object)\n          when ::Array\n            object.each do |i|\n              symbolize_keys_recursively!(i)\n            end\n          when ::Hash\n            symbolize_keys!(object)\n          end\n        end\n\n        # Convert all keys in hash to symbols.\n        #\n        # @param [Hash] hash\n        # @example\n        #   test = {'abc' => 'def'}\n        #   Hashie.symbolize_keys! test\n        #   test # => {:abc => 'def'}\n        def symbolize_keys!(hash)\n          hash.extend(Hashie::Extensions::SymbolizeKeys) unless hash.respond_to?(:symbolize_keys!)\n          hash.keys.each do |k| # rubocop:disable Performance/HashEachMethods\n            symbolize_keys_recursively!(hash[k])\n            hash[convert_key(k)] = hash.delete(k)\n          end\n          hash\n        end\n\n        # Return a copy of hash with all keys converted\n        # to symbols.\n        # @param [::Hash] hash\n        def symbolize_keys(hash)\n          copy = hash.dup\n          copy.extend(Hashie::Extensions::SymbolizeKeys) unless copy.respond_to?(:symbolize_keys!)\n          copy.tap do |new_hash|\n            symbolize_keys!(new_hash)\n          end\n        end\n\n        private\n\n        # Converts a key to a symbol, if possible\n        #\n        # @api private\n        # @param [<K>] key the key to attempt convert to a symbol\n        # @return [Symbol, K]\n        def convert_key(key)\n          key.respond_to?(:to_sym) ? key.to_sym : key\n        end\n      end\n\n      class << self\n        include ClassMethods\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "symbolize_keys_recursively!", "signature": "def symbolize_keys_recursively!(object)", "start_line": 25, "end_line": 36}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 188}
{"function_name": "property", "file_path": "hashie/lib/hashie/extensions/dash/property_translation.rb", "focal_code": "def property(property_name, options = {})\n            super\n\n            from = options[:from]\n            converter = options[:with]\n            transformer = options[:transform_with]\n\n            if from\n              fail_self_transformation_error!(property_name) if property_name == from\n              define_translation(from, property_name, converter || transformer)\n              define_writer_for_source_property(from)\n            elsif valid_transformer?(transformer)\n              transforms[property_name] = transformer\n            end\n          end", "file_content": "module Hashie\n  module Extensions\n    module Dash\n      # Extends a Dash with the ability to remap keys from a source hash.\n      #\n      # Property translation is useful when you need to read data from another\n      # application -- such as a Java API -- where the keys are named\n      # differently from Ruby conventions.\n      #\n      # == Example from inconsistent APIs\n      #\n      #   class PersonHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :first_name, from :firstName\n      #     property :last_name, from: :lastName\n      #     property :first_name, from: :f_name\n      #     property :last_name, from: :l_name\n      #   end\n      #\n      #   person = PersonHash.new(firstName: 'Michael', l_name: 'Bleigh')\n      #   person[:first_name]  #=> 'Michael'\n      #   person[:last_name]   #=> 'Bleigh'\n      #\n      # You can also use a lambda to translate the value. This is particularly\n      # useful when you want to ensure the type of data you're wrapping.\n      #\n      # == Example using translation lambdas\n      #\n      #   class DataModelHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :id, transform_with: ->(value) { value.to_i }\n      #     property :created_at, from: :created, with: ->(value) { Time.parse(value) }\n      #   end\n      #\n      #   model = DataModelHash.new(id: '123', created: '2014-04-25 22:35:28')\n      #   model.id.class          #=> Integer (Fixnum if you are using Ruby 2.3 or lower)\n      #   model.created_at.class  #=> Time\n      module PropertyTranslation\n        def self.included(base)\n          base.instance_variable_set(:@transforms, {})\n          base.instance_variable_set(:@translations_hash, ::Hash.new { |hash, key| hash[key] = {} })\n          base.extend(ClassMethods)\n          base.send(:include, InstanceMethods)\n        end\n\n        module ClassMethods\n          attr_reader :transforms, :translations_hash\n\n          # Ensures that any inheriting classes maintain their translations.\n          #\n          # * <tt>:default</tt> - The class inheriting the translations.\n          def inherited(klass)\n            super\n            klass.instance_variable_set(:@transforms, transforms.dup)\n            klass.instance_variable_set(:@translations_hash, translations_hash.dup)\n          end\n\n          def permitted_input_keys\n            @permitted_input_keys ||=\n              properties\n              .map { |property| inverse_translations.fetch property, property }\n          end\n\n          # Defines a property on the Trash. Options are as follows:\n          #\n          # * <tt>:default</tt> - Specify a default value for this property, to be\n          # returned before a value is set on the property in a new Dash.\n          # * <tt>:from</tt> - Specify the original key name that will be write only.\n          # * <tt>:with</tt> - Specify a lambda to be used to convert value.\n          # * <tt>:transform_with</tt> - Specify a lambda to be used to convert value\n          # without using the :from option. It transform the property itself.\n          def property(property_name, options = {})\n            super\n\n            from = options[:from]\n            converter = options[:with]\n            transformer = options[:transform_with]\n\n            if from\n              fail_self_transformation_error!(property_name) if property_name == from\n              define_translation(from, property_name, converter || transformer)\n              define_writer_for_source_property(from)\n            elsif valid_transformer?(transformer)\n              transforms[property_name] = transformer\n            end\n          end\n\n          def transformed_property(property_name, value)\n            transforms[property_name].call(value)\n          end\n\n          def transformation_exists?(name)\n            transforms.key? name\n          end\n\n          def translation_exists?(name)\n            translations_hash.key? name\n          end\n\n          def translations\n            @translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                translations[property_name] =\n                  if property_translations.size > 1\n                    property_translations.keys\n                  else\n                    property_translations.keys.first\n                  end\n              end\n            end\n          end\n\n          def inverse_translations\n            @inverse_translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                property_translations.each_key do |key|\n                  translations[key] = property_name\n                end\n              end\n            end\n          end\n\n          private\n\n          def define_translation(from, property_name, translator)\n            translations_hash[from][property_name] = translator\n          end\n\n          def define_writer_for_source_property(property)\n            define_method \"#{property}=\" do |val|\n              __translations[property].each do |name, with|\n                self[name] = with.respond_to?(:call) ? with.call(val) : val\n              end\n            end\n          end\n\n          def fail_self_transformation_error!(property_name)\n            raise ArgumentError,\n                  \"Property name (#{property_name}) and :from option must not be the same\"\n          end\n\n          def valid_transformer?(transformer)\n            transformer.respond_to? :call\n          end\n        end\n\n        module InstanceMethods\n          # Sets a value on the Dash in a Hash-like way.\n          #\n          # Note: Only works on pre-existing properties.\n          def []=(property, value)\n            if self.class.translation_exists? property\n              send(\"#{property}=\", value)\n\n              if self.class.transformation_exists? property\n                super property, self.class.transformed_property(property, value)\n              elsif self.class.properties.include?(property)\n                super(property, value)\n              end\n            elsif self.class.transformation_exists? property\n              super property, self.class.transformed_property(property, value)\n            elsif property_exists? property\n              super\n            end\n          end\n\n          # Deletes any keys that have a translation\n          def initialize_attributes(attributes)\n            return unless attributes\n            attributes_copy = attributes.dup.delete_if do |k, v|\n              if self.class.translations_hash.include?(k)\n                self[k] = v\n                true\n              end\n            end\n            super attributes_copy\n          end\n\n          # Raises an NoMethodError if the property doesn't exist\n          def property_exists?(property)\n            fail_no_property_error!(property) unless self.class.property?(property)\n            true\n          end\n\n          private\n\n          def __translations\n            self.class.translations_hash\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "property", "signature": "def property(property_name, options = {})", "start_line": 74, "end_line": 88}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 189}
{"function_name": "translations", "file_path": "hashie/lib/hashie/extensions/dash/property_translation.rb", "focal_code": "def translations\n            @translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                translations[property_name] =\n                  if property_translations.size > 1\n                    property_translations.keys\n                  else\n                    property_translations.keys.first\n                  end\n              end\n            end\n          end", "file_content": "module Hashie\n  module Extensions\n    module Dash\n      # Extends a Dash with the ability to remap keys from a source hash.\n      #\n      # Property translation is useful when you need to read data from another\n      # application -- such as a Java API -- where the keys are named\n      # differently from Ruby conventions.\n      #\n      # == Example from inconsistent APIs\n      #\n      #   class PersonHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :first_name, from :firstName\n      #     property :last_name, from: :lastName\n      #     property :first_name, from: :f_name\n      #     property :last_name, from: :l_name\n      #   end\n      #\n      #   person = PersonHash.new(firstName: 'Michael', l_name: 'Bleigh')\n      #   person[:first_name]  #=> 'Michael'\n      #   person[:last_name]   #=> 'Bleigh'\n      #\n      # You can also use a lambda to translate the value. This is particularly\n      # useful when you want to ensure the type of data you're wrapping.\n      #\n      # == Example using translation lambdas\n      #\n      #   class DataModelHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :id, transform_with: ->(value) { value.to_i }\n      #     property :created_at, from: :created, with: ->(value) { Time.parse(value) }\n      #   end\n      #\n      #   model = DataModelHash.new(id: '123', created: '2014-04-25 22:35:28')\n      #   model.id.class          #=> Integer (Fixnum if you are using Ruby 2.3 or lower)\n      #   model.created_at.class  #=> Time\n      module PropertyTranslation\n        def self.included(base)\n          base.instance_variable_set(:@transforms, {})\n          base.instance_variable_set(:@translations_hash, ::Hash.new { |hash, key| hash[key] = {} })\n          base.extend(ClassMethods)\n          base.send(:include, InstanceMethods)\n        end\n\n        module ClassMethods\n          attr_reader :transforms, :translations_hash\n\n          # Ensures that any inheriting classes maintain their translations.\n          #\n          # * <tt>:default</tt> - The class inheriting the translations.\n          def inherited(klass)\n            super\n            klass.instance_variable_set(:@transforms, transforms.dup)\n            klass.instance_variable_set(:@translations_hash, translations_hash.dup)\n          end\n\n          def permitted_input_keys\n            @permitted_input_keys ||=\n              properties\n              .map { |property| inverse_translations.fetch property, property }\n          end\n\n          # Defines a property on the Trash. Options are as follows:\n          #\n          # * <tt>:default</tt> - Specify a default value for this property, to be\n          # returned before a value is set on the property in a new Dash.\n          # * <tt>:from</tt> - Specify the original key name that will be write only.\n          # * <tt>:with</tt> - Specify a lambda to be used to convert value.\n          # * <tt>:transform_with</tt> - Specify a lambda to be used to convert value\n          # without using the :from option. It transform the property itself.\n          def property(property_name, options = {})\n            super\n\n            from = options[:from]\n            converter = options[:with]\n            transformer = options[:transform_with]\n\n            if from\n              fail_self_transformation_error!(property_name) if property_name == from\n              define_translation(from, property_name, converter || transformer)\n              define_writer_for_source_property(from)\n            elsif valid_transformer?(transformer)\n              transforms[property_name] = transformer\n            end\n          end\n\n          def transformed_property(property_name, value)\n            transforms[property_name].call(value)\n          end\n\n          def transformation_exists?(name)\n            transforms.key? name\n          end\n\n          def translation_exists?(name)\n            translations_hash.key? name\n          end\n\n          def translations\n            @translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                translations[property_name] =\n                  if property_translations.size > 1\n                    property_translations.keys\n                  else\n                    property_translations.keys.first\n                  end\n              end\n            end\n          end\n\n          def inverse_translations\n            @inverse_translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                property_translations.each_key do |key|\n                  translations[key] = property_name\n                end\n              end\n            end\n          end\n\n          private\n\n          def define_translation(from, property_name, translator)\n            translations_hash[from][property_name] = translator\n          end\n\n          def define_writer_for_source_property(property)\n            define_method \"#{property}=\" do |val|\n              __translations[property].each do |name, with|\n                self[name] = with.respond_to?(:call) ? with.call(val) : val\n              end\n            end\n          end\n\n          def fail_self_transformation_error!(property_name)\n            raise ArgumentError,\n                  \"Property name (#{property_name}) and :from option must not be the same\"\n          end\n\n          def valid_transformer?(transformer)\n            transformer.respond_to? :call\n          end\n        end\n\n        module InstanceMethods\n          # Sets a value on the Dash in a Hash-like way.\n          #\n          # Note: Only works on pre-existing properties.\n          def []=(property, value)\n            if self.class.translation_exists? property\n              send(\"#{property}=\", value)\n\n              if self.class.transformation_exists? property\n                super property, self.class.transformed_property(property, value)\n              elsif self.class.properties.include?(property)\n                super(property, value)\n              end\n            elsif self.class.transformation_exists? property\n              super property, self.class.transformed_property(property, value)\n            elsif property_exists? property\n              super\n            end\n          end\n\n          # Deletes any keys that have a translation\n          def initialize_attributes(attributes)\n            return unless attributes\n            attributes_copy = attributes.dup.delete_if do |k, v|\n              if self.class.translations_hash.include?(k)\n                self[k] = v\n                true\n              end\n            end\n            super attributes_copy\n          end\n\n          # Raises an NoMethodError if the property doesn't exist\n          def property_exists?(property)\n            fail_no_property_error!(property) unless self.class.property?(property)\n            true\n          end\n\n          private\n\n          def __translations\n            self.class.translations_hash\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "translations", "signature": "def translations @translations ||= {}.tap do |translations|", "start_line": 102, "end_line": 113}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 190}
{"function_name": "[]=", "file_path": "hashie/lib/hashie/extensions/dash/property_translation.rb", "focal_code": "def []=(property, value)\n            if self.class.translation_exists? property\n              send(\"#{property}=\", value)\n\n              if self.class.transformation_exists? property\n                super property, self.class.transformed_property(property, value)\n              elsif self.class.properties.include?(property)\n                super(property, value)\n              end\n            elsif self.class.transformation_exists? property\n              super property, self.class.transformed_property(property, value)\n            elsif property_exists? property\n              super\n            end\n          end", "file_content": "module Hashie\n  module Extensions\n    module Dash\n      # Extends a Dash with the ability to remap keys from a source hash.\n      #\n      # Property translation is useful when you need to read data from another\n      # application -- such as a Java API -- where the keys are named\n      # differently from Ruby conventions.\n      #\n      # == Example from inconsistent APIs\n      #\n      #   class PersonHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :first_name, from :firstName\n      #     property :last_name, from: :lastName\n      #     property :first_name, from: :f_name\n      #     property :last_name, from: :l_name\n      #   end\n      #\n      #   person = PersonHash.new(firstName: 'Michael', l_name: 'Bleigh')\n      #   person[:first_name]  #=> 'Michael'\n      #   person[:last_name]   #=> 'Bleigh'\n      #\n      # You can also use a lambda to translate the value. This is particularly\n      # useful when you want to ensure the type of data you're wrapping.\n      #\n      # == Example using translation lambdas\n      #\n      #   class DataModelHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :id, transform_with: ->(value) { value.to_i }\n      #     property :created_at, from: :created, with: ->(value) { Time.parse(value) }\n      #   end\n      #\n      #   model = DataModelHash.new(id: '123', created: '2014-04-25 22:35:28')\n      #   model.id.class          #=> Integer (Fixnum if you are using Ruby 2.3 or lower)\n      #   model.created_at.class  #=> Time\n      module PropertyTranslation\n        def self.included(base)\n          base.instance_variable_set(:@transforms, {})\n          base.instance_variable_set(:@translations_hash, ::Hash.new { |hash, key| hash[key] = {} })\n          base.extend(ClassMethods)\n          base.send(:include, InstanceMethods)\n        end\n\n        module ClassMethods\n          attr_reader :transforms, :translations_hash\n\n          # Ensures that any inheriting classes maintain their translations.\n          #\n          # * <tt>:default</tt> - The class inheriting the translations.\n          def inherited(klass)\n            super\n            klass.instance_variable_set(:@transforms, transforms.dup)\n            klass.instance_variable_set(:@translations_hash, translations_hash.dup)\n          end\n\n          def permitted_input_keys\n            @permitted_input_keys ||=\n              properties\n              .map { |property| inverse_translations.fetch property, property }\n          end\n\n          # Defines a property on the Trash. Options are as follows:\n          #\n          # * <tt>:default</tt> - Specify a default value for this property, to be\n          # returned before a value is set on the property in a new Dash.\n          # * <tt>:from</tt> - Specify the original key name that will be write only.\n          # * <tt>:with</tt> - Specify a lambda to be used to convert value.\n          # * <tt>:transform_with</tt> - Specify a lambda to be used to convert value\n          # without using the :from option. It transform the property itself.\n          def property(property_name, options = {})\n            super\n\n            from = options[:from]\n            converter = options[:with]\n            transformer = options[:transform_with]\n\n            if from\n              fail_self_transformation_error!(property_name) if property_name == from\n              define_translation(from, property_name, converter || transformer)\n              define_writer_for_source_property(from)\n            elsif valid_transformer?(transformer)\n              transforms[property_name] = transformer\n            end\n          end\n\n          def transformed_property(property_name, value)\n            transforms[property_name].call(value)\n          end\n\n          def transformation_exists?(name)\n            transforms.key? name\n          end\n\n          def translation_exists?(name)\n            translations_hash.key? name\n          end\n\n          def translations\n            @translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                translations[property_name] =\n                  if property_translations.size > 1\n                    property_translations.keys\n                  else\n                    property_translations.keys.first\n                  end\n              end\n            end\n          end\n\n          def inverse_translations\n            @inverse_translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                property_translations.each_key do |key|\n                  translations[key] = property_name\n                end\n              end\n            end\n          end\n\n          private\n\n          def define_translation(from, property_name, translator)\n            translations_hash[from][property_name] = translator\n          end\n\n          def define_writer_for_source_property(property)\n            define_method \"#{property}=\" do |val|\n              __translations[property].each do |name, with|\n                self[name] = with.respond_to?(:call) ? with.call(val) : val\n              end\n            end\n          end\n\n          def fail_self_transformation_error!(property_name)\n            raise ArgumentError,\n                  \"Property name (#{property_name}) and :from option must not be the same\"\n          end\n\n          def valid_transformer?(transformer)\n            transformer.respond_to? :call\n          end\n        end\n\n        module InstanceMethods\n          # Sets a value on the Dash in a Hash-like way.\n          #\n          # Note: Only works on pre-existing properties.\n          def []=(property, value)\n            if self.class.translation_exists? property\n              send(\"#{property}=\", value)\n\n              if self.class.transformation_exists? property\n                super property, self.class.transformed_property(property, value)\n              elsif self.class.properties.include?(property)\n                super(property, value)\n              end\n            elsif self.class.transformation_exists? property\n              super property, self.class.transformed_property(property, value)\n            elsif property_exists? property\n              super\n            end\n          end\n\n          # Deletes any keys that have a translation\n          def initialize_attributes(attributes)\n            return unless attributes\n            attributes_copy = attributes.dup.delete_if do |k, v|\n              if self.class.translations_hash.include?(k)\n                self[k] = v\n                true\n              end\n            end\n            super attributes_copy\n          end\n\n          # Raises an NoMethodError if the property doesn't exist\n          def property_exists?(property)\n            fail_no_property_error!(property) unless self.class.property?(property)\n            true\n          end\n\n          private\n\n          def __translations\n            self.class.translations_hash\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "[]=", "signature": "def []", "start_line": 153, "end_line": 167}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 191}
{"function_name": "initialize_attributes", "file_path": "hashie/lib/hashie/extensions/dash/property_translation.rb", "focal_code": "def initialize_attributes(attributes)\n            return unless attributes\n            attributes_copy = attributes.dup.delete_if do |k, v|\n              if self.class.translations_hash.include?(k)\n                self[k] = v\n                true\n              end\n            end\n            super attributes_copy\n          end", "file_content": "module Hashie\n  module Extensions\n    module Dash\n      # Extends a Dash with the ability to remap keys from a source hash.\n      #\n      # Property translation is useful when you need to read data from another\n      # application -- such as a Java API -- where the keys are named\n      # differently from Ruby conventions.\n      #\n      # == Example from inconsistent APIs\n      #\n      #   class PersonHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :first_name, from :firstName\n      #     property :last_name, from: :lastName\n      #     property :first_name, from: :f_name\n      #     property :last_name, from: :l_name\n      #   end\n      #\n      #   person = PersonHash.new(firstName: 'Michael', l_name: 'Bleigh')\n      #   person[:first_name]  #=> 'Michael'\n      #   person[:last_name]   #=> 'Bleigh'\n      #\n      # You can also use a lambda to translate the value. This is particularly\n      # useful when you want to ensure the type of data you're wrapping.\n      #\n      # == Example using translation lambdas\n      #\n      #   class DataModelHash < Hashie::Dash\n      #     include Hashie::Extensions::Dash::PropertyTranslation\n      #\n      #     property :id, transform_with: ->(value) { value.to_i }\n      #     property :created_at, from: :created, with: ->(value) { Time.parse(value) }\n      #   end\n      #\n      #   model = DataModelHash.new(id: '123', created: '2014-04-25 22:35:28')\n      #   model.id.class          #=> Integer (Fixnum if you are using Ruby 2.3 or lower)\n      #   model.created_at.class  #=> Time\n      module PropertyTranslation\n        def self.included(base)\n          base.instance_variable_set(:@transforms, {})\n          base.instance_variable_set(:@translations_hash, ::Hash.new { |hash, key| hash[key] = {} })\n          base.extend(ClassMethods)\n          base.send(:include, InstanceMethods)\n        end\n\n        module ClassMethods\n          attr_reader :transforms, :translations_hash\n\n          # Ensures that any inheriting classes maintain their translations.\n          #\n          # * <tt>:default</tt> - The class inheriting the translations.\n          def inherited(klass)\n            super\n            klass.instance_variable_set(:@transforms, transforms.dup)\n            klass.instance_variable_set(:@translations_hash, translations_hash.dup)\n          end\n\n          def permitted_input_keys\n            @permitted_input_keys ||=\n              properties\n              .map { |property| inverse_translations.fetch property, property }\n          end\n\n          # Defines a property on the Trash. Options are as follows:\n          #\n          # * <tt>:default</tt> - Specify a default value for this property, to be\n          # returned before a value is set on the property in a new Dash.\n          # * <tt>:from</tt> - Specify the original key name that will be write only.\n          # * <tt>:with</tt> - Specify a lambda to be used to convert value.\n          # * <tt>:transform_with</tt> - Specify a lambda to be used to convert value\n          # without using the :from option. It transform the property itself.\n          def property(property_name, options = {})\n            super\n\n            from = options[:from]\n            converter = options[:with]\n            transformer = options[:transform_with]\n\n            if from\n              fail_self_transformation_error!(property_name) if property_name == from\n              define_translation(from, property_name, converter || transformer)\n              define_writer_for_source_property(from)\n            elsif valid_transformer?(transformer)\n              transforms[property_name] = transformer\n            end\n          end\n\n          def transformed_property(property_name, value)\n            transforms[property_name].call(value)\n          end\n\n          def transformation_exists?(name)\n            transforms.key? name\n          end\n\n          def translation_exists?(name)\n            translations_hash.key? name\n          end\n\n          def translations\n            @translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                translations[property_name] =\n                  if property_translations.size > 1\n                    property_translations.keys\n                  else\n                    property_translations.keys.first\n                  end\n              end\n            end\n          end\n\n          def inverse_translations\n            @inverse_translations ||= {}.tap do |translations|\n              translations_hash.each do |(property_name, property_translations)|\n                property_translations.each_key do |key|\n                  translations[key] = property_name\n                end\n              end\n            end\n          end\n\n          private\n\n          def define_translation(from, property_name, translator)\n            translations_hash[from][property_name] = translator\n          end\n\n          def define_writer_for_source_property(property)\n            define_method \"#{property}=\" do |val|\n              __translations[property].each do |name, with|\n                self[name] = with.respond_to?(:call) ? with.call(val) : val\n              end\n            end\n          end\n\n          def fail_self_transformation_error!(property_name)\n            raise ArgumentError,\n                  \"Property name (#{property_name}) and :from option must not be the same\"\n          end\n\n          def valid_transformer?(transformer)\n            transformer.respond_to? :call\n          end\n        end\n\n        module InstanceMethods\n          # Sets a value on the Dash in a Hash-like way.\n          #\n          # Note: Only works on pre-existing properties.\n          def []=(property, value)\n            if self.class.translation_exists? property\n              send(\"#{property}=\", value)\n\n              if self.class.transformation_exists? property\n                super property, self.class.transformed_property(property, value)\n              elsif self.class.properties.include?(property)\n                super(property, value)\n              end\n            elsif self.class.transformation_exists? property\n              super property, self.class.transformed_property(property, value)\n            elsif property_exists? property\n              super\n            end\n          end\n\n          # Deletes any keys that have a translation\n          def initialize_attributes(attributes)\n            return unless attributes\n            attributes_copy = attributes.dup.delete_if do |k, v|\n              if self.class.translations_hash.include?(k)\n                self[k] = v\n                true\n              end\n            end\n            super attributes_copy\n          end\n\n          # Raises an NoMethodError if the property doesn't exist\n          def property_exists?(property)\n            fail_no_property_error!(property) unless self.class.property?(property)\n            true\n          end\n\n          private\n\n          def __translations\n            self.class.translations_hash\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize_attributes", "signature": "def initialize_attributes(attributes)", "start_line": 170, "end_line": 179}, "metadata": {"module": "Hashie", "class_name": "", "class_signature": ""}, "task_id": 192}
{"function_name": "initialize", "file_path": "hashie/lib/hashie/extensions/mash/define_accessors.rb", "focal_code": "def initialize\n            mod = self\n            define_method(:method_missing) do |method_name, *args, &block|\n              key, suffix = method_name_and_suffix(method_name)\n              case suffix\n              when '='.freeze\n                mod.define_writer(key, method_name)\n              when '?'.freeze\n                mod.define_predicate(key, method_name)\n              when '!'.freeze\n                mod.define_initializing_reader(key, method_name)\n              when '_'.freeze\n                mod.define_underbang_reader(key, method_name)\n              else\n                mod.define_reader(key, method_name)\n              end\n              send(method_name, *args, &block)\n            end\n          end", "file_content": "module Hashie\n  module Extensions\n    module Mash\n      module DefineAccessors\n        def self.included(klass)\n          klass.class_eval do\n            mod = Ext.new\n            include mod\n          end\n        end\n\n        def self.extended(obj)\n          included(obj.singleton_class)\n        end\n\n        class Ext < Module\n          def initialize\n            mod = self\n            define_method(:method_missing) do |method_name, *args, &block|\n              key, suffix = method_name_and_suffix(method_name)\n              case suffix\n              when '='.freeze\n                mod.define_writer(key, method_name)\n              when '?'.freeze\n                mod.define_predicate(key, method_name)\n              when '!'.freeze\n                mod.define_initializing_reader(key, method_name)\n              when '_'.freeze\n                mod.define_underbang_reader(key, method_name)\n              else\n                mod.define_reader(key, method_name)\n              end\n              send(method_name, *args, &block)\n            end\n          end\n\n          def define_reader(key, method_name)\n            define_method(method_name) do |&block|\n              if key? method_name\n                self.[](method_name, &block)\n              else\n                self.[](key, &block)\n              end\n            end\n          end\n\n          def define_writer(key, method_name)\n            define_method(method_name) do |value = nil|\n              if key? method_name\n                self.[](method_name, &proc)\n              else\n                assign_property(key, value)\n              end\n            end\n          end\n\n          def define_predicate(key, method_name)\n            define_method(method_name) do\n              if key? method_name\n                self.[](method_name, &proc)\n              else\n                !!self[key]\n              end\n            end\n          end\n\n          def define_initializing_reader(key, method_name)\n            define_method(method_name) do\n              if key? method_name\n                self.[](method_name, &proc)\n              else\n                initializing_reader(key)\n              end\n            end\n          end\n\n          def define_underbang_reader(key, method_name)\n            define_method(method_name) do\n              if key? method_name\n                self.[](key, &proc)\n              else\n                underbang_reader(key)\n              end\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize mod = self", "start_line": 17, "end_line": 35}, "metadata": {"module": "Hashie", "class_name": "Ext", "class_signature": "class Ext < < Module"}, "task_id": 193}
{"function_name": "connection", "file_path": "httparty/lib/httparty/connection_adapter.rb", "focal_code": "def connection\n      host = clean_host(uri.host)\n      port = uri.port || (uri.scheme == 'https' ? 443 : 80)\n      if options.key?(:http_proxyaddr)\n        http = Net::HTTP.new(\n          host,\n          port,\n          options[:http_proxyaddr],\n          options[:http_proxyport],\n          options[:http_proxyuser],\n          options[:http_proxypass]\n        )\n      else\n        http = Net::HTTP.new(host, port)\n      end\n\n      http.use_ssl = ssl_implied?(uri)\n\n      attach_ssl_certificates(http, options)\n\n      if add_timeout?(options[:timeout])\n        http.open_timeout = options[:timeout]\n        http.read_timeout = options[:timeout]\n        http.write_timeout = options[:timeout]\n      end\n\n      if add_timeout?(options[:read_timeout])\n        http.read_timeout = options[:read_timeout]\n      end\n\n      if add_timeout?(options[:open_timeout])\n        http.open_timeout = options[:open_timeout]\n      end\n\n      if add_timeout?(options[:write_timeout])\n        http.write_timeout = options[:write_timeout]\n      end\n\n      if add_max_retries?(options[:max_retries])\n        http.max_retries = options[:max_retries]\n      end\n\n      if options[:debug_output]\n        http.set_debug_output(options[:debug_output])\n      end\n\n      if options[:ciphers]\n        http.ciphers = options[:ciphers]\n      end\n\n      # Bind to a specific local address or port\n      #\n      # @see https://bugs.ruby-lang.org/issues/6617\n      if options[:local_host]\n        http.local_host = options[:local_host]\n      end\n\n      if options[:local_port]\n        http.local_port = options[:local_port]\n      end\n\n      http\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  # Default connection adapter that returns a new Net::HTTP each time\n  #\n  # == Custom Connection Factories\n  #\n  # If you like to implement your own connection adapter, subclassing\n  # HTTParty::ConnectionAdapter will make it easier. Just override\n  # the #connection method. The uri and options attributes will have\n  # all the info you need to construct your http connection. Whatever\n  # you return from your connection method needs to adhere to the\n  # Net::HTTP interface as this is what HTTParty expects.\n  #\n  # @example log the uri and options\n  #   class LoggingConnectionAdapter < HTTParty::ConnectionAdapter\n  #     def connection\n  #       puts uri\n  #       puts options\n  #       Net::HTTP.new(uri)\n  #     end\n  #   end\n  #\n  # @example count number of http calls\n  #   class CountingConnectionAdapter < HTTParty::ConnectionAdapter\n  #     @@count = 0\n  #\n  #     self.count\n  #       @@count\n  #     end\n  #\n  #     def connection\n  #       self.count += 1\n  #       super\n  #     end\n  #   end\n  #\n  # === Configuration\n  # There is lots of configuration data available for your connection adapter\n  # in the #options attribute. It is up to you to interpret them within your\n  # connection adapter. Take a look at the implementation of\n  # HTTParty::ConnectionAdapter#connection for examples of how they are used.\n  # The keys used in options are\n  # * :+timeout+: timeout in seconds\n  # * :+open_timeout+: http connection open_timeout in seconds, overrides timeout if set\n  # * :+read_timeout+: http connection read_timeout in seconds, overrides timeout if set\n  # * :+write_timeout+: http connection write_timeout in seconds, overrides timeout if set (Ruby >= 2.6.0 required)\n  # * :+debug_output+: see HTTParty::ClassMethods.debug_output.\n  # * :+cert_store+: contains certificate data. see method 'attach_ssl_certificates'\n  # * :+pem+: contains pem client certificate data. see method 'attach_ssl_certificates'\n  # * :+p12+: contains PKCS12 client client certificate data.  see method 'attach_ssl_certificates'\n  # * :+verify+: verify the server’s certificate against the ca certificate.\n  # * :+verify_peer+: set to false to turn off server verification but still send client certificate\n  # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.\n  # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.\n  # * :+ssl_version+: SSL versions to allow. see method 'attach_ssl_certificates'\n  # * :+ciphers+: The list of SSL ciphers to support\n  # * :+connection_adapter_options+: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter\n  # * :+local_host+: The local address to bind to\n  # * :+local_port+: The local port to bind to\n  # * :+http_proxyaddr+: HTTP Proxy address\n  # * :+http_proxyport+: HTTP Proxy port\n  # * :+http_proxyuser+: HTTP Proxy user\n  # * :+http_proxypass+: HTTP Proxy password\n  #\n  # === Inherited methods\n  # * :+clean_host+: Method used to sanitize host names\n\n  class ConnectionAdapter\n    # Private: Regex used to strip brackets from IPv6 URIs.\n    StripIpv6BracketsRegex = /\\A\\[(.*)\\]\\z/\n\n    OPTION_DEFAULTS = {\n      verify: true,\n      verify_peer: true\n    }\n\n    # Public\n    def self.call(uri, options)\n      new(uri, options).connection\n    end\n\n    def self.default_cert_store\n      @default_cert_store ||= OpenSSL::X509::Store.new.tap do |cert_store|\n        cert_store.set_default_paths\n      end\n    end\n\n    attr_reader :uri, :options\n\n    def initialize(uri, options = {})\n      uri_adapter = options[:uri_adapter] || URI\n      raise ArgumentError, \"uri must be a #{uri_adapter}, not a #{uri.class}\" unless uri.is_a? uri_adapter\n\n      @uri = uri\n      @options = OPTION_DEFAULTS.merge(options)\n    end\n\n    def connection\n      host = clean_host(uri.host)\n      port = uri.port || (uri.scheme == 'https' ? 443 : 80)\n      if options.key?(:http_proxyaddr)\n        http = Net::HTTP.new(\n          host,\n          port,\n          options[:http_proxyaddr],\n          options[:http_proxyport],\n          options[:http_proxyuser],\n          options[:http_proxypass]\n        )\n      else\n        http = Net::HTTP.new(host, port)\n      end\n\n      http.use_ssl = ssl_implied?(uri)\n\n      attach_ssl_certificates(http, options)\n\n      if add_timeout?(options[:timeout])\n        http.open_timeout = options[:timeout]\n        http.read_timeout = options[:timeout]\n        http.write_timeout = options[:timeout]\n      end\n\n      if add_timeout?(options[:read_timeout])\n        http.read_timeout = options[:read_timeout]\n      end\n\n      if add_timeout?(options[:open_timeout])\n        http.open_timeout = options[:open_timeout]\n      end\n\n      if add_timeout?(options[:write_timeout])\n        http.write_timeout = options[:write_timeout]\n      end\n\n      if add_max_retries?(options[:max_retries])\n        http.max_retries = options[:max_retries]\n      end\n\n      if options[:debug_output]\n        http.set_debug_output(options[:debug_output])\n      end\n\n      if options[:ciphers]\n        http.ciphers = options[:ciphers]\n      end\n\n      # Bind to a specific local address or port\n      #\n      # @see https://bugs.ruby-lang.org/issues/6617\n      if options[:local_host]\n        http.local_host = options[:local_host]\n      end\n\n      if options[:local_port]\n        http.local_port = options[:local_port]\n      end\n\n      http\n    end\n\n    private\n\n    def add_timeout?(timeout)\n      timeout && (timeout.is_a?(Integer) || timeout.is_a?(Float))\n    end\n\n    def add_max_retries?(max_retries)\n      max_retries && max_retries.is_a?(Integer) && max_retries >= 0\n    end\n\n    def clean_host(host)\n      strip_ipv6_brackets(host)\n    end\n\n    def strip_ipv6_brackets(host)\n      StripIpv6BracketsRegex =~ host ? $1 : host\n    end\n\n    def ssl_implied?(uri)\n      uri.port == 443 || uri.scheme == 'https'\n    end\n\n    def verify_ssl_certificate?\n      !(options[:verify] == false || options[:verify_peer] == false)\n    end\n\n    def attach_ssl_certificates(http, options)\n      if http.use_ssl?\n        if options.fetch(:verify, true)\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n          if options[:cert_store]\n            http.cert_store = options[:cert_store]\n          else\n            # Use the default cert store by default, i.e. system ca certs\n            http.cert_store = self.class.default_cert_store\n          end\n        else\n          http.verify_mode = OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # Client certificate authentication\n        # Note: options[:pem] must contain the content of a PEM file having the private key appended\n        if options[:pem]\n          http.cert = OpenSSL::X509::Certificate.new(options[:pem])\n          http.key = OpenSSL::PKey.read(options[:pem], options[:pem_password])\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # PKCS12 client certificate authentication\n        if options[:p12]\n          p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password])\n          http.cert = p12.certificate\n          http.key = p12.key\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # SSL certificate authority file and/or directory\n        if options[:ssl_ca_file]\n          http.ca_file = options[:ssl_ca_file]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        if options[:ssl_ca_path]\n          http.ca_path = options[:ssl_ca_path]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        # This is only Ruby 1.9+\n        if options[:ssl_version] && http.respond_to?(:ssl_version=)\n          http.ssl_version = options[:ssl_version]\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "connection", "signature": "def connection host = clean_host(uri.host)", "start_line": 99, "end_line": 161}, "metadata": {"module": "HTTParty", "class_name": "ConnectionAdapter", "class_signature": "class ConnectionAdapter"}, "task_id": 194}
{"function_name": "attach_ssl_certificates", "file_path": "httparty/lib/httparty/connection_adapter.rb", "focal_code": "def attach_ssl_certificates(http, options)\n      if http.use_ssl?\n        if options.fetch(:verify, true)\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n          if options[:cert_store]\n            http.cert_store = options[:cert_store]\n          else\n            # Use the default cert store by default, i.e. system ca certs\n            http.cert_store = self.class.default_cert_store\n          end\n        else\n          http.verify_mode = OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # Client certificate authentication\n        # Note: options[:pem] must contain the content of a PEM file having the private key appended\n        if options[:pem]\n          http.cert = OpenSSL::X509::Certificate.new(options[:pem])\n          http.key = OpenSSL::PKey.read(options[:pem], options[:pem_password])\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # PKCS12 client certificate authentication\n        if options[:p12]\n          p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password])\n          http.cert = p12.certificate\n          http.key = p12.key\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # SSL certificate authority file and/or directory\n        if options[:ssl_ca_file]\n          http.ca_file = options[:ssl_ca_file]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        if options[:ssl_ca_path]\n          http.ca_path = options[:ssl_ca_path]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        # This is only Ruby 1.9+\n        if options[:ssl_version] && http.respond_to?(:ssl_version=)\n          http.ssl_version = options[:ssl_version]\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  # Default connection adapter that returns a new Net::HTTP each time\n  #\n  # == Custom Connection Factories\n  #\n  # If you like to implement your own connection adapter, subclassing\n  # HTTParty::ConnectionAdapter will make it easier. Just override\n  # the #connection method. The uri and options attributes will have\n  # all the info you need to construct your http connection. Whatever\n  # you return from your connection method needs to adhere to the\n  # Net::HTTP interface as this is what HTTParty expects.\n  #\n  # @example log the uri and options\n  #   class LoggingConnectionAdapter < HTTParty::ConnectionAdapter\n  #     def connection\n  #       puts uri\n  #       puts options\n  #       Net::HTTP.new(uri)\n  #     end\n  #   end\n  #\n  # @example count number of http calls\n  #   class CountingConnectionAdapter < HTTParty::ConnectionAdapter\n  #     @@count = 0\n  #\n  #     self.count\n  #       @@count\n  #     end\n  #\n  #     def connection\n  #       self.count += 1\n  #       super\n  #     end\n  #   end\n  #\n  # === Configuration\n  # There is lots of configuration data available for your connection adapter\n  # in the #options attribute. It is up to you to interpret them within your\n  # connection adapter. Take a look at the implementation of\n  # HTTParty::ConnectionAdapter#connection for examples of how they are used.\n  # The keys used in options are\n  # * :+timeout+: timeout in seconds\n  # * :+open_timeout+: http connection open_timeout in seconds, overrides timeout if set\n  # * :+read_timeout+: http connection read_timeout in seconds, overrides timeout if set\n  # * :+write_timeout+: http connection write_timeout in seconds, overrides timeout if set (Ruby >= 2.6.0 required)\n  # * :+debug_output+: see HTTParty::ClassMethods.debug_output.\n  # * :+cert_store+: contains certificate data. see method 'attach_ssl_certificates'\n  # * :+pem+: contains pem client certificate data. see method 'attach_ssl_certificates'\n  # * :+p12+: contains PKCS12 client client certificate data.  see method 'attach_ssl_certificates'\n  # * :+verify+: verify the server’s certificate against the ca certificate.\n  # * :+verify_peer+: set to false to turn off server verification but still send client certificate\n  # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.\n  # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.\n  # * :+ssl_version+: SSL versions to allow. see method 'attach_ssl_certificates'\n  # * :+ciphers+: The list of SSL ciphers to support\n  # * :+connection_adapter_options+: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter\n  # * :+local_host+: The local address to bind to\n  # * :+local_port+: The local port to bind to\n  # * :+http_proxyaddr+: HTTP Proxy address\n  # * :+http_proxyport+: HTTP Proxy port\n  # * :+http_proxyuser+: HTTP Proxy user\n  # * :+http_proxypass+: HTTP Proxy password\n  #\n  # === Inherited methods\n  # * :+clean_host+: Method used to sanitize host names\n\n  class ConnectionAdapter\n    # Private: Regex used to strip brackets from IPv6 URIs.\n    StripIpv6BracketsRegex = /\\A\\[(.*)\\]\\z/\n\n    OPTION_DEFAULTS = {\n      verify: true,\n      verify_peer: true\n    }\n\n    # Public\n    def self.call(uri, options)\n      new(uri, options).connection\n    end\n\n    def self.default_cert_store\n      @default_cert_store ||= OpenSSL::X509::Store.new.tap do |cert_store|\n        cert_store.set_default_paths\n      end\n    end\n\n    attr_reader :uri, :options\n\n    def initialize(uri, options = {})\n      uri_adapter = options[:uri_adapter] || URI\n      raise ArgumentError, \"uri must be a #{uri_adapter}, not a #{uri.class}\" unless uri.is_a? uri_adapter\n\n      @uri = uri\n      @options = OPTION_DEFAULTS.merge(options)\n    end\n\n    def connection\n      host = clean_host(uri.host)\n      port = uri.port || (uri.scheme == 'https' ? 443 : 80)\n      if options.key?(:http_proxyaddr)\n        http = Net::HTTP.new(\n          host,\n          port,\n          options[:http_proxyaddr],\n          options[:http_proxyport],\n          options[:http_proxyuser],\n          options[:http_proxypass]\n        )\n      else\n        http = Net::HTTP.new(host, port)\n      end\n\n      http.use_ssl = ssl_implied?(uri)\n\n      attach_ssl_certificates(http, options)\n\n      if add_timeout?(options[:timeout])\n        http.open_timeout = options[:timeout]\n        http.read_timeout = options[:timeout]\n        http.write_timeout = options[:timeout]\n      end\n\n      if add_timeout?(options[:read_timeout])\n        http.read_timeout = options[:read_timeout]\n      end\n\n      if add_timeout?(options[:open_timeout])\n        http.open_timeout = options[:open_timeout]\n      end\n\n      if add_timeout?(options[:write_timeout])\n        http.write_timeout = options[:write_timeout]\n      end\n\n      if add_max_retries?(options[:max_retries])\n        http.max_retries = options[:max_retries]\n      end\n\n      if options[:debug_output]\n        http.set_debug_output(options[:debug_output])\n      end\n\n      if options[:ciphers]\n        http.ciphers = options[:ciphers]\n      end\n\n      # Bind to a specific local address or port\n      #\n      # @see https://bugs.ruby-lang.org/issues/6617\n      if options[:local_host]\n        http.local_host = options[:local_host]\n      end\n\n      if options[:local_port]\n        http.local_port = options[:local_port]\n      end\n\n      http\n    end\n\n    private\n\n    def add_timeout?(timeout)\n      timeout && (timeout.is_a?(Integer) || timeout.is_a?(Float))\n    end\n\n    def add_max_retries?(max_retries)\n      max_retries && max_retries.is_a?(Integer) && max_retries >= 0\n    end\n\n    def clean_host(host)\n      strip_ipv6_brackets(host)\n    end\n\n    def strip_ipv6_brackets(host)\n      StripIpv6BracketsRegex =~ host ? $1 : host\n    end\n\n    def ssl_implied?(uri)\n      uri.port == 443 || uri.scheme == 'https'\n    end\n\n    def verify_ssl_certificate?\n      !(options[:verify] == false || options[:verify_peer] == false)\n    end\n\n    def attach_ssl_certificates(http, options)\n      if http.use_ssl?\n        if options.fetch(:verify, true)\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n          if options[:cert_store]\n            http.cert_store = options[:cert_store]\n          else\n            # Use the default cert store by default, i.e. system ca certs\n            http.cert_store = self.class.default_cert_store\n          end\n        else\n          http.verify_mode = OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # Client certificate authentication\n        # Note: options[:pem] must contain the content of a PEM file having the private key appended\n        if options[:pem]\n          http.cert = OpenSSL::X509::Certificate.new(options[:pem])\n          http.key = OpenSSL::PKey.read(options[:pem], options[:pem_password])\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # PKCS12 client certificate authentication\n        if options[:p12]\n          p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password])\n          http.cert = p12.certificate\n          http.key = p12.key\n          http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE\n        end\n\n        # SSL certificate authority file and/or directory\n        if options[:ssl_ca_file]\n          http.ca_file = options[:ssl_ca_file]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        if options[:ssl_ca_path]\n          http.ca_path = options[:ssl_ca_path]\n          http.verify_mode = OpenSSL::SSL::VERIFY_PEER\n        end\n\n        # This is only Ruby 1.9+\n        if options[:ssl_version] && http.respond_to?(:ssl_version=)\n          http.ssl_version = options[:ssl_version]\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "attach_ssl_certificates", "signature": "def attach_ssl_certificates(http, options)", "start_line": 189, "end_line": 235}, "metadata": {"module": "HTTParty", "class_name": "ConnectionAdapter", "class_signature": "class ConnectionAdapter"}, "task_id": 195}
{"function_name": "add_cookies", "file_path": "httparty/lib/httparty/cookie_hash.rb", "focal_code": "def add_cookies(data)\n    case data\n    when Hash\n      merge!(data)\n    when String\n      data.split('; ').each do |cookie|\n        key, value = cookie.split('=', 2)\n        self[key.to_sym] = value if key\n      end\n    else\n      raise \"add_cookies only takes a Hash or a String\"\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nclass HTTParty::CookieHash < Hash #:nodoc:\n  CLIENT_COOKIES = %w(path expires domain path secure httponly samesite)\n\n  def add_cookies(data)\n    case data\n    when Hash\n      merge!(data)\n    when String\n      data.split('; ').each do |cookie|\n        key, value = cookie.split('=', 2)\n        self[key.to_sym] = value if key\n      end\n    else\n      raise \"add_cookies only takes a Hash or a String\"\n    end\n  end\n\n  def to_cookie_string\n    select { |k, v| !CLIENT_COOKIES.include?(k.to_s.downcase) }.collect { |k, v| \"#{k}=#{v}\" }.join('; ')\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add_cookies", "signature": "def add_cookies(data)", "start_line": 6, "end_line": 18}, "metadata": {"module": "", "class_name": "HTTParty::CookieHash", "class_signature": "class HTTParty::CookieHash < < Hash"}, "task_id": 196}
{"function_name": "lzw", "file_path": "httparty/lib/httparty/decompressor.rb", "focal_code": "def lzw\n      begin\n        if defined?(::LZWS::String)\n          ::LZWS::String.decompress(body)\n        elsif defined?(::LZW::Simple)\n          ::LZW::Simple.new.decompress(body)\n        end\n      rescue StandardError\n        nil\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  # Decompresses the response body based on the Content-Encoding header.\n  #\n  # Net::HTTP automatically decompresses Content-Encoding values \"gzip\" and \"deflate\".\n  # This class will handle \"br\" (Brotli) and \"compress\" (LZW) if the requisite\n  # gems are installed. Otherwise, it returns nil if the body data cannot be\n  # decompressed.\n  #\n  # @abstract Read the HTTP Compression section for more information.\n  class Decompressor\n\n    # \"gzip\" and \"deflate\" are handled by Net::HTTP\n    # hence they do not need to be handled by HTTParty\n    SupportedEncodings = {\n      'none'     => :none,\n      'identity' => :none,\n      'br'       => :brotli,\n      'compress' => :lzw,\n      'zstd'     => :zstd\n    }.freeze\n\n    # The response body of the request\n    # @return [String]\n    attr_reader :body\n\n    # The Content-Encoding algorithm used to encode the body\n    # @return [Symbol] e.g. :gzip\n    attr_reader :encoding\n\n    # @param [String] body - the response body of the request\n    # @param [Symbol] encoding - the Content-Encoding algorithm used to encode the body\n    def initialize(body, encoding)\n      @body = body\n      @encoding = encoding\n    end\n\n    # Perform decompression on the response body\n    # @return [String] the decompressed body\n    # @return [nil] when the response body is nil or cannot decompressed\n    def decompress\n      return nil if body.nil?\n      return body if encoding.nil? || encoding.strip.empty?\n\n      if supports_encoding?\n        decompress_supported_encoding\n      else\n        nil\n      end\n    end\n\n    protected\n\n    def supports_encoding?\n      SupportedEncodings.keys.include?(encoding)\n    end\n\n    def decompress_supported_encoding\n      method = SupportedEncodings[encoding]\n      if respond_to?(method, true)\n        send(method)\n      else\n        raise NotImplementedError, \"#{self.class.name} has not implemented a decompression method for #{encoding.inspect} encoding.\"\n      end\n    end\n\n    def none\n      body\n    end\n\n    def brotli\n      return nil unless defined?(::Brotli)\n      begin\n        ::Brotli.inflate(body)\n      rescue StandardError\n        nil\n      end\n    end\n\n    def lzw\n      begin\n        if defined?(::LZWS::String)\n          ::LZWS::String.decompress(body)\n        elsif defined?(::LZW::Simple)\n          ::LZW::Simple.new.decompress(body)\n        end\n      rescue StandardError\n        nil\n      end\n    end\n\n    def zstd\n      return nil unless defined?(::Zstd)\n      begin\n        ::Zstd.decompress(body)\n      rescue StandardError\n        nil\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "lzw", "signature": "def lzw begin", "start_line": 81, "end_line": 91}, "metadata": {"module": "HTTParty", "class_name": "Decompressor", "class_signature": "class Decompressor"}, "task_id": 197}
{"function_name": "normalize_keys", "file_path": "httparty/lib/httparty/hash_conversions.rb", "focal_code": "def self.normalize_keys(key, value)\n      stack = []\n      normalized_keys = []\n\n      if value.respond_to?(:to_ary)\n        if value.empty?\n          normalized_keys << [\"#{key}[]\", '']\n        else\n          normalized_keys = value.to_ary.flat_map do |element|\n            normalize_keys(\"#{key}[]\", element)\n          end\n        end\n      elsif value.respond_to?(:to_hash)\n        stack << [key, value.to_hash]\n      else\n        normalized_keys << [key.to_s, value]\n      end\n\n      stack.each do |parent, hash|\n        hash.each do |child_key, child_value|\n          if child_value.respond_to?(:to_hash)\n            stack << [\"#{parent}[#{child_key}]\", child_value.to_hash]\n          elsif child_value.respond_to?(:to_ary)\n            child_value.to_ary.each do |v|\n              normalized_keys << normalize_keys(\"#{parent}[#{child_key}][]\", v).flatten\n            end\n          else\n            normalized_keys << normalize_keys(\"#{parent}[#{child_key}]\", child_value).flatten\n          end\n        end\n      end\n\n      normalized_keys\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  module HashConversions\n    # @return <String> This hash as a query string\n    #\n    # @example\n    #   { name: \"Bob\",\n    #     address: {\n    #       street: '111 Ruby Ave.',\n    #       city: 'Ruby Central',\n    #       phones: ['111-111-1111', '222-222-2222']\n    #     }\n    #   }.to_params\n    #     #=> \"name=Bob&address[city]=Ruby Central&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave.\"\n    def self.to_params(hash)\n      hash.to_hash.map { |k, v| normalize_param(k, v) }.join.chop\n    end\n\n    # @param key<Object> The key for the param.\n    # @param value<Object> The value for the param.\n    #\n    # @return <String> This key value pair as a param\n    #\n    # @example normalize_param(:name, \"Bob Jones\") #=> \"name=Bob%20Jones&\"\n    def self.normalize_param(key, value)\n      normalized_keys = normalize_keys(key, value)\n\n      normalized_keys.flatten.each_slice(2).inject(''.dup) do |string, (k, v)|\n        string << \"#{ERB::Util.url_encode(k)}=#{ERB::Util.url_encode(v.to_s)}&\"\n      end\n    end\n\n    def self.normalize_keys(key, value)\n      stack = []\n      normalized_keys = []\n\n      if value.respond_to?(:to_ary)\n        if value.empty?\n          normalized_keys << [\"#{key}[]\", '']\n        else\n          normalized_keys = value.to_ary.flat_map do |element|\n            normalize_keys(\"#{key}[]\", element)\n          end\n        end\n      elsif value.respond_to?(:to_hash)\n        stack << [key, value.to_hash]\n      else\n        normalized_keys << [key.to_s, value]\n      end\n\n      stack.each do |parent, hash|\n        hash.each do |child_key, child_value|\n          if child_value.respond_to?(:to_hash)\n            stack << [\"#{parent}[#{child_key}]\", child_value.to_hash]\n          elsif child_value.respond_to?(:to_ary)\n            child_value.to_ary.each do |v|\n              normalized_keys << normalize_keys(\"#{parent}[#{child_key}][]\", v).flatten\n            end\n          else\n            normalized_keys << normalize_keys(\"#{parent}[#{child_key}]\", child_value).flatten\n          end\n        end\n      end\n\n      normalized_keys\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "normalize_keys", "signature": "def self.normalize_keys(key, value)", "start_line": 36, "end_line": 69}, "metadata": {"module": "HTTParty", "class_name": "", "class_signature": ""}, "task_id": 198}
{"function_name": "process_dynamic_headers", "file_path": "httparty/lib/httparty/headers_processor.rb", "focal_code": "def process_dynamic_headers\n      options[:headers].each_with_object({}) do |header, processed_headers|\n        key, value = header\n        processed_headers[key] = if value.respond_to?(:call)\n                                   value.arity == 0 ? value.call : value.call(options)\n                                 else\n                                   value\n                                 end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  class HeadersProcessor\n    attr_reader :headers, :options\n\n    def initialize(headers, options)\n      @headers = headers\n      @options = options\n    end\n\n    def call\n      return unless options[:headers]\n\n      options[:headers] = headers.merge(options[:headers]) if headers.any?\n      options[:headers] = Utils.stringify_keys(process_dynamic_headers)\n    end\n\n    private\n\n    def process_dynamic_headers\n      options[:headers].each_with_object({}) do |header, processed_headers|\n        key, value = header\n        processed_headers[key] = if value.respond_to?(:call)\n                                   value.arity == 0 ? value.call : value.call(options)\n                                 else\n                                   value\n                                 end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "process_dynamic_headers", "signature": "def process_dynamic_headers options[:headers].each_with_object({}) do |header, processed_headers|", "start_line": 21, "end_line": 30}, "metadata": {"module": "HTTParty", "class_name": "HeadersProcessor", "class_signature": "class HeadersProcessor"}, "task_id": 199}
{"function_name": "hash_deep_dup", "file_path": "httparty/lib/httparty/module_inheritable_attributes.rb", "focal_code": "def self.hash_deep_dup(hash)\n      duplicate = hash.dup\n\n      duplicate.each_pair do |key, value|\n        if value.is_a?(Hash)\n          duplicate[key] = hash_deep_dup(value)\n        elsif value.is_a?(Proc)\n          duplicate[key] = value.dup\n        else\n          duplicate[key] = value\n        end\n      end\n\n      duplicate\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  module ModuleInheritableAttributes #:nodoc:\n    def self.included(base)\n      base.extend(ClassMethods)\n    end\n\n    # borrowed from Rails 3.2 ActiveSupport\n    def self.hash_deep_dup(hash)\n      duplicate = hash.dup\n\n      duplicate.each_pair do |key, value|\n        if value.is_a?(Hash)\n          duplicate[key] = hash_deep_dup(value)\n        elsif value.is_a?(Proc)\n          duplicate[key] = value.dup\n        else\n          duplicate[key] = value\n        end\n      end\n\n      duplicate\n    end\n\n    module ClassMethods #:nodoc:\n      def mattr_inheritable(*args)\n        @mattr_inheritable_attrs ||= [:mattr_inheritable_attrs]\n        @mattr_inheritable_attrs += args\n\n        args.each do |arg|\n          singleton_class.attr_accessor(arg)\n        end\n\n        @mattr_inheritable_attrs\n      end\n\n      def inherited(subclass)\n        super\n        @mattr_inheritable_attrs.each do |inheritable_attribute|\n          ivar = :\"@#{inheritable_attribute}\"\n          subclass.instance_variable_set(ivar, instance_variable_get(ivar).clone)\n\n          if instance_variable_get(ivar).respond_to?(:merge)\n            subclass.class_eval <<~RUBY, __FILE__, __LINE__ + 1\n              def self.#{inheritable_attribute}\n                duplicate = ModuleInheritableAttributes.hash_deep_dup(#{ivar})\n                #{ivar} = superclass.#{inheritable_attribute}.merge(duplicate)\n              end\n            RUBY\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "hash_deep_dup", "signature": "def self.hash_deep_dup(hash)", "start_line": 10, "end_line": 24}, "metadata": {"module": "HTTParty", "class_name": "", "class_signature": ""}, "task_id": 200}
{"function_name": "inherited", "file_path": "httparty/lib/httparty/module_inheritable_attributes.rb", "focal_code": "def inherited(subclass)\n        super\n        @mattr_inheritable_attrs.each do |inheritable_attribute|\n          ivar = :\"@#{inheritable_attribute}\"\n          subclass.instance_variable_set(ivar, instance_variable_get(ivar).clone)\n\n          if instance_variable_get(ivar).respond_to?(:merge)\n            subclass.class_eval <<~RUBY, __FILE__, __LINE__ + 1\n              def self.#{inheritable_attribute}\n                duplicate = ModuleInheritableAttributes.hash_deep_dup(#{ivar})\n                #{ivar} = superclass.#{inheritable_attribute}.merge(duplicate)\n              end\n            RUBY\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  module ModuleInheritableAttributes #:nodoc:\n    def self.included(base)\n      base.extend(ClassMethods)\n    end\n\n    # borrowed from Rails 3.2 ActiveSupport\n    def self.hash_deep_dup(hash)\n      duplicate = hash.dup\n\n      duplicate.each_pair do |key, value|\n        if value.is_a?(Hash)\n          duplicate[key] = hash_deep_dup(value)\n        elsif value.is_a?(Proc)\n          duplicate[key] = value.dup\n        else\n          duplicate[key] = value\n        end\n      end\n\n      duplicate\n    end\n\n    module ClassMethods #:nodoc:\n      def mattr_inheritable(*args)\n        @mattr_inheritable_attrs ||= [:mattr_inheritable_attrs]\n        @mattr_inheritable_attrs += args\n\n        args.each do |arg|\n          singleton_class.attr_accessor(arg)\n        end\n\n        @mattr_inheritable_attrs\n      end\n\n      def inherited(subclass)\n        super\n        @mattr_inheritable_attrs.each do |inheritable_attribute|\n          ivar = :\"@#{inheritable_attribute}\"\n          subclass.instance_variable_set(ivar, instance_variable_get(ivar).clone)\n\n          if instance_variable_get(ivar).respond_to?(:merge)\n            subclass.class_eval <<~RUBY, __FILE__, __LINE__ + 1\n              def self.#{inheritable_attribute}\n                duplicate = ModuleInheritableAttributes.hash_deep_dup(#{ivar})\n                #{ivar} = superclass.#{inheritable_attribute}.merge(duplicate)\n              end\n            RUBY\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "inherited", "signature": "def inherited(subclass)", "start_line": 38, "end_line": 53}, "metadata": {"module": "HTTParty", "class_name": "", "class_signature": ""}, "task_id": 201}
{"function_name": "digest_auth", "file_path": "httparty/lib/httparty/net_digest_auth.rb", "focal_code": "def digest_auth(username, password, response)\n      authenticator = DigestAuthenticator.new(\n        username,\n        password,\n        @method,\n        @path,\n        response\n      )\n\n      authenticator.authorization_header.each do |v|\n        add_field('Authorization', v)\n      end\n\n      authenticator.cookie_header.each do |v|\n        add_field('Cookie', v)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'digest/md5'\nrequire 'net/http'\n\nmodule Net\n  module HTTPHeader\n    def digest_auth(username, password, response)\n      authenticator = DigestAuthenticator.new(\n        username,\n        password,\n        @method,\n        @path,\n        response\n      )\n\n      authenticator.authorization_header.each do |v|\n        add_field('Authorization', v)\n      end\n\n      authenticator.cookie_header.each do |v|\n        add_field('Cookie', v)\n      end\n    end\n\n    class DigestAuthenticator\n      def initialize(username, password, method, path, response_header)\n        @username = username\n        @password = password\n        @method   = method\n        @path     = path\n        @response = parse(response_header)\n        @cookies  = parse_cookies(response_header)\n      end\n\n      def authorization_header\n        @cnonce = md5(random)\n        header = [\n          %(Digest username=\"#{@username}\"),\n          %(realm=\"#{@response['realm']}\"),\n          %(nonce=\"#{@response['nonce']}\"),\n          %(uri=\"#{@path}\"),\n          %(response=\"#{request_digest}\")\n        ]\n\n        header << %(algorithm=\"#{@response['algorithm']}\") if algorithm_present?\n\n        if qop_present?\n          header << %(cnonce=\"#{@cnonce}\")\n          header << %(qop=\"#{@response['qop']}\")\n          header << 'nc=00000001'\n        end\n\n        header << %(opaque=\"#{@response['opaque']}\") if opaque_present?\n        header\n      end\n\n      def cookie_header\n        @cookies\n      end\n\n      private\n\n      def parse(response_header)\n        header = response_header['www-authenticate']\n\n        header = header.gsub(/qop=(auth(?:-int)?)/, 'qop=\"\\\\1\"')\n\n        header =~ /Digest (.*)/\n        params = {}\n        if $1\n          non_quoted = $1.gsub(/(\\w+)=\"(.*?)\"/) { params[$1] = $2 }\n          non_quoted.gsub(/(\\w+)=([^,]*)/) { params[$1] = $2 }\n        end\n        params\n      end\n\n      def parse_cookies(response_header)\n        return [] unless response_header['Set-Cookie']\n\n        cookies = response_header['Set-Cookie'].split('; ')\n\n        cookies.reduce([]) do |ret, cookie|\n          ret << cookie\n          ret\n        end\n\n        cookies\n      end\n\n      def opaque_present?\n        @response.key?('opaque') && !@response['opaque'].empty?\n      end\n\n      def qop_present?\n        @response.key?('qop') && !@response['qop'].empty?\n      end\n\n      def random\n        format '%x', (Time.now.to_i + rand(65535))\n      end\n\n      def request_digest\n        a = [md5(a1), @response['nonce'], md5(a2)]\n        a.insert(2, '00000001', @cnonce, @response['qop']) if qop_present?\n        md5(a.join(':'))\n      end\n\n      def md5(str)\n        Digest::MD5.hexdigest(str)\n      end\n\n      def algorithm_present?\n        @response.key?('algorithm') && !@response['algorithm'].empty?\n      end\n\n      def use_md5_sess?\n        algorithm_present? && @response['algorithm'] == 'MD5-sess'\n      end\n\n      def a1\n        a1_user_realm_pwd =  [@username, @response['realm'], @password].join(':')\n        if use_md5_sess?\n          [ md5(a1_user_realm_pwd), @response['nonce'], @cnonce ].join(':')\n        else\n          a1_user_realm_pwd\n        end\n      end\n\n      def a2\n        [@method, @path].join(':')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "digest_auth", "signature": "def digest_auth(username, password, response)", "start_line": 8, "end_line": 24}, "metadata": {"module": "Net", "class_name": "", "class_signature": ""}, "task_id": 202}
{"function_name": "authorization_header", "file_path": "httparty/lib/httparty/net_digest_auth.rb", "focal_code": "def authorization_header\n        @cnonce = md5(random)\n        header = [\n          %(Digest username=\"#{@username}\"),\n          %(realm=\"#{@response['realm']}\"),\n          %(nonce=\"#{@response['nonce']}\"),\n          %(uri=\"#{@path}\"),\n          %(response=\"#{request_digest}\")\n        ]\n\n        header << %(algorithm=\"#{@response['algorithm']}\") if algorithm_present?\n\n        if qop_present?\n          header << %(cnonce=\"#{@cnonce}\")\n          header << %(qop=\"#{@response['qop']}\")\n          header << 'nc=00000001'\n        end\n\n        header << %(opaque=\"#{@response['opaque']}\") if opaque_present?\n        header\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'digest/md5'\nrequire 'net/http'\n\nmodule Net\n  module HTTPHeader\n    def digest_auth(username, password, response)\n      authenticator = DigestAuthenticator.new(\n        username,\n        password,\n        @method,\n        @path,\n        response\n      )\n\n      authenticator.authorization_header.each do |v|\n        add_field('Authorization', v)\n      end\n\n      authenticator.cookie_header.each do |v|\n        add_field('Cookie', v)\n      end\n    end\n\n    class DigestAuthenticator\n      def initialize(username, password, method, path, response_header)\n        @username = username\n        @password = password\n        @method   = method\n        @path     = path\n        @response = parse(response_header)\n        @cookies  = parse_cookies(response_header)\n      end\n\n      def authorization_header\n        @cnonce = md5(random)\n        header = [\n          %(Digest username=\"#{@username}\"),\n          %(realm=\"#{@response['realm']}\"),\n          %(nonce=\"#{@response['nonce']}\"),\n          %(uri=\"#{@path}\"),\n          %(response=\"#{request_digest}\")\n        ]\n\n        header << %(algorithm=\"#{@response['algorithm']}\") if algorithm_present?\n\n        if qop_present?\n          header << %(cnonce=\"#{@cnonce}\")\n          header << %(qop=\"#{@response['qop']}\")\n          header << 'nc=00000001'\n        end\n\n        header << %(opaque=\"#{@response['opaque']}\") if opaque_present?\n        header\n      end\n\n      def cookie_header\n        @cookies\n      end\n\n      private\n\n      def parse(response_header)\n        header = response_header['www-authenticate']\n\n        header = header.gsub(/qop=(auth(?:-int)?)/, 'qop=\"\\\\1\"')\n\n        header =~ /Digest (.*)/\n        params = {}\n        if $1\n          non_quoted = $1.gsub(/(\\w+)=\"(.*?)\"/) { params[$1] = $2 }\n          non_quoted.gsub(/(\\w+)=([^,]*)/) { params[$1] = $2 }\n        end\n        params\n      end\n\n      def parse_cookies(response_header)\n        return [] unless response_header['Set-Cookie']\n\n        cookies = response_header['Set-Cookie'].split('; ')\n\n        cookies.reduce([]) do |ret, cookie|\n          ret << cookie\n          ret\n        end\n\n        cookies\n      end\n\n      def opaque_present?\n        @response.key?('opaque') && !@response['opaque'].empty?\n      end\n\n      def qop_present?\n        @response.key?('qop') && !@response['qop'].empty?\n      end\n\n      def random\n        format '%x', (Time.now.to_i + rand(65535))\n      end\n\n      def request_digest\n        a = [md5(a1), @response['nonce'], md5(a2)]\n        a.insert(2, '00000001', @cnonce, @response['qop']) if qop_present?\n        md5(a.join(':'))\n      end\n\n      def md5(str)\n        Digest::MD5.hexdigest(str)\n      end\n\n      def algorithm_present?\n        @response.key?('algorithm') && !@response['algorithm'].empty?\n      end\n\n      def use_md5_sess?\n        algorithm_present? && @response['algorithm'] == 'MD5-sess'\n      end\n\n      def a1\n        a1_user_realm_pwd =  [@username, @response['realm'], @password].join(':')\n        if use_md5_sess?\n          [ md5(a1_user_realm_pwd), @response['nonce'], @cnonce ].join(':')\n        else\n          a1_user_realm_pwd\n        end\n      end\n\n      def a2\n        [@method, @path].join(':')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "authorization_header", "signature": "def authorization_header @cnonce = md5(random)", "start_line": 36, "end_line": 56}, "metadata": {"module": "Net", "class_name": "DigestAuthenticator", "class_signature": "class DigestAuthenticator"}, "task_id": 203}
{"function_name": "parse", "file_path": "httparty/lib/httparty/net_digest_auth.rb", "focal_code": "def parse(response_header)\n        header = response_header['www-authenticate']\n\n        header = header.gsub(/qop=(auth(?:-int)?)/, 'qop=\"\\\\1\"')\n\n        header =~ /Digest (.*)/\n        params = {}\n        if $1\n          non_quoted = $1.gsub(/(\\w+)=\"(.*?)\"/) { params[$1] = $2 }\n          non_quoted.gsub(/(\\w+)=([^,]*)/) { params[$1] = $2 }\n        end\n        params\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'digest/md5'\nrequire 'net/http'\n\nmodule Net\n  module HTTPHeader\n    def digest_auth(username, password, response)\n      authenticator = DigestAuthenticator.new(\n        username,\n        password,\n        @method,\n        @path,\n        response\n      )\n\n      authenticator.authorization_header.each do |v|\n        add_field('Authorization', v)\n      end\n\n      authenticator.cookie_header.each do |v|\n        add_field('Cookie', v)\n      end\n    end\n\n    class DigestAuthenticator\n      def initialize(username, password, method, path, response_header)\n        @username = username\n        @password = password\n        @method   = method\n        @path     = path\n        @response = parse(response_header)\n        @cookies  = parse_cookies(response_header)\n      end\n\n      def authorization_header\n        @cnonce = md5(random)\n        header = [\n          %(Digest username=\"#{@username}\"),\n          %(realm=\"#{@response['realm']}\"),\n          %(nonce=\"#{@response['nonce']}\"),\n          %(uri=\"#{@path}\"),\n          %(response=\"#{request_digest}\")\n        ]\n\n        header << %(algorithm=\"#{@response['algorithm']}\") if algorithm_present?\n\n        if qop_present?\n          header << %(cnonce=\"#{@cnonce}\")\n          header << %(qop=\"#{@response['qop']}\")\n          header << 'nc=00000001'\n        end\n\n        header << %(opaque=\"#{@response['opaque']}\") if opaque_present?\n        header\n      end\n\n      def cookie_header\n        @cookies\n      end\n\n      private\n\n      def parse(response_header)\n        header = response_header['www-authenticate']\n\n        header = header.gsub(/qop=(auth(?:-int)?)/, 'qop=\"\\\\1\"')\n\n        header =~ /Digest (.*)/\n        params = {}\n        if $1\n          non_quoted = $1.gsub(/(\\w+)=\"(.*?)\"/) { params[$1] = $2 }\n          non_quoted.gsub(/(\\w+)=([^,]*)/) { params[$1] = $2 }\n        end\n        params\n      end\n\n      def parse_cookies(response_header)\n        return [] unless response_header['Set-Cookie']\n\n        cookies = response_header['Set-Cookie'].split('; ')\n\n        cookies.reduce([]) do |ret, cookie|\n          ret << cookie\n          ret\n        end\n\n        cookies\n      end\n\n      def opaque_present?\n        @response.key?('opaque') && !@response['opaque'].empty?\n      end\n\n      def qop_present?\n        @response.key?('qop') && !@response['qop'].empty?\n      end\n\n      def random\n        format '%x', (Time.now.to_i + rand(65535))\n      end\n\n      def request_digest\n        a = [md5(a1), @response['nonce'], md5(a2)]\n        a.insert(2, '00000001', @cnonce, @response['qop']) if qop_present?\n        md5(a.join(':'))\n      end\n\n      def md5(str)\n        Digest::MD5.hexdigest(str)\n      end\n\n      def algorithm_present?\n        @response.key?('algorithm') && !@response['algorithm'].empty?\n      end\n\n      def use_md5_sess?\n        algorithm_present? && @response['algorithm'] == 'MD5-sess'\n      end\n\n      def a1\n        a1_user_realm_pwd =  [@username, @response['realm'], @password].join(':')\n        if use_md5_sess?\n          [ md5(a1_user_realm_pwd), @response['nonce'], @cnonce ].join(':')\n        else\n          a1_user_realm_pwd\n        end\n      end\n\n      def a2\n        [@method, @path].join(':')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse", "signature": "def parse(response_header)", "start_line": 64, "end_line": 76}, "metadata": {"module": "Net", "class_name": "DigestAuthenticator", "class_signature": "class DigestAuthenticator"}, "task_id": 204}
{"function_name": "parse", "file_path": "httparty/lib/httparty/parser.rb", "focal_code": "def parse\n      return nil if body.nil?\n      return nil if body == 'null'\n      return nil if body.valid_encoding? && body.strip.empty?\n      if body.valid_encoding? && body.encoding == Encoding::UTF_8\n        @body = body.gsub(/\\A#{UTF8_BOM}/, '')\n      end\n      if supports_format?\n        parse_supported_format\n      else\n        body\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  # The default parser used by HTTParty, supports xml, json, html, csv and\n  # plain text.\n  #\n  # == Custom Parsers\n  #\n  # If you'd like to do your own custom parsing, subclassing HTTParty::Parser\n  # will make that process much easier. There are a few different ways you can\n  # utilize HTTParty::Parser as a superclass.\n  #\n  # @example Intercept the parsing for all formats\n  #   class SimpleParser < HTTParty::Parser\n  #     def parse\n  #       perform_parsing\n  #     end\n  #   end\n  #\n  # @example Add the atom format and parsing method to the default parser\n  #   class AtomParsingIncluded < HTTParty::Parser\n  #     SupportedFormats.merge!(\n  #       {\"application/atom+xml\" => :atom}\n  #     )\n  #\n  #     def atom\n  #       perform_atom_parsing\n  #     end\n  #   end\n  #\n  # @example Only support the atom format\n  #   class ParseOnlyAtom < HTTParty::Parser\n  #     SupportedFormats = {\"application/atom+xml\" => :atom}\n  #\n  #     def atom\n  #       perform_atom_parsing\n  #     end\n  #   end\n  #\n  # @abstract Read the Custom Parsers section for more information.\n  class Parser\n    SupportedFormats = {\n      'text/xml'                    => :xml,\n      'application/xml'             => :xml,\n      'application/json'            => :json,\n      'application/vnd.api+json'    => :json,\n      'application/hal+json'        => :json,\n      'text/json'                   => :json,\n      'application/javascript'      => :plain,\n      'text/javascript'             => :plain,\n      'text/html'                   => :html,\n      'text/plain'                  => :plain,\n      'text/csv'                    => :csv,\n      'application/csv'             => :csv,\n      'text/comma-separated-values' => :csv\n    }\n\n    # The response body of the request\n    # @return [String]\n    attr_reader :body\n\n    # The intended parsing format for the request\n    # @return [Symbol] e.g. :json\n    attr_reader :format\n\n    # Instantiate the parser and call {#parse}.\n    # @param [String] body the response body\n    # @param [Symbol] format the response format\n    # @return parsed response\n    def self.call(body, format)\n      new(body, format).parse\n    end\n\n    # @return [Hash] the SupportedFormats hash\n    def self.formats\n      const_get(:SupportedFormats)\n    end\n\n    # @param [String] mimetype response MIME type\n    # @return [Symbol]\n    # @return [nil] mime type not supported\n    def self.format_from_mimetype(mimetype)\n      formats[formats.keys.detect {|k| mimetype.include?(k)}]\n    end\n\n    # @return [Array<Symbol>] list of supported formats\n    def self.supported_formats\n      formats.values.uniq\n    end\n\n    # @param [Symbol] format e.g. :json, :xml\n    # @return [Boolean]\n    def self.supports_format?(format)\n      supported_formats.include?(format)\n    end\n\n    def initialize(body, format)\n      @body = body\n      @format = format\n    end\n\n    # @return [Object] the parsed body\n    # @return [nil] when the response body is nil, an empty string, spaces only or \"null\"\n    def parse\n      return nil if body.nil?\n      return nil if body == 'null'\n      return nil if body.valid_encoding? && body.strip.empty?\n      if body.valid_encoding? && body.encoding == Encoding::UTF_8\n        @body = body.gsub(/\\A#{UTF8_BOM}/, '')\n      end\n      if supports_format?\n        parse_supported_format\n      else\n        body\n      end\n    end\n\n    protected\n\n    def xml\n      require 'multi_xml'\n      MultiXml.parse(body)\n    end\n\n    UTF8_BOM = \"\\xEF\\xBB\\xBF\"\n\n    def json\n      require 'json'\n      JSON.parse(body, :quirks_mode => true, :allow_nan => true)\n    end\n\n    def csv\n      require 'csv'\n      CSV.parse(body)\n    end\n\n    def html\n      body\n    end\n\n    def plain\n      body\n    end\n\n    def supports_format?\n      self.class.supports_format?(format)\n    end\n\n    def parse_supported_format\n      if respond_to?(format, true)\n        send(format)\n      else\n        raise NotImplementedError, \"#{self.class.name} has not implemented a parsing method for the #{format.inspect} format.\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse", "signature": "def parse return nil if body.nil?", "start_line": 104, "end_line": 116}, "metadata": {"module": "HTTParty", "class_name": "Parser", "class_signature": "class Parser"}, "task_id": 205}
{"function_name": "initialize", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(http_method, path, o = {})", "start_line": 61, "end_line": 77}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 206}
{"function_name": "path=", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "path=", "signature": "def path", "start_line": 79, "end_line": 90}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 207}
{"function_name": "uri", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "uri", "signature": "def uri if redirect && path.relative? && path.path[0] != '/'", "start_line": 100, "end_line": 126}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 208}
{"function_name": "perform", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "perform", "signature": "def perform(&block)", "start_line": 150, "end_line": 178}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 209}
{"function_name": "setup_raw_request", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "setup_raw_request", "signature": "def setup_raw_request if options[:headers].respond_to?(:to_hash)", "start_line": 228, "end_line": 259}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 210}
{"function_name": "query_string", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "query_string", "signature": "def query_string(uri)", "start_line": 281, "end_line": 294}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 211}
{"function_name": "handle_response", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "handle_response", "signature": "def handle_response(raw_body, &block)", "start_line": 300, "end_line": 319}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 212}
{"function_name": "handle_redirection", "file_path": "httparty/lib/httparty/request.rb", "focal_code": "def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'erb'\n\nmodule HTTParty\n  class Request #:nodoc:\n    SupportedHTTPMethods = [\n      Net::HTTP::Get,\n      Net::HTTP::Post,\n      Net::HTTP::Patch,\n      Net::HTTP::Put,\n      Net::HTTP::Delete,\n      Net::HTTP::Head,\n      Net::HTTP::Options,\n      Net::HTTP::Move,\n      Net::HTTP::Copy,\n      Net::HTTP::Mkcol,\n      Net::HTTP::Lock,\n      Net::HTTP::Unlock,\n    ]\n\n    SupportedURISchemes  = ['http', 'https', 'webcal', nil]\n\n    NON_RAILS_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.map {|v| \"#{key}=#{ERB::Util.url_encode(v.to_s)}\"}\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|\n      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|\n        if value.nil?\n          key.to_s\n        elsif value.respond_to?(:to_ary)\n          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}\n          \"#{key}=#{values.join(',')}\"\n        else\n          HashConversions.to_params(key => value)\n        end\n      end.flatten.join('&')\n    end\n\n    def self._load(data)\n      http_method, path, options, last_response, last_uri, raw_request = Marshal.load(data)\n      instance = new(http_method, path, options)\n      instance.last_response = last_response\n      instance.last_uri = last_uri\n      instance.instance_variable_set(\"@raw_request\", raw_request)\n      instance\n    end\n\n    attr_accessor :http_method, :options, :last_response, :redirect, :last_uri\n    attr_reader :path\n\n    def initialize(http_method, path, o = {})\n      @changed_hosts = false\n      @credentials_sent = false\n\n      self.http_method = http_method\n      self.options = {\n        limit: o.delete(:no_follow) ? 1 : 5,\n        assume_utf16_is_big_endian: true,\n        default_params: {},\n        follow_redirects: true,\n        parser: Parser,\n        uri_adapter: URI,\n        connection_adapter: ConnectionAdapter\n      }.merge(o)\n      self.path = path\n      set_basic_auth_from_uri\n    end\n\n    def path=(uri)\n      uri_adapter = options[:uri_adapter]\n\n      @path = if uri.is_a?(uri_adapter)\n        uri\n      elsif String.try_convert(uri)\n        uri_adapter.parse(uri).normalize\n      else\n        raise ArgumentError,\n          \"bad argument (expected #{uri_adapter} object or URI string)\"\n      end\n    end\n\n    def request_uri(uri)\n      if uri.respond_to? :request_uri\n        uri.request_uri\n      else\n        uri.path\n      end\n    end\n\n    def uri\n      if redirect && path.relative? && path.path[0] != '/'\n        last_uri_host = @last_uri.path.gsub(/[^\\/]+$/, '')\n\n        path.path = \"/#{path.path}\" if last_uri_host[-1] != '/'\n        path.path = \"#{last_uri_host}#{path.path}\"\n      end\n\n      if path.relative? && path.host\n        new_uri = options[:uri_adapter].parse(\"#{@last_uri.scheme}:#{path}\").normalize\n      elsif path.relative?\n        new_uri = options[:uri_adapter].parse(\"#{base_uri}#{path}\").normalize\n      else\n        new_uri = path.clone\n      end\n\n      # avoid double query string on redirects [#12]\n      unless redirect\n        new_uri.query = query_string(new_uri)\n      end\n\n      unless SupportedURISchemes.include? new_uri.scheme\n        raise UnsupportedURIScheme, \"'#{new_uri}' Must be HTTP, HTTPS or Generic\"\n      end\n\n      @last_uri = new_uri\n    end\n\n    def base_uri\n      if redirect\n        base_uri = \"#{@last_uri.scheme}://#{@last_uri.host}\"\n        base_uri = \"#{base_uri}:#{@last_uri.port}\" if @last_uri.port != 80\n        base_uri\n      else\n        options[:base_uri] && HTTParty.normalize_base_uri(options[:base_uri])\n      end\n    end\n\n    def format\n      options[:format] || (format_from_mimetype(last_response['content-type']) if last_response)\n    end\n\n    def parser\n      options[:parser]\n    end\n\n    def connection_adapter\n      options[:connection_adapter]\n    end\n\n    def perform(&block)\n      validate\n      setup_raw_request\n      chunked_body = nil\n      current_http = http\n\n      begin\n        self.last_response = current_http.request(@raw_request) do |http_response|\n          if block\n            chunks = []\n\n            http_response.read_body do |fragment|\n              encoded_fragment = encode_text(fragment, http_response['content-type'])\n              chunks << encoded_fragment if !options[:stream_body]\n              block.call ResponseFragment.new(encoded_fragment, http_response, current_http)\n            end\n\n            chunked_body = chunks.join\n          end\n        end\n\n        handle_host_redirection if response_redirects?\n        result = handle_unauthorized\n        result ||= handle_response(chunked_body, &block)\n        result\n      rescue *COMMON_NETWORK_ERRORS => e\n        raise options[:foul] ? HTTParty::NetworkError.new(\"#{e.class}: #{e.message}\") : e\n      end\n    end\n\n    def handle_unauthorized(&block)\n      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n      return if @credentials_sent\n      @credentials_sent = true\n      perform(&block)\n    end\n\n    def raw_body\n      @raw_request.body\n    end\n\n    def _dump(_level)\n      opts = options.dup\n      opts.delete(:logger)\n      opts.delete(:parser) if opts[:parser] && opts[:parser].is_a?(Proc)\n      Marshal.dump([http_method, path, opts, last_response, @last_uri, @raw_request])\n    end\n\n    private\n\n    def http\n      connection_adapter.call(uri, options)\n    end\n\n    def credentials\n      (options[:basic_auth] || options[:digest_auth]).to_hash\n    end\n\n    def username\n      credentials[:username]\n    end\n\n    def password\n      credentials[:password]\n    end\n\n    def normalize_query(query)\n      if query_string_normalizer\n        query_string_normalizer.call(query)\n      else\n        HashConversions.to_params(query)\n      end\n    end\n\n    def query_string_normalizer\n      options[:query_string_normalizer]\n    end\n\n    def setup_raw_request\n      if options[:headers].respond_to?(:to_hash)\n        headers_hash = options[:headers].to_hash\n      else\n        headers_hash = nil\n      end\n\n      @raw_request = http_method.new(request_uri(uri), headers_hash)\n      @raw_request.body_stream = options[:body_stream] if options[:body_stream]\n\n      if options[:body]\n        body = Body.new(\n          options[:body],\n          query_string_normalizer: query_string_normalizer,\n          force_multipart: options[:multipart]\n        )\n\n        if body.multipart?\n          content_type = \"multipart/form-data; boundary=#{body.boundary}\"\n          @raw_request['Content-Type'] = content_type\n        end\n        @raw_request.body = body.call\n      end\n\n      @raw_request.instance_variable_set(:@decode_content, decompress_content?)\n\n      if options[:basic_auth] && send_authorization_header?\n        @raw_request.basic_auth(username, password)\n        @credentials_sent = true\n      end\n      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?\n    end\n\n    def digest_auth?\n      !!options[:digest_auth]\n    end\n\n    def decompress_content?\n      !options[:skip_decompression]\n    end\n\n    def response_unauthorized?\n      !!last_response && last_response.code == '401'\n    end\n\n    def response_has_digest_auth_challenge?\n      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0\n    end\n\n    def setup_digest_auth\n      @raw_request.digest_auth(username, password, last_response)\n    end\n\n    def query_string(uri)\n      query_string_parts = []\n      query_string_parts << uri.query unless uri.query.nil?\n\n      if options[:query].respond_to?(:to_hash)\n        query_string_parts << normalize_query(options[:default_params].merge(options[:query].to_hash))\n      else\n        query_string_parts << normalize_query(options[:default_params]) unless options[:default_params].empty?\n        query_string_parts << options[:query] unless options[:query].nil?\n      end\n\n      query_string_parts.reject!(&:empty?) unless query_string_parts == ['']\n      query_string_parts.size > 0 ? query_string_parts.join('&') : nil\n    end\n\n    def assume_utf16_is_big_endian\n      options[:assume_utf16_is_big_endian]\n    end\n\n    def handle_response(raw_body, &block)\n      if response_redirects?\n        handle_redirection(&block)\n      else\n        raw_body ||= last_response.body\n\n        body = decompress(raw_body, last_response['content-encoding']) unless raw_body.nil?\n\n        unless body.nil?\n          body = encode_text(body, last_response['content-type'])\n\n          if decompress_content?\n            last_response.delete('content-encoding')\n            raw_body = body\n          end\n        end\n\n        Response.new(self, last_response, lambda { parse_response(body) }, body: raw_body)\n      end\n    end\n\n    def handle_redirection(&block)\n      options[:limit] -= 1\n      if options[:logger]\n        logger = HTTParty::Logger.build(options[:logger], options[:log_level], options[:log_format])\n        logger.format(self, last_response)\n      end\n      self.path       = last_response['location']\n      self.redirect   = true\n      if last_response.class == Net::HTTPSeeOther\n        unless options[:maintain_method_across_redirects] && options[:resend_on_redirect]\n          self.http_method = Net::HTTP::Get\n        end\n      elsif last_response.code != '307' && last_response.code != '308'\n        unless options[:maintain_method_across_redirects]\n          self.http_method = Net::HTTP::Get\n        end\n      end\n      if http_method == Net::HTTP::Get\n        clear_body\n      end\n      capture_cookies(last_response)\n      perform(&block)\n    end\n\n    def handle_host_redirection\n      check_duplicate_location_header\n      redirect_path = options[:uri_adapter].parse(last_response['location']).normalize\n      return if redirect_path.relative? || path.host == redirect_path.host || uri.host == redirect_path.host\n      @changed_hosts = true\n    end\n\n    def check_duplicate_location_header\n      location = last_response.get_fields('location')\n      if location.is_a?(Array) && location.count > 1\n        raise DuplicateLocationHeader.new(last_response)\n      end\n    end\n\n    def send_authorization_header?\n      !@changed_hosts\n    end\n\n    def response_redirects?\n      case last_response\n      when Net::HTTPNotModified # 304\n        false\n      when Net::HTTPRedirection\n        options[:follow_redirects] && last_response.key?('location')\n      end\n    end\n\n    def parse_response(body)\n      parser.call(body, format)\n    end\n\n    # Some Web Application Firewalls reject incoming GET requests that have a body\n    # if we redirect, and the resulting verb is GET then we will clear the body that\n    # may be left behind from the initiating request\n    def clear_body\n      options[:body] = nil\n      @raw_request.body = nil\n    end\n\n    def capture_cookies(response)\n      return unless response['Set-Cookie']\n      cookies_hash = HTTParty::CookieHash.new\n      cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']\n      response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }\n\n      options[:headers] ||= {}\n      options[:headers]['Cookie'] = cookies_hash.to_cookie_string\n    end\n\n    # Uses the HTTP Content-Type header to determine the format of the\n    # response It compares the MIME type returned to the types stored in the\n    # SupportedFormats hash\n    def format_from_mimetype(mimetype)\n      if mimetype && parser.respond_to?(:format_from_mimetype)\n        parser.format_from_mimetype(mimetype)\n      end\n    end\n\n    def validate\n      raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0\n      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)\n      raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].respond_to?(:to_hash)\n      raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]\n      raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':digest_auth must be a hash' if options[:digest_auth] && !options[:digest_auth].respond_to?(:to_hash)\n      raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].respond_to?(:to_hash)\n    end\n\n    def post?\n      Net::HTTP::Post == http_method\n    end\n\n    def set_basic_auth_from_uri\n      if path.userinfo\n        username, password = path.userinfo.split(':')\n        options[:basic_auth] = {username: username, password: password}\n        @credentials_sent = true\n      end\n    end\n\n    def decompress(body, encoding)\n      Decompressor.new(body, encoding).decompress\n    end\n\n    def encode_text(text, content_type)\n      TextEncoder.new(\n        text,\n        content_type: content_type,\n        assume_utf16_is_big_endian: assume_utf16_is_big_endian\n      ).call\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "handle_redirection", "signature": "def handle_redirection(&block)", "start_line": 321, "end_line": 343}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 213}
{"function_name": "initialize", "file_path": "httparty/lib/httparty/response.rb", "focal_code": "def initialize(request, response, parsed_block, options = {})\n      @request      = request\n      @response     = response\n      @body         = options[:body] || response.body\n      @parsed_block = parsed_block\n      @headers      = Headers.new(response.to_hash)\n\n      if request.options[:logger]\n        logger = ::HTTParty::Logger.build(\n          request.options[:logger],\n          request.options[:log_level],\n          request.options[:log_format]\n        )\n        logger.format(request, self)\n      end\n\n      throw_exception\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  class Response < Object\n    def self.underscore(string)\n      string.gsub(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2').gsub(/([a-z])([A-Z])/, '\\1_\\2').downcase\n    end\n\n    def self._load(data)\n      req, resp, parsed_resp, resp_body = Marshal.load(data)\n\n      new(req, resp, -> { parsed_resp }, body: resp_body)\n    end\n\n    attr_reader :request, :response, :body, :headers\n\n    def initialize(request, response, parsed_block, options = {})\n      @request      = request\n      @response     = response\n      @body         = options[:body] || response.body\n      @parsed_block = parsed_block\n      @headers      = Headers.new(response.to_hash)\n\n      if request.options[:logger]\n        logger = ::HTTParty::Logger.build(\n          request.options[:logger],\n          request.options[:log_level],\n          request.options[:log_format]\n        )\n        logger.format(request, self)\n      end\n\n      throw_exception\n    end\n\n    def parsed_response\n      @parsed_response ||= @parsed_block.call\n    end\n\n    def code\n      response.code.to_i\n    end\n\n    def http_version\n      response.http_version\n    end\n\n    def tap\n      yield self\n      self\n    end\n\n    def inspect\n      inspect_id = ::Kernel::format '%x', (object_id * 2)\n      %(#<#{self.class}:0x#{inspect_id} parsed_response=#{parsed_response.inspect}, @response=#{response.inspect}, @headers=#{headers.inspect}>)\n    end\n\n    CODES_TO_OBJ = ::Net::HTTPResponse::CODE_CLASS_TO_OBJ.merge ::Net::HTTPResponse::CODE_TO_OBJ\n\n    CODES_TO_OBJ.each do |response_code, klass|\n      name = klass.name.sub('Net::HTTP', '')\n      name = \"#{underscore(name)}?\".to_sym\n\n      define_method(name) do\n        klass === response\n      end\n    end\n\n    # Support old multiple_choice? method from pre 2.0.0 era.\n    if ::RUBY_PLATFORM != 'java'\n      alias_method :multiple_choice?, :multiple_choices?\n    end\n\n    # Support old status codes method from pre 2.6.0 era.\n    if ::RUBY_PLATFORM != 'java'\n      alias_method :gateway_time_out?,                :gateway_timeout?\n      alias_method :request_entity_too_large?,        :payload_too_large?\n      alias_method :request_time_out?,                :request_timeout?\n      alias_method :request_uri_too_long?,            :uri_too_long?\n      alias_method :requested_range_not_satisfiable?, :range_not_satisfiable?\n    end\n\n    def nil?\n      warn_about_nil_deprecation\n      response.nil? || response.body.nil? || response.body.empty?\n    end\n\n    def to_s\n      if !response.nil? && !response.body.nil? && response.body.respond_to?(:to_s)\n        response.body.to_s\n      else\n        inspect\n      end\n    end\n\n    def pretty_print(pp)\n      if !parsed_response.nil? && parsed_response.respond_to?(:pretty_print)\n        parsed_response.pretty_print(pp)\n      else\n        super\n      end\n    end\n\n    def display(port=$>)\n      if !parsed_response.nil? && parsed_response.respond_to?(:display)\n        parsed_response.display(port)\n      elsif !response.nil? && !response.body.nil? && response.body.respond_to?(:display)\n        response.body.display(port)\n      else\n        port.write(inspect)\n      end\n    end\n\n    def respond_to_missing?(name, *args)\n      return true if super\n      parsed_response.respond_to?(name) || response.respond_to?(name)\n    end\n\n    def _dump(_level)\n      Marshal.dump([request, response, parsed_response, body])\n    end\n\n    protected\n\n    def method_missing(name, *args, &block)\n      if parsed_response.respond_to?(name)\n        parsed_response.send(name, *args, &block)\n      elsif response.respond_to?(name)\n        response.send(name, *args, &block)\n      else\n        super\n      end\n    end\n\n    def throw_exception\n      if @request.options[:raise_on].to_a.detect { |c| code.to_s.match(/#{c.to_s}/) }\n        ::Kernel.raise ::HTTParty::ResponseError.new(@response), \"Code #{code} - #{body}\"\n      end\n    end\n\n    private\n\n    def warn_about_nil_deprecation\n      trace_line = caller.reject { |line| line.include?('httparty') }.first\n      warning = \"[DEPRECATION] HTTParty will no longer override `response#nil?`. \" \\\n        \"This functionality will be removed in future versions. \" \\\n        \"Please, add explicit check `response.body.nil? || response.body.empty?`. \" \\\n        \"For more info refer to: https://github.com/jnunemaker/httparty/issues/568\\n\" \\\n        \"#{trace_line}\"\n\n      warn(warning)\n    end\n  end\nend\n\nrequire 'httparty/response/headers'\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(request, response, parsed_block, options = {})", "start_line": 17, "end_line": 34}, "metadata": {"module": "HTTParty", "class_name": "Response", "class_signature": "class Response < < Object"}, "task_id": 214}
{"function_name": "encode_utf_16", "file_path": "httparty/lib/httparty/text_encoder.rb", "focal_code": "def encode_utf_16\n      if text.bytesize >= 2\n        if text.getbyte(0) == 0xFF && text.getbyte(1) == 0xFE\n          return text.force_encoding('UTF-16LE')\n        elsif text.getbyte(0) == 0xFE && text.getbyte(1) == 0xFF\n          return text.force_encoding('UTF-16BE')\n        end\n      end\n\n      if assume_utf16_is_big_endian # option\n        text.force_encoding('UTF-16BE')\n      else\n        text.force_encoding('UTF-16LE')\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  class TextEncoder\n    attr_reader :text, :content_type, :assume_utf16_is_big_endian\n\n    def initialize(text, assume_utf16_is_big_endian: true, content_type: nil)\n      @text = +text\n      @content_type = content_type\n      @assume_utf16_is_big_endian = assume_utf16_is_big_endian\n    end\n\n    def call\n      if can_encode?\n        encoded_text\n      else\n        text\n      end\n    end\n\n    private\n\n    def can_encode?\n      ''.respond_to?(:encoding) && charset\n    end\n\n    def encoded_text\n      if 'utf-16'.casecmp(charset) == 0\n        encode_utf_16\n      else\n        encode_with_ruby_encoding\n      end\n    end\n\n    def encode_utf_16\n      if text.bytesize >= 2\n        if text.getbyte(0) == 0xFF && text.getbyte(1) == 0xFE\n          return text.force_encoding('UTF-16LE')\n        elsif text.getbyte(0) == 0xFE && text.getbyte(1) == 0xFF\n          return text.force_encoding('UTF-16BE')\n        end\n      end\n\n      if assume_utf16_is_big_endian # option\n        text.force_encoding('UTF-16BE')\n      else\n        text.force_encoding('UTF-16LE')\n      end\n    end\n\n    def encode_with_ruby_encoding\n      # NOTE: This will raise an argument error if the\n      # charset does not exist\n      encoding = Encoding.find(charset)\n      text.force_encoding(encoding.to_s)\n    rescue ArgumentError\n      text\n    end\n\n    def charset\n      return nil if content_type.nil?\n\n      if (matchdata = content_type.match(/;\\s*charset\\s*=\\s*([^=,;\"\\s]+)/i))\n        return matchdata.captures.first\n      end\n\n      if (matchdata = content_type.match(/;\\s*charset\\s*=\\s*\"((\\\\.|[^\\\\\"])+)\"/i))\n        return matchdata.captures.first.gsub(/\\\\(.)/, '\\1')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "encode_utf_16", "signature": "def encode_utf_16 if text.bytesize >= 2", "start_line": 35, "end_line": 49}, "metadata": {"module": "HTTParty", "class_name": "TextEncoder", "class_signature": "class TextEncoder"}, "task_id": 215}
{"function_name": "logstash_message", "file_path": "httparty/lib/httparty/logger/logstash_formatter.rb", "focal_code": "def logstash_message\n        require 'json'\n        {\n          '@timestamp' => current_time,\n          '@version' => 1,\n          'content_length' => content_length || '-',\n          'http_method' => http_method,\n          'message' => message,\n          'path' => path,\n          'response_code' => response.code,\n          'severity' => level,\n          'tags' => [TAG_NAME],\n        }.to_json\n      end", "file_content": "# frozen_string_literal: true\n\nmodule HTTParty\n  module Logger\n    class LogstashFormatter #:nodoc:\n      TAG_NAME = HTTParty.name\n\n      attr_accessor :level, :logger\n\n      def initialize(logger, level)\n        @logger = logger\n        @level  = level.to_sym\n      end\n\n      def format(request, response)\n        @request = request\n        @response = response\n\n        logger.public_send level, logstash_message\n      end\n\n      private\n\n      attr_reader :request, :response\n\n      def logstash_message\n        require 'json'\n        {\n          '@timestamp' => current_time,\n          '@version' => 1,\n          'content_length' => content_length || '-',\n          'http_method' => http_method,\n          'message' => message,\n          'path' => path,\n          'response_code' => response.code,\n          'severity' => level,\n          'tags' => [TAG_NAME],\n        }.to_json\n      end\n\n      def message\n        \"[#{TAG_NAME}] #{response.code} \\\"#{http_method} #{path}\\\" #{content_length || '-'} \"\n      end\n\n      def current_time\n        Time.now.strftime('%Y-%m-%d %H:%M:%S %z')\n      end\n\n      def http_method\n        @http_method ||= request.http_method.name.split('::').last.upcase\n      end\n\n      def path\n        @path ||= request.path.to_s\n      end\n\n      def content_length\n        @content_length ||= response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "logstash_message", "signature": "def logstash_message require 'json'", "start_line": 26, "end_line": 39}, "metadata": {"module": "HTTParty", "class_name": "LogstashFormatter", "class_signature": "class LogstashFormatter"}, "task_id": 216}
{"function_name": "generate_multipart", "file_path": "httparty/lib/httparty/request/body.rb", "focal_code": "def generate_multipart\n        normalized_params = params.flat_map { |key, value| HashConversions.normalize_keys(key, value) }\n\n        multipart = normalized_params.inject(''.b) do |memo, (key, value)|\n          memo << \"--#{boundary}#{NEWLINE}\".b\n          memo << %(Content-Disposition: form-data; name=\"#{key}\").b\n          # value.path is used to support ActionDispatch::Http::UploadedFile\n          # https://github.com/jnunemaker/httparty/pull/585\n          memo << %(; filename=\"#{file_name(value).gsub(/[\"\\r\\n]/, MULTIPART_FORM_DATA_REPLACEMENT_TABLE)}\").b if file?(value)\n          memo << NEWLINE.b\n          memo << \"Content-Type: #{content_type(value)}#{NEWLINE}\".b if file?(value)\n          memo << NEWLINE.b\n          memo << content_body(value)\n          memo << NEWLINE.b\n        end\n\n        multipart << \"--#{boundary}--#{NEWLINE}\".b\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative 'multipart_boundary'\n\nmodule HTTParty\n  class Request\n    class Body\n      NEWLINE = \"\\r\\n\"\n      private_constant :NEWLINE\n\n      def initialize(params, query_string_normalizer: nil, force_multipart: false)\n        @params = params\n        @query_string_normalizer = query_string_normalizer\n        @force_multipart = force_multipart\n      end\n\n      def call\n        if params.respond_to?(:to_hash)\n          multipart? ? generate_multipart : normalize_query(params)\n        else\n          params\n        end\n      end\n\n      def boundary\n        @boundary ||= MultipartBoundary.generate\n      end\n\n      def multipart?\n        params.respond_to?(:to_hash) && (force_multipart || has_file?(params))\n      end\n\n      private\n\n      # https://html.spec.whatwg.org/#multipart-form-data\n      MULTIPART_FORM_DATA_REPLACEMENT_TABLE = {\n        '\"'  => '%22',\n        \"\\r\" => '%0D',\n        \"\\n\" => '%0A'\n      }.freeze\n\n      def generate_multipart\n        normalized_params = params.flat_map { |key, value| HashConversions.normalize_keys(key, value) }\n\n        multipart = normalized_params.inject(''.b) do |memo, (key, value)|\n          memo << \"--#{boundary}#{NEWLINE}\".b\n          memo << %(Content-Disposition: form-data; name=\"#{key}\").b\n          # value.path is used to support ActionDispatch::Http::UploadedFile\n          # https://github.com/jnunemaker/httparty/pull/585\n          memo << %(; filename=\"#{file_name(value).gsub(/[\"\\r\\n]/, MULTIPART_FORM_DATA_REPLACEMENT_TABLE)}\").b if file?(value)\n          memo << NEWLINE.b\n          memo << \"Content-Type: #{content_type(value)}#{NEWLINE}\".b if file?(value)\n          memo << NEWLINE.b\n          memo << content_body(value)\n          memo << NEWLINE.b\n        end\n\n        multipart << \"--#{boundary}--#{NEWLINE}\".b\n      end\n\n      def has_file?(value)\n        if value.respond_to?(:to_hash)\n          value.to_hash.any? { |_, v| has_file?(v) }\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.any? { |v| has_file?(v) }\n        else\n          file?(value)\n        end\n      end\n\n      def file?(object)\n        object.respond_to?(:path) && object.respond_to?(:read)\n      end\n\n      def normalize_query(query)\n        if query_string_normalizer\n          query_string_normalizer.call(query)\n        else\n          HashConversions.to_params(query)\n        end\n      end\n\n      def content_body(object)\n        if file?(object)\n          object = (file = object).read\n          object.force_encoding(Encoding::BINARY) if object.respond_to?(:force_encoding)\n          file.rewind if file.respond_to?(:rewind)\n          object.to_s\n        else\n          object.to_s.b\n        end\n      end\n\n      def content_type(object)\n        return object.content_type if object.respond_to?(:content_type)\n        require 'mini_mime'\n        mime = MiniMime.lookup_by_filename(object.path)\n        mime ? mime.content_type : 'application/octet-stream'\n      end\n\n      def file_name(object)\n        object.respond_to?(:original_filename) ? object.original_filename : File.basename(object.path)\n      end\n\n      attr_reader :params, :query_string_normalizer, :force_multipart\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "generate_multipart", "signature": "def generate_multipart normalized_params = params.flat_map { |key, value| HashConversions.normalize_keys(key, value) }", "start_line": 42, "end_line": 59}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 217}
{"function_name": "content_body", "file_path": "httparty/lib/httparty/request/body.rb", "focal_code": "def content_body(object)\n        if file?(object)\n          object = (file = object).read\n          object.force_encoding(Encoding::BINARY) if object.respond_to?(:force_encoding)\n          file.rewind if file.respond_to?(:rewind)\n          object.to_s\n        else\n          object.to_s.b\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative 'multipart_boundary'\n\nmodule HTTParty\n  class Request\n    class Body\n      NEWLINE = \"\\r\\n\"\n      private_constant :NEWLINE\n\n      def initialize(params, query_string_normalizer: nil, force_multipart: false)\n        @params = params\n        @query_string_normalizer = query_string_normalizer\n        @force_multipart = force_multipart\n      end\n\n      def call\n        if params.respond_to?(:to_hash)\n          multipart? ? generate_multipart : normalize_query(params)\n        else\n          params\n        end\n      end\n\n      def boundary\n        @boundary ||= MultipartBoundary.generate\n      end\n\n      def multipart?\n        params.respond_to?(:to_hash) && (force_multipart || has_file?(params))\n      end\n\n      private\n\n      # https://html.spec.whatwg.org/#multipart-form-data\n      MULTIPART_FORM_DATA_REPLACEMENT_TABLE = {\n        '\"'  => '%22',\n        \"\\r\" => '%0D',\n        \"\\n\" => '%0A'\n      }.freeze\n\n      def generate_multipart\n        normalized_params = params.flat_map { |key, value| HashConversions.normalize_keys(key, value) }\n\n        multipart = normalized_params.inject(''.b) do |memo, (key, value)|\n          memo << \"--#{boundary}#{NEWLINE}\".b\n          memo << %(Content-Disposition: form-data; name=\"#{key}\").b\n          # value.path is used to support ActionDispatch::Http::UploadedFile\n          # https://github.com/jnunemaker/httparty/pull/585\n          memo << %(; filename=\"#{file_name(value).gsub(/[\"\\r\\n]/, MULTIPART_FORM_DATA_REPLACEMENT_TABLE)}\").b if file?(value)\n          memo << NEWLINE.b\n          memo << \"Content-Type: #{content_type(value)}#{NEWLINE}\".b if file?(value)\n          memo << NEWLINE.b\n          memo << content_body(value)\n          memo << NEWLINE.b\n        end\n\n        multipart << \"--#{boundary}--#{NEWLINE}\".b\n      end\n\n      def has_file?(value)\n        if value.respond_to?(:to_hash)\n          value.to_hash.any? { |_, v| has_file?(v) }\n        elsif value.respond_to?(:to_ary)\n          value.to_ary.any? { |v| has_file?(v) }\n        else\n          file?(value)\n        end\n      end\n\n      def file?(object)\n        object.respond_to?(:path) && object.respond_to?(:read)\n      end\n\n      def normalize_query(query)\n        if query_string_normalizer\n          query_string_normalizer.call(query)\n        else\n          HashConversions.to_params(query)\n        end\n      end\n\n      def content_body(object)\n        if file?(object)\n          object = (file = object).read\n          object.force_encoding(Encoding::BINARY) if object.respond_to?(:force_encoding)\n          file.rewind if file.respond_to?(:rewind)\n          object.to_s\n        else\n          object.to_s.b\n        end\n      end\n\n      def content_type(object)\n        return object.content_type if object.respond_to?(:content_type)\n        require 'mini_mime'\n        mime = MiniMime.lookup_by_filename(object.path)\n        mime ? mime.content_type : 'application/octet-stream'\n      end\n\n      def file_name(object)\n        object.respond_to?(:original_filename) ? object.original_filename : File.basename(object.path)\n      end\n\n      attr_reader :params, :query_string_normalizer, :force_multipart\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "content_body", "signature": "def content_body(object)", "start_line": 83, "end_line": 92}, "metadata": {"module": "HTTParty", "class_name": "Request", "class_signature": "class Request"}, "task_id": 218}
{"function_name": "initialize", "file_path": "httparty/lib/httparty/response/headers.rb", "focal_code": "def initialize(header_values = nil)\n        @header = {}\n        if header_values\n          header_values.each_pair do |k,v|\n            if v.is_a?(Array)\n              v.each do |sub_v|\n                add_field(k, sub_v)\n              end\n            else\n              add_field(k, v)\n            end\n          end\n        end\n        super(@header)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'delegate'\n\nmodule HTTParty\n  class Response #:nodoc:\n    class Headers < ::SimpleDelegator\n      include ::Net::HTTPHeader\n\n      def initialize(header_values = nil)\n        @header = {}\n        if header_values\n          header_values.each_pair do |k,v|\n            if v.is_a?(Array)\n              v.each do |sub_v|\n                add_field(k, sub_v)\n              end\n            else\n              add_field(k, v)\n            end\n          end\n        end\n        super(@header)\n      end\n\n      def ==(other)\n        if other.is_a?(::Net::HTTPHeader)\n          @header == other.instance_variable_get(:@header)\n        elsif other.is_a?(Hash)\n          @header == other || @header == Headers.new(other).instance_variable_get(:@header)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(header_values = nil)", "start_line": 10, "end_line": 24}, "metadata": {"module": "HTTParty", "class_name": "Response", "class_signature": "class Response"}, "task_id": 219}
{"function_name": "authorize", "file_path": "pundit/lib/pundit/context.rb", "focal_code": "def authorize(possibly_namespaced_record, query:, policy_class:)\n      record = pundit_model(possibly_namespaced_record)\n      policy = if policy_class\n        policy_class.new(user, record)\n      else\n        policy!(possibly_namespaced_record)\n      end\n\n      raise NotAuthorizedError, query: query, record: record, policy: policy unless policy.public_send(query)\n\n      record\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Pundit\n  # {Pundit::Context} is intended to be created once per request and user, and\n  # it is then used to perform authorization checks throughout the request.\n  #\n  # @example Using Sinatra\n  #   helpers do\n  #     def current_user = ...\n  #\n  #     def pundit\n  #       @pundit ||= Pundit::Context.new(user: current_user)\n  #     end\n  #   end\n  #\n  #   get \"/posts/:id\" do |id|\n  #     pundit.authorize(Post.find(id), query: :show?)\n  #   end\n  #\n  # @example Using [Roda](https://roda.jeremyevans.net/index.html)\n  #   route do |r|\n  #     context = Pundit::Context.new(user:)\n  #\n  #     r.get \"posts\", Integer do |id|\n  #       context.authorize(Post.find(id), query: :show?)\n  #     end\n  #   end\n  #\n  # @since v2.3.2\n  class Context\n    # @see Pundit::Authorization#pundit\n    # @param user later passed to policies and scopes\n    # @param policy_cache [#fetch] cache store for policies (see e.g. {CacheStore::NullStore})\n    # @since v2.3.2\n    def initialize(user:, policy_cache: CacheStore::NullStore.instance)\n      @user = user\n      @policy_cache = policy_cache\n    end\n\n    # @api public\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :user\n\n    # @api private\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :policy_cache\n\n    # @!group Policies\n\n    # Retrieves the policy for the given record, initializing it with the\n    # record and user and finally throwing an error if the user is not\n    # authorized to perform the given action.\n    #\n    # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of\n    # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`)\n    # @param policy_class [Class] the policy class we want to force use of\n    # @raise [NotAuthorizedError] if the given query method returned false\n    # @return [Object] Always returns the passed object record\n    # @since v2.3.2\n    def authorize(possibly_namespaced_record, query:, policy_class:)\n      record = pundit_model(possibly_namespaced_record)\n      policy = if policy_class\n        policy_class.new(user, record)\n      else\n        policy!(possibly_namespaced_record)\n      end\n\n      raise NotAuthorizedError, query: query, record: record, policy: policy unless policy.public_send(query)\n\n      record\n    end\n\n    # Retrieves the policy for the given record.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object, nil] instance of policy class with query methods\n    # @since v2.3.2\n    def policy(record)\n      cached_find(record, &:policy)\n    end\n\n    # Retrieves the policy for the given record, or raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [NotDefinedError] if the policy cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object] instance of policy class with query methods\n    # @since v2.3.2\n    def policy!(record)\n      cached_find(record, &:policy!)\n    end\n\n    # @!endgroup\n\n    # @!group Scopes\n\n    # Retrieves the policy scope for the given record.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope(scope)\n      policy_scope_class = policy_finder(scope).scope\n      return unless policy_scope_class\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # Retrieves the policy scope for the given record. Raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [NotDefinedError] if the policy scope cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope!(scope)\n      policy_scope_class = policy_finder(scope).scope!\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # @!endgroup\n\n    private\n\n    # @!group Private Helpers\n\n    # Finds a cached policy for the given record, or yields to find one.\n    #\n    # @api private\n    # @param record [Object] the object we're retrieving the policy for\n    # @yield a policy finder if no policy was cached\n    # @yieldparam [PolicyFinder] policy_finder\n    # @yieldreturn [#new(user, model)]\n    # @return [Policy, nil] an instantiated policy\n    # @raise [InvalidConstructorError] if policy can't be instantated\n    # @since v2.3.2\n    def cached_find(record)\n      policy_cache.fetch(user: user, record: record) do\n        klass = yield policy_finder(record)\n        next unless klass\n\n        model = pundit_model(record)\n\n        begin\n          klass.new(user, model)\n        rescue ArgumentError\n          raise InvalidConstructorError, \"Invalid #<#{klass}> constructor is called\"\n        end\n      end\n    end\n\n    # Return a policy finder for the given record.\n    #\n    # @api private\n    # @return [PolicyFinder]\n    # @since v2.3.2\n    def policy_finder(record)\n      PolicyFinder.new(record)\n    end\n\n    # Given a possibly namespaced record, return the actual record.\n    #\n    # @api private\n    # @since v2.3.2\n    def pundit_model(record)\n      record.is_a?(Array) ? record.last : record\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "authorize", "signature": "def authorize(possibly_namespaced_record, query:, policy_class:)", "start_line": 62, "end_line": 73}, "metadata": {"module": "Pundit", "class_name": "Context", "class_signature": "class Context"}, "task_id": 220}
{"function_name": "policy_scope", "file_path": "pundit/lib/pundit/context.rb", "focal_code": "def policy_scope(scope)\n      policy_scope_class = policy_finder(scope).scope\n      return unless policy_scope_class\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Pundit\n  # {Pundit::Context} is intended to be created once per request and user, and\n  # it is then used to perform authorization checks throughout the request.\n  #\n  # @example Using Sinatra\n  #   helpers do\n  #     def current_user = ...\n  #\n  #     def pundit\n  #       @pundit ||= Pundit::Context.new(user: current_user)\n  #     end\n  #   end\n  #\n  #   get \"/posts/:id\" do |id|\n  #     pundit.authorize(Post.find(id), query: :show?)\n  #   end\n  #\n  # @example Using [Roda](https://roda.jeremyevans.net/index.html)\n  #   route do |r|\n  #     context = Pundit::Context.new(user:)\n  #\n  #     r.get \"posts\", Integer do |id|\n  #       context.authorize(Post.find(id), query: :show?)\n  #     end\n  #   end\n  #\n  # @since v2.3.2\n  class Context\n    # @see Pundit::Authorization#pundit\n    # @param user later passed to policies and scopes\n    # @param policy_cache [#fetch] cache store for policies (see e.g. {CacheStore::NullStore})\n    # @since v2.3.2\n    def initialize(user:, policy_cache: CacheStore::NullStore.instance)\n      @user = user\n      @policy_cache = policy_cache\n    end\n\n    # @api public\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :user\n\n    # @api private\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :policy_cache\n\n    # @!group Policies\n\n    # Retrieves the policy for the given record, initializing it with the\n    # record and user and finally throwing an error if the user is not\n    # authorized to perform the given action.\n    #\n    # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of\n    # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`)\n    # @param policy_class [Class] the policy class we want to force use of\n    # @raise [NotAuthorizedError] if the given query method returned false\n    # @return [Object] Always returns the passed object record\n    # @since v2.3.2\n    def authorize(possibly_namespaced_record, query:, policy_class:)\n      record = pundit_model(possibly_namespaced_record)\n      policy = if policy_class\n        policy_class.new(user, record)\n      else\n        policy!(possibly_namespaced_record)\n      end\n\n      raise NotAuthorizedError, query: query, record: record, policy: policy unless policy.public_send(query)\n\n      record\n    end\n\n    # Retrieves the policy for the given record.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object, nil] instance of policy class with query methods\n    # @since v2.3.2\n    def policy(record)\n      cached_find(record, &:policy)\n    end\n\n    # Retrieves the policy for the given record, or raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [NotDefinedError] if the policy cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object] instance of policy class with query methods\n    # @since v2.3.2\n    def policy!(record)\n      cached_find(record, &:policy!)\n    end\n\n    # @!endgroup\n\n    # @!group Scopes\n\n    # Retrieves the policy scope for the given record.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope(scope)\n      policy_scope_class = policy_finder(scope).scope\n      return unless policy_scope_class\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # Retrieves the policy scope for the given record. Raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [NotDefinedError] if the policy scope cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope!(scope)\n      policy_scope_class = policy_finder(scope).scope!\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # @!endgroup\n\n    private\n\n    # @!group Private Helpers\n\n    # Finds a cached policy for the given record, or yields to find one.\n    #\n    # @api private\n    # @param record [Object] the object we're retrieving the policy for\n    # @yield a policy finder if no policy was cached\n    # @yieldparam [PolicyFinder] policy_finder\n    # @yieldreturn [#new(user, model)]\n    # @return [Policy, nil] an instantiated policy\n    # @raise [InvalidConstructorError] if policy can't be instantated\n    # @since v2.3.2\n    def cached_find(record)\n      policy_cache.fetch(user: user, record: record) do\n        klass = yield policy_finder(record)\n        next unless klass\n\n        model = pundit_model(record)\n\n        begin\n          klass.new(user, model)\n        rescue ArgumentError\n          raise InvalidConstructorError, \"Invalid #<#{klass}> constructor is called\"\n        end\n      end\n    end\n\n    # Return a policy finder for the given record.\n    #\n    # @api private\n    # @return [PolicyFinder]\n    # @since v2.3.2\n    def policy_finder(record)\n      PolicyFinder.new(record)\n    end\n\n    # Given a possibly namespaced record, return the actual record.\n    #\n    # @api private\n    # @since v2.3.2\n    def pundit_model(record)\n      record.is_a?(Array) ? record.last : record\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "policy_scope", "signature": "def policy_scope(scope)", "start_line": 109, "end_line": 120}, "metadata": {"module": "Pundit", "class_name": "Context", "class_signature": "class Context"}, "task_id": 221}
{"function_name": "cached_find", "file_path": "pundit/lib/pundit/context.rb", "focal_code": "def cached_find(record)\n      policy_cache.fetch(user: user, record: record) do\n        klass = yield policy_finder(record)\n        next unless klass\n\n        model = pundit_model(record)\n\n        begin\n          klass.new(user, model)\n        rescue ArgumentError\n          raise InvalidConstructorError, \"Invalid #<#{klass}> constructor is called\"\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Pundit\n  # {Pundit::Context} is intended to be created once per request and user, and\n  # it is then used to perform authorization checks throughout the request.\n  #\n  # @example Using Sinatra\n  #   helpers do\n  #     def current_user = ...\n  #\n  #     def pundit\n  #       @pundit ||= Pundit::Context.new(user: current_user)\n  #     end\n  #   end\n  #\n  #   get \"/posts/:id\" do |id|\n  #     pundit.authorize(Post.find(id), query: :show?)\n  #   end\n  #\n  # @example Using [Roda](https://roda.jeremyevans.net/index.html)\n  #   route do |r|\n  #     context = Pundit::Context.new(user:)\n  #\n  #     r.get \"posts\", Integer do |id|\n  #       context.authorize(Post.find(id), query: :show?)\n  #     end\n  #   end\n  #\n  # @since v2.3.2\n  class Context\n    # @see Pundit::Authorization#pundit\n    # @param user later passed to policies and scopes\n    # @param policy_cache [#fetch] cache store for policies (see e.g. {CacheStore::NullStore})\n    # @since v2.3.2\n    def initialize(user:, policy_cache: CacheStore::NullStore.instance)\n      @user = user\n      @policy_cache = policy_cache\n    end\n\n    # @api public\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :user\n\n    # @api private\n    # @see #initialize\n    # @since v2.3.2\n    attr_reader :policy_cache\n\n    # @!group Policies\n\n    # Retrieves the policy for the given record, initializing it with the\n    # record and user and finally throwing an error if the user is not\n    # authorized to perform the given action.\n    #\n    # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of\n    # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`)\n    # @param policy_class [Class] the policy class we want to force use of\n    # @raise [NotAuthorizedError] if the given query method returned false\n    # @return [Object] Always returns the passed object record\n    # @since v2.3.2\n    def authorize(possibly_namespaced_record, query:, policy_class:)\n      record = pundit_model(possibly_namespaced_record)\n      policy = if policy_class\n        policy_class.new(user, record)\n      else\n        policy!(possibly_namespaced_record)\n      end\n\n      raise NotAuthorizedError, query: query, record: record, policy: policy unless policy.public_send(query)\n\n      record\n    end\n\n    # Retrieves the policy for the given record.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object, nil] instance of policy class with query methods\n    # @since v2.3.2\n    def policy(record)\n      cached_find(record, &:policy)\n    end\n\n    # Retrieves the policy for the given record, or raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#policies\n    # @param record [Object] the object we're retrieving the policy for\n    # @raise [NotDefinedError] if the policy cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Object] instance of policy class with query methods\n    # @since v2.3.2\n    def policy!(record)\n      cached_find(record, &:policy!)\n    end\n\n    # @!endgroup\n\n    # @!group Scopes\n\n    # Retrieves the policy scope for the given record.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope(scope)\n      policy_scope_class = policy_finder(scope).scope\n      return unless policy_scope_class\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # Retrieves the policy scope for the given record. Raises if not found.\n    #\n    # @see https://github.com/varvet/pundit#scopes\n    # @param scope [Object] the object we're retrieving the policy scope for\n    # @raise [NotDefinedError] if the policy scope cannot be found\n    # @raise [InvalidConstructorError] if the policy constructor called incorrectly\n    # @return [Scope{#resolve}] instance of scope class which can resolve to a scope\n    # @since v2.3.2\n    def policy_scope!(scope)\n      policy_scope_class = policy_finder(scope).scope!\n\n      begin\n        policy_scope = policy_scope_class.new(user, pundit_model(scope))\n      rescue ArgumentError\n        raise InvalidConstructorError, \"Invalid #<#{policy_scope_class}> constructor is called\"\n      end\n\n      policy_scope.resolve\n    end\n\n    # @!endgroup\n\n    private\n\n    # @!group Private Helpers\n\n    # Finds a cached policy for the given record, or yields to find one.\n    #\n    # @api private\n    # @param record [Object] the object we're retrieving the policy for\n    # @yield a policy finder if no policy was cached\n    # @yieldparam [PolicyFinder] policy_finder\n    # @yieldreturn [#new(user, model)]\n    # @return [Policy, nil] an instantiated policy\n    # @raise [InvalidConstructorError] if policy can't be instantated\n    # @since v2.3.2\n    def cached_find(record)\n      policy_cache.fetch(user: user, record: record) do\n        klass = yield policy_finder(record)\n        next unless klass\n\n        model = pundit_model(record)\n\n        begin\n          klass.new(user, model)\n        rescue ArgumentError\n          raise InvalidConstructorError, \"Invalid #<#{klass}> constructor is called\"\n        end\n      end\n    end\n\n    # Return a policy finder for the given record.\n    #\n    # @api private\n    # @return [PolicyFinder]\n    # @since v2.3.2\n    def policy_finder(record)\n      PolicyFinder.new(record)\n    end\n\n    # Given a possibly namespaced record, return the actual record.\n    #\n    # @api private\n    # @since v2.3.2\n    def pundit_model(record)\n      record.is_a?(Array) ? record.last : record\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "cached_find", "signature": "def cached_find(record)", "start_line": 158, "end_line": 171}, "metadata": {"module": "Pundit", "class_name": "Context", "class_signature": "class Context"}, "task_id": 222}
{"function_name": "initialize", "file_path": "pundit/lib/pundit/error.rb", "focal_code": "def initialize(options = {})\n      if options.is_a? String\n        message = options\n      else\n        @query  = options[:query]\n        @record = options[:record]\n        @policy = options[:policy]\n\n        message = options.fetch(:message) do\n          record_name = record.is_a?(Class) ? record.to_s : \"this #{record.class}\"\n          \"not allowed to #{policy.class}##{query} #{record_name}\"\n        end\n      end\n\n      super(message)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Pundit\n  # @api private\n  # @since v1.0.0\n  # To avoid name clashes with common Error naming when mixing in Pundit,\n  # keep it here with compact class style definition.\n  class Error < StandardError; end\n\n  # Error that will be raised when authorization has failed\n  # @since v0.1.0\n  class NotAuthorizedError < Error\n    # @see #initialize\n    # @since v0.2.3\n    attr_reader :query\n    # @see #initialize\n    # @since v0.2.3\n    attr_reader :record\n    # @see #initialize\n    # @since v0.2.3\n    attr_reader :policy\n\n    # @since v1.0.0\n    #\n    # @overload initialize(message)\n    #   Create an error with a simple error message.\n    #   @param [String] message A simple error message string.\n    #\n    # @overload initialize(options)\n    #   Create an error with the specified attributes.\n    #   @param [Hash] options The error options.\n    #   @option options [String] :message Optional custom error message. Will default to a generalized message.\n    #   @option options [Symbol] :query The name of the policy method that was checked.\n    #   @option options [Object] :record The object that was being checked with the policy.\n    #   @option options [Class] :policy The class of policy that was used for the check.\n    def initialize(options = {})\n      if options.is_a? String\n        message = options\n      else\n        @query  = options[:query]\n        @record = options[:record]\n        @policy = options[:policy]\n\n        message = options.fetch(:message) do\n          record_name = record.is_a?(Class) ? record.to_s : \"this #{record.class}\"\n          \"not allowed to #{policy.class}##{query} #{record_name}\"\n        end\n      end\n\n      super(message)\n    end\n  end\n\n  # Error that will be raised if a policy or policy scope constructor is not called correctly.\n  # @since v2.0.0\n  class InvalidConstructorError < Error; end\n\n  # Error that will be raised if a controller action has not called the\n  # `authorize` or `skip_authorization` methods.\n  # @since v0.2.3\n  class AuthorizationNotPerformedError < Error; end\n\n  # Error that will be raised if a controller action has not called the\n  # `policy_scope` or `skip_policy_scope` methods.\n  # @since v0.3.0\n  class PolicyScopingNotPerformedError < AuthorizationNotPerformedError; end\n\n  # Error that will be raised if a policy or policy scope is not defined.\n  # @since v0.1.0\n  class NotDefinedError < Error; end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(options = {})", "start_line": 36, "end_line": 51}, "metadata": {"module": "Pundit", "class_name": "NotAuthorizedError", "class_signature": "class NotAuthorizedError < < Error"}, "task_id": 223}
{"function_name": "param_key", "file_path": "pundit/lib/pundit/policy_finder.rb", "focal_code": "def param_key # rubocop:disable Metrics/AbcSize\n      model = object.is_a?(Array) ? object.last : object\n\n      if model.respond_to?(:model_name)\n        model.model_name.param_key.to_s\n      elsif model.is_a?(Class)\n        model.to_s.demodulize.underscore\n      else\n        model.class.to_s.demodulize.underscore\n      end\n    end", "file_content": "# frozen_string_literal: true\n\n# String#safe_constantize, String#demodulize, String#underscore, String#camelize\nrequire \"active_support/core_ext/string/inflections\"\n\nmodule Pundit\n  # Finds policy and scope classes for given object.\n  # @since v0.1.0\n  # @api public\n  # @example\n  #   user = User.find(params[:id])\n  #   finder = PolicyFinder.new(user)\n  #   finder.policy #=> UserPolicy\n  #   finder.scope #=> UserPolicy::Scope\n  #\n  class PolicyFinder\n    # A constant applied to the end of the class name to find the policy class.\n    #\n    # @api private\n    # @since v2.5.0\n    SUFFIX = \"Policy\"\n\n    # @see #initialize\n    # @since v0.1.0\n    attr_reader :object\n\n    # @param object [any] the object to find policy and scope classes for\n    # @since v0.1.0\n    def initialize(object)\n      @object = object\n    end\n\n    # @return [nil, Scope{#resolve}] scope class which can resolve to a scope\n    # @see https://github.com/varvet/pundit#scopes\n    # @example\n    #   scope = finder.scope #=> UserPolicy::Scope\n    #   scope.resolve #=> <#ActiveRecord::Relation ...>\n    #\n    # @since v0.1.0\n    def scope\n      \"#{policy}::Scope\".safe_constantize\n    end\n\n    # @return [nil, Class] policy class with query methods\n    # @see https://github.com/varvet/pundit#policies\n    # @example\n    #   policy = finder.policy #=> UserPolicy\n    #   policy.show? #=> true\n    #   policy.update? #=> false\n    #\n    # @since v0.1.0\n    def policy\n      klass = find(object)\n      klass.is_a?(String) ? klass.safe_constantize : klass\n    end\n\n    # @return [Scope{#resolve}] scope class which can resolve to a scope\n    # @raise [NotDefinedError] if scope could not be determined\n    #\n    # @since v0.1.0\n    def scope!\n      scope or raise NotDefinedError, \"unable to find scope `#{find(object)}::Scope` for `#{object.inspect}`\"\n    end\n\n    # @return [Class] policy class with query methods\n    # @raise [NotDefinedError] if policy could not be determined\n    #\n    # @since v0.1.0\n    def policy!\n      policy or raise NotDefinedError, \"unable to find policy `#{find(object)}` for `#{object.inspect}`\"\n    end\n\n    # @return [String] the name of the key this object would have in a params hash\n    #\n    # @since v1.1.0\n    def param_key # rubocop:disable Metrics/AbcSize\n      model = object.is_a?(Array) ? object.last : object\n\n      if model.respond_to?(:model_name)\n        model.model_name.param_key.to_s\n      elsif model.is_a?(Class)\n        model.to_s.demodulize.underscore\n      else\n        model.class.to_s.demodulize.underscore\n      end\n    end\n\n    private\n\n    # Given an object, find the policy class name.\n    #\n    # Uses recursion to handle namespaces.\n    #\n    # @return [String, Class] the policy class, or its name.\n    # @since v0.2.0\n    def find(subject)\n      if subject.is_a?(Array)\n        modules = subject.dup\n        last = modules.pop\n        context = modules.map { |x| find_class_name(x) }.join(\"::\")\n        [context, find(last)].join(\"::\")\n      elsif subject.respond_to?(:policy_class)\n        subject.policy_class\n      elsif subject.class.respond_to?(:policy_class)\n        subject.class.policy_class\n      else\n        klass = find_class_name(subject)\n        \"#{klass}#{SUFFIX}\"\n      end\n    end\n\n    # Given an object, find its' class name.\n    #\n    # - Supports ActiveModel.\n    # - Supports regular classes.\n    # - Supports symbols.\n    # - Supports object instances.\n    #\n    # @return [String, Class] the class, or its name.\n    # @since v1.1.0\n    def find_class_name(subject)\n      if subject.respond_to?(:model_name)\n        subject.model_name\n      elsif subject.class.respond_to?(:model_name)\n        subject.class.model_name\n      elsif subject.is_a?(Class)\n        subject\n      elsif subject.is_a?(Symbol)\n        subject.to_s.camelize\n      else\n        subject.class\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "param_key", "signature": "def param_key # rubocop:disable Metrics/AbcSize model = object.is_a?(Array) ? object.last : object", "start_line": 76, "end_line": 86}, "metadata": {"module": "Pundit", "class_name": "PolicyFinder", "class_signature": "class PolicyFinder"}, "task_id": 224}
{"function_name": "find", "file_path": "pundit/lib/pundit/policy_finder.rb", "focal_code": "def find(subject)\n      if subject.is_a?(Array)\n        modules = subject.dup\n        last = modules.pop\n        context = modules.map { |x| find_class_name(x) }.join(\"::\")\n        [context, find(last)].join(\"::\")\n      elsif subject.respond_to?(:policy_class)\n        subject.policy_class\n      elsif subject.class.respond_to?(:policy_class)\n        subject.class.policy_class\n      else\n        klass = find_class_name(subject)\n        \"#{klass}#{SUFFIX}\"\n      end\n    end", "file_content": "# frozen_string_literal: true\n\n# String#safe_constantize, String#demodulize, String#underscore, String#camelize\nrequire \"active_support/core_ext/string/inflections\"\n\nmodule Pundit\n  # Finds policy and scope classes for given object.\n  # @since v0.1.0\n  # @api public\n  # @example\n  #   user = User.find(params[:id])\n  #   finder = PolicyFinder.new(user)\n  #   finder.policy #=> UserPolicy\n  #   finder.scope #=> UserPolicy::Scope\n  #\n  class PolicyFinder\n    # A constant applied to the end of the class name to find the policy class.\n    #\n    # @api private\n    # @since v2.5.0\n    SUFFIX = \"Policy\"\n\n    # @see #initialize\n    # @since v0.1.0\n    attr_reader :object\n\n    # @param object [any] the object to find policy and scope classes for\n    # @since v0.1.0\n    def initialize(object)\n      @object = object\n    end\n\n    # @return [nil, Scope{#resolve}] scope class which can resolve to a scope\n    # @see https://github.com/varvet/pundit#scopes\n    # @example\n    #   scope = finder.scope #=> UserPolicy::Scope\n    #   scope.resolve #=> <#ActiveRecord::Relation ...>\n    #\n    # @since v0.1.0\n    def scope\n      \"#{policy}::Scope\".safe_constantize\n    end\n\n    # @return [nil, Class] policy class with query methods\n    # @see https://github.com/varvet/pundit#policies\n    # @example\n    #   policy = finder.policy #=> UserPolicy\n    #   policy.show? #=> true\n    #   policy.update? #=> false\n    #\n    # @since v0.1.0\n    def policy\n      klass = find(object)\n      klass.is_a?(String) ? klass.safe_constantize : klass\n    end\n\n    # @return [Scope{#resolve}] scope class which can resolve to a scope\n    # @raise [NotDefinedError] if scope could not be determined\n    #\n    # @since v0.1.0\n    def scope!\n      scope or raise NotDefinedError, \"unable to find scope `#{find(object)}::Scope` for `#{object.inspect}`\"\n    end\n\n    # @return [Class] policy class with query methods\n    # @raise [NotDefinedError] if policy could not be determined\n    #\n    # @since v0.1.0\n    def policy!\n      policy or raise NotDefinedError, \"unable to find policy `#{find(object)}` for `#{object.inspect}`\"\n    end\n\n    # @return [String] the name of the key this object would have in a params hash\n    #\n    # @since v1.1.0\n    def param_key # rubocop:disable Metrics/AbcSize\n      model = object.is_a?(Array) ? object.last : object\n\n      if model.respond_to?(:model_name)\n        model.model_name.param_key.to_s\n      elsif model.is_a?(Class)\n        model.to_s.demodulize.underscore\n      else\n        model.class.to_s.demodulize.underscore\n      end\n    end\n\n    private\n\n    # Given an object, find the policy class name.\n    #\n    # Uses recursion to handle namespaces.\n    #\n    # @return [String, Class] the policy class, or its name.\n    # @since v0.2.0\n    def find(subject)\n      if subject.is_a?(Array)\n        modules = subject.dup\n        last = modules.pop\n        context = modules.map { |x| find_class_name(x) }.join(\"::\")\n        [context, find(last)].join(\"::\")\n      elsif subject.respond_to?(:policy_class)\n        subject.policy_class\n      elsif subject.class.respond_to?(:policy_class)\n        subject.class.policy_class\n      else\n        klass = find_class_name(subject)\n        \"#{klass}#{SUFFIX}\"\n      end\n    end\n\n    # Given an object, find its' class name.\n    #\n    # - Supports ActiveModel.\n    # - Supports regular classes.\n    # - Supports symbols.\n    # - Supports object instances.\n    #\n    # @return [String, Class] the class, or its name.\n    # @since v1.1.0\n    def find_class_name(subject)\n      if subject.respond_to?(:model_name)\n        subject.model_name\n      elsif subject.class.respond_to?(:model_name)\n        subject.class.model_name\n      elsif subject.is_a?(Class)\n        subject\n      elsif subject.is_a?(Symbol)\n        subject.to_s.camelize\n      else\n        subject.class\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find", "signature": "def find(subject)", "start_line": 96, "end_line": 110}, "metadata": {"module": "Pundit", "class_name": "PolicyFinder", "class_signature": "class PolicyFinder"}, "task_id": 225}
{"function_name": "find_class_name", "file_path": "pundit/lib/pundit/policy_finder.rb", "focal_code": "def find_class_name(subject)\n      if subject.respond_to?(:model_name)\n        subject.model_name\n      elsif subject.class.respond_to?(:model_name)\n        subject.class.model_name\n      elsif subject.is_a?(Class)\n        subject\n      elsif subject.is_a?(Symbol)\n        subject.to_s.camelize\n      else\n        subject.class\n      end\n    end", "file_content": "# frozen_string_literal: true\n\n# String#safe_constantize, String#demodulize, String#underscore, String#camelize\nrequire \"active_support/core_ext/string/inflections\"\n\nmodule Pundit\n  # Finds policy and scope classes for given object.\n  # @since v0.1.0\n  # @api public\n  # @example\n  #   user = User.find(params[:id])\n  #   finder = PolicyFinder.new(user)\n  #   finder.policy #=> UserPolicy\n  #   finder.scope #=> UserPolicy::Scope\n  #\n  class PolicyFinder\n    # A constant applied to the end of the class name to find the policy class.\n    #\n    # @api private\n    # @since v2.5.0\n    SUFFIX = \"Policy\"\n\n    # @see #initialize\n    # @since v0.1.0\n    attr_reader :object\n\n    # @param object [any] the object to find policy and scope classes for\n    # @since v0.1.0\n    def initialize(object)\n      @object = object\n    end\n\n    # @return [nil, Scope{#resolve}] scope class which can resolve to a scope\n    # @see https://github.com/varvet/pundit#scopes\n    # @example\n    #   scope = finder.scope #=> UserPolicy::Scope\n    #   scope.resolve #=> <#ActiveRecord::Relation ...>\n    #\n    # @since v0.1.0\n    def scope\n      \"#{policy}::Scope\".safe_constantize\n    end\n\n    # @return [nil, Class] policy class with query methods\n    # @see https://github.com/varvet/pundit#policies\n    # @example\n    #   policy = finder.policy #=> UserPolicy\n    #   policy.show? #=> true\n    #   policy.update? #=> false\n    #\n    # @since v0.1.0\n    def policy\n      klass = find(object)\n      klass.is_a?(String) ? klass.safe_constantize : klass\n    end\n\n    # @return [Scope{#resolve}] scope class which can resolve to a scope\n    # @raise [NotDefinedError] if scope could not be determined\n    #\n    # @since v0.1.0\n    def scope!\n      scope or raise NotDefinedError, \"unable to find scope `#{find(object)}::Scope` for `#{object.inspect}`\"\n    end\n\n    # @return [Class] policy class with query methods\n    # @raise [NotDefinedError] if policy could not be determined\n    #\n    # @since v0.1.0\n    def policy!\n      policy or raise NotDefinedError, \"unable to find policy `#{find(object)}` for `#{object.inspect}`\"\n    end\n\n    # @return [String] the name of the key this object would have in a params hash\n    #\n    # @since v1.1.0\n    def param_key # rubocop:disable Metrics/AbcSize\n      model = object.is_a?(Array) ? object.last : object\n\n      if model.respond_to?(:model_name)\n        model.model_name.param_key.to_s\n      elsif model.is_a?(Class)\n        model.to_s.demodulize.underscore\n      else\n        model.class.to_s.demodulize.underscore\n      end\n    end\n\n    private\n\n    # Given an object, find the policy class name.\n    #\n    # Uses recursion to handle namespaces.\n    #\n    # @return [String, Class] the policy class, or its name.\n    # @since v0.2.0\n    def find(subject)\n      if subject.is_a?(Array)\n        modules = subject.dup\n        last = modules.pop\n        context = modules.map { |x| find_class_name(x) }.join(\"::\")\n        [context, find(last)].join(\"::\")\n      elsif subject.respond_to?(:policy_class)\n        subject.policy_class\n      elsif subject.class.respond_to?(:policy_class)\n        subject.class.policy_class\n      else\n        klass = find_class_name(subject)\n        \"#{klass}#{SUFFIX}\"\n      end\n    end\n\n    # Given an object, find its' class name.\n    #\n    # - Supports ActiveModel.\n    # - Supports regular classes.\n    # - Supports symbols.\n    # - Supports object instances.\n    #\n    # @return [String, Class] the class, or its name.\n    # @since v1.1.0\n    def find_class_name(subject)\n      if subject.respond_to?(:model_name)\n        subject.model_name\n      elsif subject.class.respond_to?(:model_name)\n        subject.class.model_name\n      elsif subject.is_a?(Class)\n        subject\n      elsif subject.is_a?(Symbol)\n        subject.to_s.camelize\n      else\n        subject.class\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_class_name", "signature": "def find_class_name(subject)", "start_line": 121, "end_line": 133}, "metadata": {"module": "Pundit", "class_name": "PolicyFinder", "class_signature": "class PolicyFinder"}, "task_id": 226}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/backtrace_formatter.rb", "focal_code": "def initialize\n        @full_backtrace = false\n\n        patterns = %w[ /lib\\d*/ruby/ bin/ exe/rspec /lib/bundler/ /exe/bundle: ]\n        patterns << \"org/jruby/\" if RUBY_PLATFORM == 'java'\n        patterns.map! { |s| Regexp.new(s.gsub(\"/\", File::SEPARATOR)) }\n\n        @exclusion_patterns = [Regexp.union(RSpec::CallerFilter::IGNORE_REGEX, *patterns)]\n        @inclusion_patterns = []\n\n        return unless matches?(@exclusion_patterns, File.join(Dir.getwd, \"lib\", \"foo.rb:13\"))\n        inclusion_patterns << Regexp.new(Dir.getwd)\n      end", "file_content": "module RSpec\n  module Core\n    # @private\n    class BacktraceFormatter\n      # @private\n      attr_accessor :exclusion_patterns, :inclusion_patterns\n\n      def initialize\n        @full_backtrace = false\n\n        patterns = %w[ /lib\\d*/ruby/ bin/ exe/rspec /lib/bundler/ /exe/bundle: ]\n        patterns << \"org/jruby/\" if RUBY_PLATFORM == 'java'\n        patterns.map! { |s| Regexp.new(s.gsub(\"/\", File::SEPARATOR)) }\n\n        @exclusion_patterns = [Regexp.union(RSpec::CallerFilter::IGNORE_REGEX, *patterns)]\n        @inclusion_patterns = []\n\n        return unless matches?(@exclusion_patterns, File.join(Dir.getwd, \"lib\", \"foo.rb:13\"))\n        inclusion_patterns << Regexp.new(Dir.getwd)\n      end\n\n      attr_writer :full_backtrace\n\n      def full_backtrace?\n        @full_backtrace || exclusion_patterns.empty?\n      end\n\n      def filter_gem(gem_name)\n        sep = File::SEPARATOR\n        exclusion_patterns << /#{sep}#{gem_name}(-[^#{sep}]+)?#{sep}/\n      end\n\n      def format_backtrace(backtrace, options={})\n        return [] unless backtrace\n        return backtrace if options[:full_backtrace] || backtrace.empty?\n\n        backtrace.map { |l| backtrace_line(l) }.compact.\n          tap do |filtered|\n            if filtered.empty?\n              filtered.concat backtrace\n              filtered << \"\"\n              filtered << \"  Showing full backtrace because every line was filtered out.\"\n              filtered << \"  See docs for RSpec::Configuration#backtrace_exclusion_patterns and\"\n              filtered << \"  RSpec::Configuration#backtrace_inclusion_patterns for more information.\"\n            end\n          end\n      end\n\n      def backtrace_line(line)\n        Metadata.relative_path(line) unless exclude?(line)\n      end\n\n      def exclude?(line)\n        return false if @full_backtrace\n        matches?(exclusion_patterns, line) && !matches?(inclusion_patterns, line)\n      end\n\n    private\n\n      def matches?(patterns, line)\n        patterns.any? { |p| line =~ p }\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize @full_backtrace = false", "start_line": 8, "end_line": 20}, "metadata": {"module": "RSpec", "class_name": "BacktraceFormatter", "class_signature": "class BacktraceFormatter"}, "task_id": 227}
{"function_name": "format_backtrace", "file_path": "rspec-core/lib/rspec/core/backtrace_formatter.rb", "focal_code": "def format_backtrace(backtrace, options={})\n        return [] unless backtrace\n        return backtrace if options[:full_backtrace] || backtrace.empty?\n\n        backtrace.map { |l| backtrace_line(l) }.compact.\n          tap do |filtered|\n            if filtered.empty?\n              filtered.concat backtrace\n              filtered << \"\"\n              filtered << \"  Showing full backtrace because every line was filtered out.\"\n              filtered << \"  See docs for RSpec::Configuration#backtrace_exclusion_patterns and\"\n              filtered << \"  RSpec::Configuration#backtrace_inclusion_patterns for more information.\"\n            end\n          end\n      end", "file_content": "module RSpec\n  module Core\n    # @private\n    class BacktraceFormatter\n      # @private\n      attr_accessor :exclusion_patterns, :inclusion_patterns\n\n      def initialize\n        @full_backtrace = false\n\n        patterns = %w[ /lib\\d*/ruby/ bin/ exe/rspec /lib/bundler/ /exe/bundle: ]\n        patterns << \"org/jruby/\" if RUBY_PLATFORM == 'java'\n        patterns.map! { |s| Regexp.new(s.gsub(\"/\", File::SEPARATOR)) }\n\n        @exclusion_patterns = [Regexp.union(RSpec::CallerFilter::IGNORE_REGEX, *patterns)]\n        @inclusion_patterns = []\n\n        return unless matches?(@exclusion_patterns, File.join(Dir.getwd, \"lib\", \"foo.rb:13\"))\n        inclusion_patterns << Regexp.new(Dir.getwd)\n      end\n\n      attr_writer :full_backtrace\n\n      def full_backtrace?\n        @full_backtrace || exclusion_patterns.empty?\n      end\n\n      def filter_gem(gem_name)\n        sep = File::SEPARATOR\n        exclusion_patterns << /#{sep}#{gem_name}(-[^#{sep}]+)?#{sep}/\n      end\n\n      def format_backtrace(backtrace, options={})\n        return [] unless backtrace\n        return backtrace if options[:full_backtrace] || backtrace.empty?\n\n        backtrace.map { |l| backtrace_line(l) }.compact.\n          tap do |filtered|\n            if filtered.empty?\n              filtered.concat backtrace\n              filtered << \"\"\n              filtered << \"  Showing full backtrace because every line was filtered out.\"\n              filtered << \"  See docs for RSpec::Configuration#backtrace_exclusion_patterns and\"\n              filtered << \"  RSpec::Configuration#backtrace_inclusion_patterns for more information.\"\n            end\n          end\n      end\n\n      def backtrace_line(line)\n        Metadata.relative_path(line) unless exclude?(line)\n      end\n\n      def exclude?(line)\n        return false if @full_backtrace\n        matches?(exclusion_patterns, line) && !matches?(inclusion_patterns, line)\n      end\n\n    private\n\n      def matches?(patterns, line)\n        patterns.any? { |p| line =~ p }\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "format_backtrace", "signature": "def format_backtrace(backtrace, options={})", "start_line": 33, "end_line": 47}, "metadata": {"module": "RSpec", "class_name": "BacktraceFormatter", "class_signature": "class BacktraceFormatter"}, "task_id": 228}
{"function_name": "deprecation_stream=", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "deprecation_stream=", "signature": "def deprecation_stream", "start_line": 168, "end_line": 178}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 229}
{"function_name": "fail_fast=", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "fail_fast=", "signature": "def fail_fast", "start_line": 214, "end_line": 233}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 230}
{"function_name": "output_stream=", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "output_stream=", "signature": "def output_stream", "start_line": 274, "end_line": 284}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 231}
{"function_name": "shared_context_metadata_behavior=", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "shared_context_metadata_behavior=", "signature": "def shared_context_metadata_behavior", "start_line": 434, "end_line": 443}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 232}
{"function_name": "bisect_runner=", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect_runner=", "signature": "def bisect_runner", "start_line": 506, "end_line": 516}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 233}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize # rubocop:disable Style/GlobalVars", "start_line": 534, "end_line": 592}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 234}
{"function_name": "mock_framework", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "mock_framework", "signature": "def mock_framework if @mock_framework.nil?", "start_line": 676, "end_line": 685}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 235}
{"function_name": "mock_with", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "mock_with", "signature": "def mock_with(framework)", "start_line": 793, "end_line": 823}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 236}
{"function_name": "expectation_frameworks", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "expectation_frameworks", "signature": "def expectation_frameworks if @expectation_frameworks.empty?", "start_line": 826, "end_line": 835}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 237}
{"function_name": "expect_with", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "expect_with", "signature": "def expect_with(*frameworks)", "start_line": 865, "end_line": 905}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 238}
{"function_name": "reporter", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "reporter", "signature": "def reporter # @reporter_buffer should only ever be set in this method to cover", "start_line": 1063, "end_line": 1074}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 239}
{"function_name": "last_run_statuses", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "last_run_statuses", "signature": "def last_run_statuses @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|", "start_line": 1108, "end_line": 1127}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 240}
{"function_name": "apply_derived_metadata_to", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "apply_derived_metadata_to", "signature": "def apply_derived_metadata_to(metadata)", "start_line": 1948, "end_line": 1971}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 241}
{"function_name": "with_suite_hooks", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "with_suite_hooks", "signature": "def with_suite_hooks return yield if dry_run?", "start_line": 2098, "end_line": 2110}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 242}
{"function_name": "bisect_runner_class", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect_runner_class", "signature": "def bisect_runner_class @bisect_runner_class ||= begin", "start_line": 2132, "end_line": 2146}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 243}
{"function_name": "load_file_handling_errors", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "load_file_handling_errors", "signature": "def load_file_handling_errors(method, file)", "start_line": 2150, "end_line": 2176}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 244}
{"function_name": "handle_suite_hook", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "handle_suite_hook", "signature": "def handle_suite_hook(scope, meta)", "start_line": 2178, "end_line": 2191}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 245}
{"function_name": "run_suite_hooks", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "run_suite_hooks", "signature": "def run_suite_hooks(hook_description, hooks)", "start_line": 2193, "end_line": 2209}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 246}
{"function_name": "get_files_to_run", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "get_files_to_run", "signature": "def get_files_to_run(paths)", "start_line": 2211, "end_line": 2221}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 247}
{"function_name": "extract_location", "file_path": "rspec-core/lib/rspec/core/configuration.rb", "focal_code": "def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end", "file_content": "RSpec::Support.require_rspec_core \"backtrace_formatter\"\nRSpec::Support.require_rspec_core \"ruby_project\"\nRSpec::Support.require_rspec_core \"formatters/deprecation_formatter\"\nRSpec::Support.require_rspec_core \"output_wrapper\"\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # Stores runtime configuration information.\n    #\n    # Configuration options are loaded from multiple files and joined together\n    # with command-line switches and the `SPEC_OPTS` environment variable.\n    #\n    # Precedence order (where later entries overwrite earlier entries on\n    # conflicts):\n    #\n    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does\n    #     not exist)\n    #   * Project-specific (`./.rspec`)\n    #   * Local (`./.rspec-local`)\n    #   * Command-line options\n    #   * `SPEC_OPTS`\n    #\n    # For example, an option set in the local file will override an option set\n    # in your global file.\n    #\n    # The global, project-specific and local files can all be overridden with a\n    # separate custom file using the --options command-line parameter.\n    #\n    # @example Standard settings\n    #     RSpec.configure do |c|\n    #       c.drb          = true\n    #       c.drb_port     = 1234\n    #       c.default_path = 'behavior'\n    #     end\n    #\n    # @example Hooks\n    #     RSpec.configure do |c|\n    #       c.before(:suite)   { establish_connection }\n    #       c.before(:example) { log_in_as :authorized }\n    #       c.around(:example) { |ex| Database.transaction(&ex) }\n    #     end\n    #\n    # @see RSpec.configure\n    # @see Hooks\n    class Configuration\n      include RSpec::Core::Hooks\n\n      # Module that holds `attr_reader` declarations. It's in a separate\n      # module to allow us to override those methods and use `super`.\n      # @private\n      Readers = Module.new\n      include Readers\n\n      # @private\n      class MustBeConfiguredBeforeExampleGroupsError < StandardError; end\n\n      # @private\n      def self.define_reader(name)\n        Readers.class_eval do\n          remove_method name if method_defined?(name)\n          attr_reader name\n        end\n\n        define_method(name) { value_for(name) { super() } }\n      end\n\n      # @private\n      def self.define_alias(name, alias_name)\n        alias_method alias_name, name\n        alias_method \"#{alias_name}=\", \"#{name}=\"\n        define_predicate alias_name\n      end\n\n      # @private\n      def self.define_predicate(name)\n        define_method \"#{name}?\" do\n          !!send(name)\n        end\n      end\n\n      # @private\n      #\n      # Invoked by the `add_setting` instance method. Use that method on a\n      # `Configuration` instance rather than this class method.\n      def self.add_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        attr_writer name\n        add_read_only_setting name\n\n        Array(opts[:alias_with]).each do |alias_name|\n          define_alias(name, alias_name)\n        end\n      end\n\n      # @private\n      #\n      # As `add_setting` but only add the reader.\n      def self.add_read_only_setting(name, opts={})\n        raise \"Use the instance add_setting method if you want to set a default\" if opts.key?(:default)\n        define_reader name\n        define_predicate name\n      end\n\n      # @macro [attach] add_setting\n      #   @!attribute [rw] $1\n      #\n      # @macro [attach] define_reader\n      #   @!attribute [r] $1\n\n      # @macro add_setting\n      # Path to use if no path is provided to the `rspec` command (default:\n      # `\"spec\"`). Allows you to just type `rspec` instead of `rspec spec` to\n      # run all the examples in the `spec` directory.\n      #\n      # @note Other scripts invoking `rspec` indirectly will ignore this\n      #   setting.\n      # @return [String]\n      add_read_only_setting :default_path\n      def default_path=(path)\n        project_source_dirs << path\n        @default_path = path\n      end\n\n      # @macro add_setting\n      # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb\n      # server, but you can use tools like spork.\n      # @return [Boolean]\n      add_setting :drb\n\n      # @macro add_setting\n      # The drb_port (default: nil).\n      add_setting :drb_port\n\n      # @macro add_setting\n      # Default: `$stderr`.\n      add_setting :error_stream\n\n      # Indicates if the DSL has been exposed off of modules and `main`.\n      # Default: true\n      # @return [Boolean]\n      def expose_dsl_globally?\n        Core::DSL.exposed_globally?\n      end\n\n      # Use this to expose the core RSpec DSL via `Module` and the `main`\n      # object. It will be set automatically but you can override it to\n      # remove the DSL.\n      # Default: true\n      def expose_dsl_globally=(value)\n        if value\n          Core::DSL.expose_globally!\n          Core::SharedExampleGroup::TopLevelDSL.expose_globally!\n        else\n          Core::DSL.remove_globally!\n          Core::SharedExampleGroup::TopLevelDSL.remove_globally!\n        end\n      end\n\n      # Determines where deprecation warnings are printed.\n      # Defaults to `$stderr`.\n      # @return [IO, String] IO or filename to write to\n      define_reader :deprecation_stream\n\n      # Determines where deprecation warnings are printed.\n      # @param value [IO, String] IO to write to or filename to write to\n      def deprecation_stream=(value)\n        if @reporter && !value.equal?(@deprecation_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{deprecation_stream.inspect} as the deprecation stream, so your change to \"\\\n            \"`deprecation_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect, or use the `--deprecation-out` CLI option. \" \\\n            \"(Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @deprecation_stream = value\n        end\n      end\n\n      # @macro define_reader\n      # The file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      #\n      # @overload example_status_persistence_file_path\n      #   @return [String] the file path\n      # @overload example_status_persistence_file_path=(value)\n      #   @param value [String] the file path\n      define_reader :example_status_persistence_file_path\n\n      # Sets the file path to use for persisting example statuses. Necessary for the\n      # `--only-failures` and `--next-failure` CLI options.\n      def example_status_persistence_file_path=(value)\n        @example_status_persistence_file_path = value\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # Indicates if the `--only-failures` (or `--next-failure`) flag is being used.\n      define_reader :only_failures\n      alias_method :only_failures?, :only_failures\n\n      # @private\n      def only_failures_but_not_configured?\n        only_failures? && !example_status_persistence_file_path\n      end\n\n      # @macro define_reader\n      # If specified, indicates the number of failures required before cleaning\n      # up and exit (default: `nil`). Can also be `true` to fail and exit on first\n      # failure\n      define_reader :fail_fast\n\n      # @see fail_fast\n      def fail_fast=(value)\n        case value\n        when true, 'true'\n          @fail_fast = true\n        when false, 'false', 0\n          @fail_fast = false\n        when nil\n          @fail_fast = nil\n        else\n          @fail_fast = value.to_i\n\n          if value.to_i == 0\n            # TODO: in RSpec 4, consider raising an error here.\n            RSpec.warning \"Cannot set `RSpec.configuration.fail_fast`\" \\\n              \" to `#{value.inspect}`. Only `true`, `false`, `nil` and integers\" \\\n              \" are valid values.\"\n            @fail_fast = true\n          end\n        end\n      end\n\n      # @macro add_setting\n      # Prints the formatter output of your suite without running any\n      # examples or hooks.\n      add_setting :dry_run\n\n      # @macro add_setting\n      # The exit code to return if there are any failures (default: 1).\n      # @return [Integer]\n      add_setting :failure_exit_code\n\n      # @macro add_setting\n      # The exit code to return if there are any errors outside examples (default: failure_exit_code)\n      # @return [Integer]\n      add_setting :error_exit_code\n\n      # @macro add_setting\n      # Whether or not to fail when there are no RSpec examples (default: false).\n      # @return [Boolean]\n      add_setting :fail_if_no_examples\n\n      # @macro define_reader\n      # Indicates files configured to be required.\n      # @return [Array<String>]\n      define_reader :requires\n\n      # @macro define_reader\n      # Returns dirs that have been prepended to the load path by the `-I`\n      # command line option.\n      # @return [Array<String>]\n      define_reader :libs\n\n      # @macro add_setting\n      # Determines where RSpec will send its output.\n      # Default: `$stdout`.\n      # @return [IO, String]\n      define_reader :output_stream\n\n      # Set the output stream for reporter.\n      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout\n      def output_stream=(value)\n        if @reporter && !value.equal?(@output_stream)\n          warn \"RSpec's reporter has already been initialized with \" \\\n            \"#{output_stream.inspect} as the output stream, so your change to \"\\\n            \"`output_stream` will be ignored. You should configure it earlier for \" \\\n            \"it to take effect. (Called from #{CallerFilter.first_non_rspec_line})\"\n        else\n          @output_stream = value\n          output_wrapper.output = @output_stream\n        end\n      end\n\n      # @macro define_reader\n      # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).\n      # @return [String]\n      define_reader :pattern\n\n      # Set pattern to match files to load.\n      # @attr value [String] the filename pattern to filter spec files by\n      def pattern=(value)\n        update_pattern_attr :pattern, value\n      end\n\n      # @macro define_reader\n      # Exclude files matching this pattern.\n      # @return [String]\n      define_reader :exclude_pattern\n\n      # Set pattern to match files to exclude.\n      # @attr value [String] the filename pattern to exclude spec files by\n      def exclude_pattern=(value)\n        update_pattern_attr :exclude_pattern, value\n      end\n\n      # @macro add_setting\n      # Specifies which directories contain the source code for your project.\n      # When a failure occurs, RSpec looks through the backtrace to find a\n      # a line of source to print. It first looks for a line coming from\n      # one of the project source directories so that, for example, it prints\n      # the expectation or assertion call rather than the source code from\n      # the expectation or assertion framework.\n      # @return [Array<String>]\n      add_setting :project_source_dirs\n\n      # @macro add_setting\n      # Report the times for the slowest examples (default: `false`).\n      # Use this to specify the number of examples to include in the profile.\n      # @return [Boolean]\n      attr_writer :profile_examples\n      define_predicate :profile_examples\n\n      # @macro add_setting\n      # Run all examples if none match the configured filters\n      # (default: `false`).\n      # @deprecated Use {#filter_run_when_matching} instead for the specific\n      #   filters that you want to be ignored if none match.\n      add_setting :run_all_when_everything_filtered\n\n      # @macro add_setting\n      # Color to use to indicate success.  Defaults to `:green` but can be set\n      # to one of the following: `[:black, :white, :red, :green, :yellow,\n      # :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :success_color\n\n      # @macro add_setting\n      # Color to use to print pending examples.  Defaults to `:yellow` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :pending_color\n\n      # @macro add_setting\n      # Color to use to indicate failure.  Defaults to `:red` but can be set to\n      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :failure_color\n\n      # @macro add_setting\n      # The default output color. Defaults to `:white` but can be set to one of\n      # the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :default_color\n\n      # @macro add_setting\n      # Color used when a pending example is fixed. Defaults to `:blue` but can\n      # be set to one of the following: `[:black, :white, :red, :green,\n      # :yellow, :blue, :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :fixed_color\n\n      # @macro add_setting\n      # Color used to print details.  Defaults to `:cyan` but can be set to one\n      # of the following: `[:black, :white, :red, :green, :yellow, :blue,\n      # :magenta, :cyan]`\n      # @return [Symbol]\n      add_setting :detail_color\n\n      # @macro add_setting\n      # Don't print filter info i.e. \"Run options: include {:focus=>true}\"\n      # (default `false`).\n      # return [Boolean]\n      add_setting :silence_filter_announcements\n\n      # @deprecated This config option was added in RSpec 2 to pave the way\n      #   for this being the default behavior in RSpec 3. Now this option is\n      #   a no-op.\n      def treat_symbols_as_metadata_keys_with_true_values=(_value)\n        RSpec.deprecate(\n          \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=\",\n          :message => \"RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= \" \\\n                      \"is deprecated, it is now set to true as default and \" \\\n                      \"setting it to false has no effect.\"\n        )\n      end\n\n      # @macro define_reader\n      # Configures how RSpec treats metadata passed as part of a shared example\n      # group definition. For example, given this shared example group definition:\n      #\n      #     RSpec.shared_context \"uses DB\", :db => true do\n      #       around(:example) do |ex|\n      #         MyORM.transaction(:rollback => true, &ex)\n      #       end\n      #     end\n      #\n      # ...there are two ways RSpec can treat the `:db => true` metadata, each\n      # of which has a corresponding config option:\n      #\n      # 1. `:trigger_inclusion`: this shared context will be implicitly included\n      #    in any groups (or examples) that have `:db => true` metadata.\n      # 2. `:apply_to_host_groups`: the metadata will be inherited by the metadata\n      #    hash of all host groups and examples.\n      #\n      # `:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should\n      # be considered deprecated. Instead, you can explicitly include a group with\n      # `include_context`:\n      #\n      #     RSpec.describe \"My model\" do\n      #       include_context \"uses DB\"\n      #     end\n      #\n      # ...or you can configure RSpec to include the context based on matching metadata\n      # using an API that mirrors configured module inclusion:\n      #\n      #     RSpec.configure do |rspec|\n      #       rspec.include_context \"uses DB\", :db => true\n      #     end\n      #\n      # `:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only\n      # supported behavior in RSpec 4.\n      #\n      # @overload shared_context_metadata_behavior\n      #   @return [:trigger_inclusion, :apply_to_host_groups] the configured behavior\n      # @overload shared_context_metadata_behavior=(value)\n      #   @param value [:trigger_inclusion, :apply_to_host_groups] sets the configured behavior\n      define_reader :shared_context_metadata_behavior\n      # @see shared_context_metadata_behavior\n      def shared_context_metadata_behavior=(value)\n        case value\n        when :trigger_inclusion, :apply_to_host_groups\n          @shared_context_metadata_behavior = value\n        else\n          raise ArgumentError, \"Cannot set `RSpec.configuration.\" \\\n            \"shared_context_metadata_behavior` to `#{value.inspect}`. Only \" \\\n            \"`:trigger_inclusion` and `:apply_to_host_groups` are valid values.\"\n        end\n      end\n\n      # Record the start time of the spec suite to measure load time.\n      # return [Time]\n      add_setting :start_time\n\n      # @macro add_setting\n      # Use threadsafe options where available.\n      # Currently this will place a mutex around memoized values such as let blocks.\n      # return [Boolean]\n      add_setting :threadsafe\n\n      # @macro add_setting\n      # Maximum count of failed source lines to display in the failure reports\n      # (defaults to `10`).\n      # return [Integer]\n      add_setting :max_displayed_failure_line_count\n\n      # @macro full_cause_backtrace\n      # Display the full backtrace of an exceptions cause (defaults to `false`).\n      # return [Boolean]\n      add_setting :full_cause_backtrace\n\n      # @macro add_setting\n      # Format the output for pending examples. Can be set to:\n      #  - :full (default) - pending examples appear similarly to failures\n      #  - :no_backtrace - same as above, but with no backtrace\n      #  - :skip - do not show the section at all\n      # return [Symbol]\n      add_read_only_setting :pending_failure_output\n      def pending_failure_output=(mode)\n        raise ArgumentError,\n              \"`pending_failure_output` can be set to :full, :no_backtrace, \" \\\n              \"or :skip\" unless [:full, :no_backtrace, :skip].include?(mode)\n        @pending_failure_output = mode\n      end\n\n      # @macro force_line_number_for_spec_rerun\n      # Display the line number (`my_spec.rb:10`), as opposed to the example id (`my_spec.rb[1:1:1]`)\n      # for shared or nested examples (defaults to `false`).\n      # return [Boolean]\n      add_setting :force_line_number_for_spec_rerun\n\n      # Determines which bisect runner implementation gets used to run subsets\n      # of the suite during a bisection. Your choices are:\n      #\n      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your\n      #     application environment each time. This runner is the most widely\n      #     compatible runner, but is not as fast. On platforms that do not\n      #     support forking, this is the default.\n      #   - `:fork`: Pre-boots RSpec and your application environment in a parent\n      #     process, and then forks a child process for each spec run. This runner\n      #     tends to be significantly faster than the `:shell` runner but cannot\n      #     be used in some situations. On platforms that support forking, this\n      #     is the default. If you use this runner, you should ensure that all\n      #     of your one-time setup logic goes in a `before(:suite)` hook instead\n      #     of getting run at the top-level of a file loaded by `--require`.\n      #\n      # @note This option will only be used by `--bisect` if you set it in a file\n      #   loaded via `--require`.\n      #\n      # @return [Symbol]\n      attr_reader :bisect_runner\n      def bisect_runner=(value)\n        if @bisect_runner_class && value != @bisect_runner\n          raise \"`config.bisect_runner = #{value.inspect}` can no longer take \" \\\n            \"effect as the #{@bisect_runner.inspect} bisect runnner is already \" \\\n            \"in use. This config setting must be set in a file loaded by a \" \\\n            \"`--require` option (passed at the CLI or in a `.rspec` file) for \" \\\n            \"it to have any effect.\"\n        end\n\n        @bisect_runner = value\n      end\n\n      # @private\n      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}\n      add_setting :tty\n      # @private\n      attr_writer :files_to_run\n      # @private\n      attr_accessor :filter_manager, :world\n      # @private\n      attr_accessor :static_config_filter_manager\n      # @private\n      attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files\n\n      # rubocop:disable Metrics/AbcSize\n      # rubocop:disable Metrics/MethodLength\n\n      # Build an object to store runtime configuration options and set defaults\n      def initialize\n        # rubocop:disable Style/GlobalVars\n        @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now\n        # rubocop:enable Style/GlobalVars\n        @expectation_frameworks = []\n        @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n        @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)\n        @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)\n\n        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell\n        @bisect_runner_class = nil\n\n        @before_suite_hooks = []\n        @after_suite_hooks  = []\n\n        @mock_framework = nil\n        @files_or_directories_to_run = []\n        @loaded_spec_files = Set.new\n        @color = false\n        @color_mode = :automatic\n        @pattern = '**{,/*/**}/*_spec.rb'\n        @exclude_pattern = ''\n        @failure_exit_code = 1\n        @error_exit_code = nil # so it can be overridden by failure exit code\n        @fail_if_no_examples = false\n        @spec_files_loaded = false\n\n        @backtrace_formatter = BacktraceFormatter.new\n\n        @default_path = 'spec'\n        @project_source_dirs = %w[ spec lib app ]\n        @deprecation_stream = $stderr\n        @output_stream = $stdout\n        @reporter = nil\n        @reporter_buffer = nil\n        @filter_manager = FilterManager.new\n        @static_config_filter_manager = FilterManager.new\n        @ordering_manager = Ordering::ConfigurationManager.new\n        @preferred_options = {}\n        @failure_color = :red\n        @success_color = :green\n        @pending_color = :yellow\n        @default_color = :white\n        @fixed_color = :blue\n        @detail_color = :cyan\n        @profile_examples = false\n        @requires = []\n        @libs = []\n        @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)\n        @threadsafe = true\n        @max_displayed_failure_line_count = 10\n        @full_cause_backtrace = false\n        @world = World::Null\n        @shared_context_metadata_behavior = :trigger_inclusion\n        @pending_failure_output = :full\n        @force_line_number_for_spec_rerun = false\n\n        define_built_in_hooks\n      end\n      # rubocop:enable Metrics/AbcSize\n      # rubocop:enable Metrics/MethodLength\n\n      # @private\n      #\n      # Used to set higher priority option values from the command line.\n      def force(hash)\n        ordering_manager.force(hash)\n        @preferred_options.merge!(hash)\n\n        return unless hash.key?(:example_status_persistence_file_path)\n        clear_values_derived_from_example_status_persistence_file_path\n      end\n\n      # @private\n      def reset\n        @spec_files_loaded = false\n        reset_reporter\n      end\n\n      # @private\n      def reset_reporter\n        @reporter = nil\n        @formatter_loader = nil\n        @output_wrapper = nil\n      end\n\n      # @private\n      def reset_filters\n        self.filter_manager = FilterManager.new\n        filter_manager.include_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)\n        )\n        filter_manager.exclude_only(\n          Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)\n        )\n      end\n\n      # @overload add_setting(name)\n      # @overload add_setting(name, opts)\n      # @option opts [Symbol] :default\n      #\n      #   Set a default value for the generated getter and predicate methods:\n      #\n      #       add_setting(:foo, :default => \"default value\")\n      #\n      # @option opts [Symbol] :alias_with\n      #\n      #   Use `:alias_with` to alias the setter, getter, and predicate to\n      #   another name, or names:\n      #\n      #       add_setting(:foo, :alias_with => :bar)\n      #       add_setting(:foo, :alias_with => [:bar, :baz])\n      #\n      # Adds a custom setting to the RSpec.configuration object.\n      #\n      #     RSpec.configuration.add_setting :foo\n      #\n      # Used internally and by extension frameworks like rspec-rails, so they\n      # can add config settings that are domain specific. For example:\n      #\n      #     RSpec.configure do |c|\n      #       c.add_setting :use_transactional_fixtures,\n      #         :default => true,\n      #         :alias_with => :use_transactional_examples\n      #     end\n      #\n      # `add_setting` creates three methods on the configuration object, a\n      # setter, a getter, and a predicate:\n      #\n      #     RSpec.configuration.foo=(value)\n      #     RSpec.configuration.foo\n      #     RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.\n      def add_setting(name, opts={})\n        default = opts.delete(:default)\n        (class << self; self; end).class_exec do\n          add_setting(name, opts)\n        end\n        __send__(\"#{name}=\", default) if default\n      end\n\n      # Returns the configured mock framework adapter module.\n      # @return [Symbol]\n      def mock_framework\n        if @mock_framework.nil?\n          begin\n            mock_with :rspec\n          rescue LoadError\n            mock_with :nothing\n          end\n        end\n        @mock_framework\n      end\n\n      # Delegates to mock_framework=(framework).\n      def mock_framework=(framework)\n        mock_with framework\n      end\n\n      # Regexps used to exclude lines from backtraces.\n      #\n      # Excludes lines from ruby (and jruby) source, installed gems, anything\n      # in any \"bin\" directory, and any of the RSpec libs (outside gem\n      # installs) by default.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      #\n      # To override this behaviour and display a full backtrace, use\n      # `--backtrace` on the command line, in a `.rspec` file, or in the\n      # `rspec_options` attribute of RSpec's rake task.\n      # @return [Array<Regexp>]\n      def backtrace_exclusion_patterns\n        @backtrace_formatter.exclusion_patterns\n      end\n\n      # Set regular expressions used to exclude lines in backtrace.\n      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns\n      def backtrace_exclusion_patterns=(patterns)\n        @backtrace_formatter.exclusion_patterns = patterns\n      end\n\n      # Regexps used to include lines in backtraces.\n      #\n      # Defaults to [Regexp.new Dir.getwd].\n      #\n      # Lines that match an exclusion _and_ an inclusion pattern\n      # will be included.\n      #\n      # You can modify the list via the getter, or replace it with the setter.\n      # @return [Array<Regexp>]\n      def backtrace_inclusion_patterns\n        @backtrace_formatter.inclusion_patterns\n      end\n\n      # Set regular expressions used to include lines in backtrace.\n      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns\n      def backtrace_inclusion_patterns=(patterns)\n        @backtrace_formatter.inclusion_patterns = patterns\n      end\n\n      # Adds {#backtrace_exclusion_patterns} that will filter lines from\n      # the named gems from backtraces.\n      #\n      # @param gem_names [Array<String>] Names of the gems to filter\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.filter_gems_from_backtrace \"rack\", \"rake\"\n      #   end\n      #\n      # @note The patterns this adds will match the named gems in their common\n      #   locations (e.g. system gems, vendored with bundler, installed as a\n      #   :git dependency with bundler, etc) but is not guaranteed to work for\n      #   all possible gem locations. For example, if you have the gem source\n      #   in a directory with a completely unrelated name, and use bundler's\n      #   :path option, this will not filter it.\n      def filter_gems_from_backtrace(*gem_names)\n        gem_names.each do |name|\n          @backtrace_formatter.filter_gem(name)\n        end\n      end\n\n      # @private\n      MOCKING_ADAPTERS = {\n        :rspec    => :RSpec,\n        :flexmock => :Flexmock,\n        :rr       => :RR,\n        :mocha    => :Mocha,\n        :nothing  => :Null\n      }\n\n      # Sets the mock framework adapter module.\n      #\n      # `framework` can be a Symbol or a Module.\n      #\n      # Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the\n      # named framework.\n      #\n      # Given `:nothing`, configures no framework. Use this if you don't use\n      # any mocking framework to save a little bit of overhead.\n      #\n      # Given a Module, includes that module in every example group. The module\n      # should adhere to RSpec's mock framework adapter API:\n      #\n      #     setup_mocks_for_rspec\n      #       - called before each example\n      #\n      #     verify_mocks_for_rspec\n      #       - called after each example if the example hasn't yet failed.\n      #         Framework should raise an exception when expectations fail\n      #\n      #     teardown_mocks_for_rspec\n      #       - called after verify_mocks_for_rspec (even if there are errors)\n      #\n      # If the module responds to `configuration` and `mock_with` receives a\n      # block, it will yield the configuration object to the block e.g.\n      #\n      #     config.mock_with OtherMockFrameworkAdapter do |mod_config|\n      #       mod_config.custom_setting = true\n      #     end\n      def mock_with(framework)\n        framework_module =\n          if framework.is_a?(Module)\n            framework\n          else\n            const_name = MOCKING_ADAPTERS.fetch(framework) do\n              raise ArgumentError,\n                    \"Unknown mocking framework: #{framework.inspect}. \" \\\n                    \"Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}\"\n            end\n\n            RSpec::Support.require_rspec_core \"mocking_adapters/#{const_name.to_s.downcase}\"\n            RSpec::Core::MockingAdapters.const_get(const_name)\n          end\n\n        new_name, old_name = [framework_module, @mock_framework].map do |mod|\n          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed\n        end\n\n        unless new_name == old_name\n          assert_no_example_groups_defined(:mock_framework)\n        end\n\n        if block_given?\n          raise \"#{framework_module} must respond to `configuration` so that \" \\\n                \"mock_with can yield it.\" unless framework_module.respond_to?(:configuration)\n          yield framework_module.configuration\n        end\n\n        @mock_framework = framework_module\n      end\n\n      # Returns the configured expectation framework adapter module(s)\n      def expectation_frameworks\n        if @expectation_frameworks.empty?\n          begin\n            expect_with :rspec\n          rescue LoadError\n            expect_with Module.new\n          end\n        end\n        @expectation_frameworks\n      end\n\n      # Delegates to expect_with(framework).\n      def expectation_framework=(framework)\n        expect_with(framework)\n      end\n\n      # Sets the expectation framework module(s) to be included in each example\n      # group.\n      #\n      # `frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom\n      # module, or any combination thereof:\n      #\n      #     config.expect_with :rspec\n      #     config.expect_with :test_unit\n      #     config.expect_with :minitest\n      #     config.expect_with :rspec, :minitest\n      #     config.expect_with OtherExpectationFramework\n      #\n      # RSpec will translate `:rspec`, `:minitest`, and `:test_unit` into the\n      # appropriate modules.\n      #\n      # ## Configuration\n      #\n      # If the module responds to `configuration`, `expect_with` will\n      # yield the `configuration` object if given a block:\n      #\n      #     config.expect_with OtherExpectationFramework do |custom_config|\n      #       custom_config.custom_setting = true\n      #     end\n      def expect_with(*frameworks)\n        modules = frameworks.map do |framework|\n          case framework\n          when Module\n            framework\n          when :rspec\n            require 'rspec/expectations'\n\n            # Tag this exception class so our exception formatting logic knows\n            # that it satisfies the `MultipleExceptionError` interface.\n            ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(\n              :include, MultipleExceptionError::InterfaceTag\n            )\n\n            ::RSpec::Matchers\n          when :test_unit\n            require 'rspec/core/test_unit_assertions_adapter'\n            ::RSpec::Core::TestUnitAssertionsAdapter\n          when :minitest\n            require 'rspec/core/minitest_assertions_adapter'\n            ::RSpec::Core::MinitestAssertionsAdapter\n          else\n            raise ArgumentError, \"#{framework.inspect} is not supported\"\n          end\n        end\n\n        if (modules - @expectation_frameworks).any?\n          assert_no_example_groups_defined(:expect_with)\n        end\n\n        if block_given?\n          raise \"expect_with only accepts a block with a single argument. \" \\\n                \"Call expect_with #{modules.length} times, \" \\\n                \"once with each argument, instead.\" if modules.length > 1\n          raise \"#{modules.first} must respond to `configuration` so that \" \\\n                \"expect_with can yield it.\" unless modules.first.respond_to?(:configuration)\n          yield modules.first.configuration\n        end\n\n        @expectation_frameworks.push(*modules)\n      end\n\n      # Check if full backtrace is enabled.\n      # @return [Boolean] is full backtrace enabled\n      def full_backtrace?\n        @backtrace_formatter.full_backtrace?\n      end\n\n      # Toggle full backtrace.\n      # @attr true_or_false [Boolean] toggle full backtrace display\n      def full_backtrace=(true_or_false)\n        @backtrace_formatter.full_backtrace = true_or_false\n      end\n\n      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is\n      # the default behavior and this option is retained only for backwards\n      # compatibility.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {#color_mode} to :on to display color on a non-TTY output.\n      # @see color_mode\n      # @see color_enabled?\n      # @return [Boolean]\n      def color\n        value_for(:color) { @color }\n      end\n\n      # The mode for determining whether to display output in color. One of:\n      #\n      # - :automatic - the output will be in color if the output is a TTY (the\n      #   default)\n      # - :on - the output will be in color, whether or not the output is a TTY\n      # - :off - the output will not be in color\n      #\n      # @see color_enabled?\n      # @return [Boolean]\n      def color_mode\n        value_for(:color_mode) { @color_mode }\n      end\n\n      # Check if color is enabled for a particular output.\n      # @param output [IO] an output stream to use, defaults to the current\n      #        `output_stream`\n      # @return [Boolean]\n      def color_enabled?(output=output_stream)\n        case color_mode\n        when :on then true\n        when :off then false\n        else # automatic\n          output_to_tty?(output) || (color && tty?)\n        end\n      end\n\n      # Set the color mode.\n      attr_writer :color_mode\n\n      # Toggle output color.\n      #\n      # @deprecated No longer recommended because of complex behavior. Instead,\n      #   rely on the fact that TTYs will display color by default, or set\n      #   {:color_mode} to :on to display color on a non-TTY output.\n      attr_writer :color\n\n      # @private\n      def libs=(libs)\n        libs.map do |lib|\n          @libs.unshift lib\n          $LOAD_PATH.unshift lib\n        end\n      end\n\n      # Run examples matching on `description` in all files to run.\n      # @param description [String, Regexp] the pattern to filter on\n      def full_description=(description)\n        filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })\n      end\n\n      # @return [Array] full description filter\n      def full_description\n        filter.fetch :full_description, nil\n      end\n\n      # @overload add_formatter(formatter)\n      # @overload add_formatter(formatter, output)\n      #\n      # @param formatter [Class, String, Object] formatter to use. Can be any of the\n      #   string values supported from the CLI (`p`/`progress`,\n      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any\n      #   class that implements the formatter protocol and has registered\n      #   itself with RSpec as a formatter, or a formatter instance.\n      # @param output [String, IO] where the formatter will write its output.\n      #   Can be an IO object or a string path to a file. If not provided,\n      #   the configured `output_stream` (`$stdout`, by default) will be used.\n      #\n      # Adds a formatter to the set RSpec will use for this run.\n      #\n      # @see RSpec::Core::Formatters::Protocol\n      def add_formatter(formatter, output=output_wrapper)\n        formatter_loader.add(formatter, output)\n      end\n      alias_method :formatter=, :add_formatter\n\n      # The formatter that will be used if no formatter has been set.\n      # Defaults to 'progress'.\n      def default_formatter\n        formatter_loader.default_formatter\n      end\n\n      # Sets a fallback formatter to use if none other has been set.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.default_formatter = 'doc'\n      #   end\n      def default_formatter=(value)\n        formatter_loader.default_formatter = value\n      end\n\n      # Returns a duplicate of the formatters currently loaded in\n      # the `FormatterLoader` for introspection.\n      #\n      # Note as this is a duplicate, any mutations will be disregarded.\n      #\n      # @return [Array] the formatters currently loaded\n      def formatters\n        formatter_loader.formatters.dup\n      end\n\n      # @private\n      def formatter_loader\n        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))\n      end\n\n      # @private\n      #\n      # This buffer is used to capture all messages sent to the reporter during\n      # reporter initialization. It can then replay those messages after the\n      # formatter is correctly initialized. Otherwise, deprecation warnings\n      # during formatter initialization can cause an infinite loop.\n      class DeprecationReporterBuffer\n        def initialize\n          @calls = []\n        end\n\n        def deprecation(*args)\n          @calls << args\n        end\n\n        def play_onto(reporter)\n          @calls.each do |args|\n            reporter.deprecation(*args)\n          end\n        end\n      end\n\n      # @return [RSpec::Core::Reporter] the currently configured reporter\n      def reporter\n        # @reporter_buffer should only ever be set in this method to cover\n        # initialization of @reporter.\n        @reporter_buffer || @reporter ||=\n          begin\n            @reporter_buffer = DeprecationReporterBuffer.new\n            formatter_loader.prepare_default output_wrapper, deprecation_stream\n            @reporter_buffer.play_onto(formatter_loader.reporter)\n            @reporter_buffer = nil\n            formatter_loader.reporter\n          end\n      end\n\n      # @api private\n      #\n      # Defaults `profile_examples` to 10 examples when `@profile_examples` is\n      # `true`.\n      def profile_examples\n        profile = value_for(:profile_examples) { @profile_examples }\n        if profile && !profile.is_a?(Integer)\n          10\n        else\n          profile\n        end\n      end\n\n      # @private\n      def files_or_directories_to_run=(*files)\n        files = files.flatten\n\n        if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?\n          files << default_path\n        end\n\n        @files_or_directories_to_run = files\n        @files_to_run = nil\n      end\n\n      # The spec files RSpec will run.\n      # @return [Array] specified files about to run\n      def files_to_run\n        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)\n      end\n\n      # @private\n      def last_run_statuses\n        @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|\n          if (path = example_status_persistence_file_path)\n            begin\n              ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|\n                status = example[:status]\n                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)\n                hash[example.fetch(:example_id)] = status\n                hash\n              end\n            rescue SystemCallError => e\n              RSpec.warning \"Could not read from #{path.inspect} (configured as \" \\\n                            \"`config.example_status_persistence_file_path`) due \" \\\n                            \"to a system error: #{e.inspect}. Please check that \" \\\n                            \"the config option is set to an accessible, valid \" \\\n                            \"file path\", :call_site => nil\n            end\n          end\n        end\n      end\n\n      # @private\n      UNKNOWN_STATUS = \"unknown\".freeze\n\n      # @private\n      FAILED_STATUS = \"failed\".freeze\n\n      # @private\n      PASSED_STATUS = \"passed\".freeze\n\n      # @private\n      PENDING_STATUS = \"pending\".freeze\n\n      # @private\n      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]\n\n      # @private\n      def spec_files_with_failures\n        @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|\n          files << Example.parse_id(id).first if status == FAILED_STATUS\n          files\n        end.to_a\n      end\n\n      # Creates a method that delegates to `example` including the submitted\n      # `args`. Used internally to add variants of `example` like `pending`:\n      # @param name [String] example name alias\n      # @param args [Array<Symbol>, Hash] metadata for the generated example\n      #\n      # @note The specific example alias below (`pending`) is already\n      #   defined for you.\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define methods like `focus` and `xit`, but we also add\n      #   docs for those methods.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_to :pending, :pending => true\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe Thing do\n      #     pending \"does something\" do\n      #       thing = Thing.new\n      #     end\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe Thing do\n      #     it \"does something\", :pending => true do\n      #       thing = Thing.new\n      #     end\n      #   end\n      def alias_example_to(name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_method(name, extra_options)\n      end\n\n      # Creates a method that defines an example group with the provided\n      # metadata. Can be used to define example group/metadata shortcuts.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_example_group_to :describe_model, :type => :model\n      #   end\n      #\n      #   shared_context_for \"model tests\", :type => :model do\n      #     # define common model test helper methods, `let` declarations, etc\n      #   end\n      #\n      #   # This lets you do this:\n      #\n      #   RSpec.describe_model User do\n      #   end\n      #\n      #   # ... which is the equivalent of\n      #\n      #   RSpec.describe User, :type => :model do\n      #   end\n      #\n      # @note The defined aliased will also be added to the top level\n      #       (e.g. `main` and from within modules) if\n      #       `expose_dsl_globally` is set to true.\n      # @see #alias_example_to\n      # @see #expose_dsl_globally=\n      def alias_example_group_to(new_name, *args)\n        extra_options = Metadata.build_hash_from(args)\n        RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)\n      end\n\n      # Define an alias for it_should_behave_like that allows different\n      # language (like \"it_has_behavior\" or \"it_behaves_like\") to be\n      # employed when including shared examples.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')\n      #   end\n      #\n      #   # allows the user to include a shared example group like:\n      #\n      #   RSpec.describe Entity do\n      #     it_has_behavior 'sortability' do\n      #       let(:sortable) { Entity.new }\n      #     end\n      #   end\n      #\n      #   # which is reported in the output as:\n      #   # Entity\n      #   #   has behavior: sortability\n      #   #     ...sortability examples here\n      #\n      # @note Use with caution. This extends the language used in your\n      #   specs, but does not add any additional documentation. We use this\n      #   in RSpec to define `it_should_behave_like` (for backward\n      #   compatibility), but we also add docs for that method.\n      def alias_it_behaves_like_to(new_name, report_label='')\n        RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)\n      end\n      alias_method :alias_it_should_behave_like_to, :alias_it_behaves_like_to\n\n      # Adds key/value pairs to the `inclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will include that group.\n      #     config.filter_run_including :foo => 'bar'\n      #     config.filter_run_including :foo => /^ba/\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_including :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_including :foo # same as filter_run_including :foo => true\n      def filter_run_including(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.include_with_low_priority meta\n        static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n      alias_method :filter_run, :filter_run_including\n\n      # Applies the provided filter only if any of examples match, in constrast\n      # to {#filter_run}, which always applies even if no examples match, in\n      # which case no examples will be run. This allows you to leave configured\n      # filters in place that are intended only for temporary use. The most common\n      # example is focus filtering: `config.filter_run_when_matching :focus`.\n      # With that configured, you can temporarily focus an example or group\n      # by tagging it with `:focus` metadata, or prefixing it with an `f`\n      # (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for\n      # `describe`/`context`/`it` with `:focus` metadata.\n      def filter_run_when_matching(*args)\n        when_first_matching_example_defined(*args) do\n          filter_run(*args)\n        end\n      end\n\n      # Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't\n      # want any inclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any inclusion filters/tags set on the command line or in\n      # configuration files.\n      def inclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.include_only meta\n      end\n\n      alias_method :filter=, :inclusion_filter=\n\n      # Returns the `inclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def inclusion_filter\n        filter_manager.inclusions\n      end\n\n      alias_method :filter, :inclusion_filter\n\n      # Adds key/value pairs to the `exclusion_filter`. If `args`\n      # includes any symbols that are not part of the hash, each symbol\n      # is treated as a key in the hash with the value `true`.\n      #\n      # ### Note\n      #\n      # Filters set using this method can be overridden from the command line\n      # or config files (e.g. `.rspec`).\n      #\n      # @example\n      #     # Given this declaration.\n      #     describe \"something\", :foo => 'bar' do\n      #       # ...\n      #     end\n      #\n      #     # Any of the following will exclude that group.\n      #     config.filter_run_excluding :foo => 'bar'\n      #     config.filter_run_excluding :foo => /^ba/\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     # Given a proc with an arity of 1, the lambda is passed the value\n      #     # related to the key, e.g.\n      #     config.filter_run_excluding :foo => lambda {|v| v == 'bar'}\n      #\n      #     # Given a proc with an arity of 2, the lambda is passed the value\n      #     # related to the key, and the metadata itself e.g.\n      #     config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}\n      #\n      #     filter_run_excluding :foo # same as filter_run_excluding :foo => true\n      def filter_run_excluding(*args)\n        meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n        filter_manager.exclude_with_low_priority meta\n        static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)\n      end\n\n      # Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't\n      # want any exclusion filter at all.\n      #\n      # ### Warning\n      #\n      # This overrides any exclusion filters/tags set on the command line or in\n      # configuration files.\n      def exclusion_filter=(filter)\n        meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)\n        filter_manager.exclude_only meta\n      end\n\n      # Returns the `exclusion_filter`. If none has been set, returns an empty\n      # hash.\n      def exclusion_filter\n        filter_manager.exclusions\n      end\n\n      # Tells RSpec to include `mod` in example groups. Methods defined in\n      # `mod` are exposed to examples (not example groups). Use `filters` to\n      # constrain the groups or examples in which to include the module.\n      #\n      # @example\n      #\n      #     module AuthenticationHelpers\n      #       def login_as(user)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PreferencesHelpers\n      #       def preferences(user, preferences = {})\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module UserHelpers\n      #       def users(username)\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include(UserHelpers) # included in all groups\n      #\n      #       # included in examples with `:preferences` metadata\n      #       config.include(PreferenceHelpers, :preferences)\n      #\n      #       # included in examples with `:type => :request` metadata\n      #       config.include(AuthenticationHelpers, :type => :request)\n      #\n      #       # included in examples where the `:type` metadata matches a proc condition\n      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })\n      #     end\n      #\n      #     describe \"edit profile\", :preferences, :type => :request do\n      #       it \"can be viewed by owning user\" do\n      #         login_as preferences(users(:jdoe), :lang => 'es')\n      #         get \"/profiles/jdoe\"\n      #         assert_select \".username\", :text => 'jdoe'\n      #       end\n      #     end\n      #\n      # @note Filtered module inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include_context\n      # @see #extend\n      # @see #prepend\n      def include(mod, *filters)\n        define_mixed_in_module(mod, filters, @include_modules, :include) do |group|\n          safe_include(mod, group)\n        end\n      end\n\n      # Tells RSpec to include the named shared example group in example groups.\n      # Use `filters` to constrain the groups or examples in which to include\n      # the example group.\n      #\n      # @example\n      #\n      #     RSpec.shared_context \"example admin user\" do\n      #       let(:admin_user) { create_user(:admin) }\n      #     end\n      #\n      #     RSpec.shared_context \"example guest user\" do\n      #       let(:guest_user) { create_user(:guest) }\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.include_context \"example guest user\", :type => :request\n      #       config.include_context \"example admin user\", :admin, :type => :request\n      #     end\n      #\n      #     RSpec.describe \"The admin page\", :type => :request do\n      #       it \"can be viewed by admins\", :admin do\n      #         login_with admin_user\n      #         get \"/admin\"\n      #         expect(response).to be_ok\n      #       end\n      #\n      #       it \"cannot be viewed by guests\" do\n      #         login_with guest_user\n      #         get \"/admin\"\n      #         expect(response).to be_forbidden\n      #       end\n      #     end\n      #\n      # @note Filtered context inclusions can also be applied to\n      #   individual examples that have matching metadata. Just like\n      #   Ruby's object model is that every object has a singleton class\n      #   which has only a single instance, RSpec's model is that every\n      #   example has a singleton example group containing just the one\n      #   example.\n      #\n      # @see #include\n      def include_context(shared_group_name, *filters)\n        shared_module = world.shared_example_group_registry.find([:main], shared_group_name)\n        include shared_module, *filters\n      end\n\n      # Tells RSpec to extend example groups with `mod`. Methods defined in\n      # `mod` are exposed to example groups (not examples). Use `filters` to\n      # constrain the groups to extend.\n      #\n      # Similar to `include`, but behavior is added to example groups, which\n      # are classes, rather than the examples, which are instances of those\n      # classes.\n      #\n      # @example\n      #\n      #     module UiHelpers\n      #       def run_in_browser\n      #         # ...\n      #       end\n      #     end\n      #\n      #     module PermissionHelpers\n      #       def define_permissions\n      #         # ...\n      #       end\n      #     end\n      #\n      #     RSpec.configure do |config|\n      #       config.extend(UiHelpers, :type => :request)\n      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)\n      #     end\n      #\n      #     describe \"edit profile\", :with_permissions, :type => :request do\n      #       run_in_browser\n      #       define_permissions\n      #\n      #       it \"does stuff in the client\" do\n      #         # ...\n      #       end\n      #     end\n      #\n      # @see #include\n      # @see #prepend\n      def extend(mod, *filters)\n        define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|\n          safe_extend(mod, group)\n        end\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        # Tells RSpec to prepend example groups with `mod`. Methods defined in\n        # `mod` are exposed to examples (not example groups). Use `filters` to\n        # constrain the groups in which to prepend the module.\n        #\n        # Similar to `include`, but module is included before the example group's class\n        # in the ancestor chain.\n        #\n        # @example\n        #\n        #     module OverrideMod\n        #       def override_me\n        #         \"overridden\"\n        #       end\n        #     end\n        #\n        #     RSpec.configure do |config|\n        #       config.prepend(OverrideMod, :method => :prepend)\n        #     end\n        #\n        #     describe \"overriding example's class\", :method => :prepend do\n        #       it \"finds the user\" do\n        #         self.class.class_eval do\n        #           def override_me\n        #           end\n        #         end\n        #         override_me # => \"overridden\"\n        #         # ...\n        #       end\n        #     end\n        #\n        # @see #include\n        # @see #extend\n        def prepend(mod, *filters)\n          define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|\n            safe_prepend(mod, group)\n          end\n        end\n      end\n\n      # @private\n      #\n      # Used internally to extend a group with modules using `include`, `prepend` and/or\n      # `extend`.\n      def configure_group(group)\n        group.hooks.register_globals(group, hooks)\n\n        configure_group_with group, @include_modules, :safe_include\n        configure_group_with group, @extend_modules,  :safe_extend\n        configure_group_with group, @prepend_modules, :safe_prepend\n      end\n\n      # @private\n      #\n      # Used internally to extend the singleton class of a single example's\n      # example group instance with modules using `include` and/or `extend`.\n      def configure_example(example, example_hooks)\n        example_hooks.register_global_singleton_context_hooks(example, hooks)\n        singleton_group = example.example_group_instance.singleton_class\n\n        # We replace the metadata so that SharedExampleGroupModule#included\n        # has access to the example's metadata[:location].\n        singleton_group.with_replaced_metadata(example.metadata) do\n          modules = @include_modules.items_for(example.metadata)\n          modules.each do |mod|\n            safe_include(mod, example.example_group_instance.singleton_class)\n          end\n\n          MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?\n        end\n      end\n\n      # @private\n      def requires=(paths)\n        directories = ['lib', default_path].select { |p| File.directory? p }\n        RSpec::Core::RubyProject.add_to_load_path(*directories)\n        paths.each { |path|\n          load_file_handling_errors(:require, path)\n          @requires << path\n        }\n      end\n\n      # @private\n      def in_project_source_dir_regex\n        regexes = project_source_dirs.map do |dir|\n          /\\A#{Regexp.escape(File.expand_path(dir))}\\//\n        end\n\n        Regexp.union(regexes)\n      end\n\n      # @private\n      def configure_mock_framework\n        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)\n        conditionally_disable_mocks_monkey_patching\n      end\n\n      # @private\n      def configure_expectation_framework\n        expectation_frameworks.each do |framework|\n          RSpec::Core::ExampleGroup.__send__(:include, framework)\n        end\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      def load_spec_files\n        # Note which spec files world is already aware of.\n        # This is generally only needed for when the user runs\n        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --\n        # in that case, the spec file was loaded by `ruby` and\n        # isn't loaded by us here so we only know about it because\n        # of an example group being registered in it.\n        world.registered_example_group_files.each do |f|\n          loaded_spec_files << f # the registered files are already expended absolute paths\n        end\n\n        files_to_run.uniq.each do |f|\n          file = File.expand_path(f)\n          load_file_handling_errors(:load, file)\n          loaded_spec_files << file\n        end\n\n        @spec_files_loaded = true\n      end\n\n      # @private\n      DEFAULT_FORMATTER = lambda { |string| string }\n\n      # Formats the docstring output using the block provided.\n      #\n      # @example\n      #   # This will strip the descriptions of both examples and example\n      #   # groups.\n      #   RSpec.configure do |config|\n      #     config.format_docstrings { |s| s.strip }\n      #   end\n      def format_docstrings(&block)\n        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER\n      end\n\n      # @private\n      def format_docstrings_block\n        @format_docstrings_block ||= DEFAULT_FORMATTER\n      end\n\n      # @private\n      def self.delegate_to_ordering_manager(*methods)\n        methods.each do |method|\n          define_method method do |*args, &block|\n            ordering_manager.__send__(method, *args, &block)\n          end\n        end\n      end\n\n      # @!method seed=(value)\n      #\n      # Sets the seed value and sets the default global ordering to random.\n      delegate_to_ordering_manager :seed=\n\n      # @!method seed\n      # Seed for random ordering (default: generated randomly each run).\n      #\n      # When you run specs with `--order random`, RSpec generates a random seed\n      # for the randomization and prints it to the `output_stream` (assuming\n      # you're using RSpec's built-in formatters). If you discover an ordering\n      # dependency (i.e. examples fail intermittently depending on order), set\n      # this (on Configuration or on the command line with `--seed`) to run\n      # using the same seed while you debug the issue.\n      #\n      # We recommend, actually, that you use the command line approach so you\n      # don't accidentally leave the seed encoded.\n      delegate_to_ordering_manager :seed\n\n      # @!method order=(value)\n      #\n      # Sets the default global ordering strategy. By default this can be one\n      # of `:defined`, `:random`, but is customizable through the\n      # `register_ordering` API. If order is set to `'rand:<seed>'`,\n      # the seed will also be set.\n      #\n      # @see #register_ordering\n      delegate_to_ordering_manager :order=\n\n      # @!method register_ordering(name)\n      #\n      # Registers a named ordering strategy that can later be\n      # used to order an example group's subgroups by adding\n      # `:order => <name>` metadata to the example group.\n      #\n      # @param name [Symbol] The name of the ordering.\n      # @yield Block that will order the given examples or example groups\n      # @yieldparam list [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The examples or groups to order\n      # @yieldreturn [Array<RSpec::Core::Example>,\n      #   Array<RSpec::Core::ExampleGroup>] The re-ordered examples or groups\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :reverse do |list|\n      #       list.reverse\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :order => :reverse do\n      #     # ...\n      #   end\n      #\n      # @note Pass the symbol `:global` to set the ordering strategy that\n      #   will be used to order the top-level example groups and any example\n      #   groups that do not have declared `:order` metadata.\n      #\n      # @example\n      #   RSpec.configure do |rspec|\n      #     rspec.register_ordering :global do |examples|\n      #       acceptance, other = examples.partition do |example|\n      #         example.metadata[:type] == :acceptance\n      #       end\n      #       other + acceptance\n      #     end\n      #   end\n      #\n      #   RSpec.describe 'MyClass', :type => :acceptance do\n      #     # will run last\n      #   end\n      #\n      #   RSpec.describe 'MyClass' do\n      #     # will run first\n      #   end\n      #\n      delegate_to_ordering_manager :register_ordering\n\n      # @private\n      delegate_to_ordering_manager :seed_used?, :ordering_registry\n\n      # Set Ruby warnings on or off.\n      def warnings=(value)\n        $VERBOSE = !!value\n      end\n\n      # @return [Boolean] Whether or not ruby warnings are enabled.\n      def warnings?\n        $VERBOSE\n      end\n\n      # @private\n      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }\n\n      # Turns RSpec warnings into errors. This can be useful when\n      # you want RSpec to run in a 'strict' no warning situation.\n      # (Note this does not capture or raise on Ruby warnings).\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_on_warning = true\n      #   end\n      def raise_on_warning=(value)\n        if value\n          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER\n        else\n          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER\n        end\n      end\n\n      # Exposes the current running example via the named\n      # helper method. RSpec 2.x exposed this via `example`,\n      # but in RSpec 3.0, the example is instead exposed via\n      # an arg yielded to `it`, `before`, `let`, etc. However,\n      # some extension gems (such as Capybara) depend on the\n      # RSpec 2.x's `example` method, so this config option\n      # can be used to maintain compatibility.\n      #\n      # @param method_name [Symbol] the name of the helper method\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.expose_current_running_example_as :example\n      #   end\n      #\n      #   RSpec.describe MyClass do\n      #     before do\n      #       # `example` can be used here because of the above config.\n      #       do_something if example.metadata[:type] == \"foo\"\n      #     end\n      #   end\n      def expose_current_running_example_as(method_name)\n        ExposeCurrentExample.module_exec do\n          extend RSpec::SharedContext\n          let(method_name) { |ex| ex }\n        end\n\n        include ExposeCurrentExample\n      end\n\n      # @private\n      module ExposeCurrentExample; end\n\n      # Turns deprecation warnings into errors, in order to surface\n      # the full backtrace of the call site. This can be useful when\n      # you need more context to address a deprecation than the\n      # single-line call site normally provided.\n      #\n      # @example\n      #\n      #   RSpec.configure do |rspec|\n      #     rspec.raise_errors_for_deprecations!\n      #   end\n      def raise_errors_for_deprecations!\n        self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new\n      end\n\n      # Enables zero monkey patching mode for RSpec. It removes monkey\n      # patching of the top-level DSL methods (`describe`,\n      # `shared_examples_for`, etc) onto `main` and `Module`, instead\n      # requiring you to prefix these methods with `RSpec.`. It enables\n      # expect-only syntax for rspec-mocks and rspec-expectations. It\n      # simply disables monkey patching on whatever pieces of RSpec\n      # the user is using.\n      #\n      # @note It configures rspec-mocks and rspec-expectations only\n      #   if the user is using those (either explicitly or implicitly\n      #   by not setting `mock_with` or `expect_with` to anything else).\n      #\n      # @note If the user uses this options with `mock_with :mocha`\n      #   (or similar) they will still have monkey patching active\n      #   in their test environment from mocha.\n      #\n      # @example\n      #\n      #   # It disables all monkey patching.\n      #   RSpec.configure do |config|\n      #     config.disable_monkey_patching!\n      #   end\n      #\n      #   # Is an equivalent to\n      #   RSpec.configure do |config|\n      #     config.expose_dsl_globally = false\n      #\n      #     config.mock_with :rspec do |mocks|\n      #       mocks.syntax = :expect\n      #       mocks.patch_marshal_to_support_partial_doubles = false\n      #     end\n      #\n      #     config.expect_with :rspec do |expectations|\n      #       expectations.syntax = :expect\n      #     end\n      #   end\n      def disable_monkey_patching!\n        self.expose_dsl_globally = false\n        self.disable_monkey_patching = true\n        conditionally_disable_mocks_monkey_patching\n        conditionally_disable_expectations_monkey_patching\n      end\n\n      # @private\n      attr_accessor :disable_monkey_patching\n\n      # Defines a callback that can assign derived metadata values.\n      #\n      # @param filters [Array<Symbol>, Hash] metadata filters that determine\n      #   which example or group metadata hashes the callback will be triggered\n      #   for. If none are given, the callback will be run against the metadata\n      #   hashes of all groups and examples.\n      # @yieldparam metadata [Hash] original metadata hash from an example or\n      #   group. Mutate this in your block as needed.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     # Tag all groups and examples in the spec/unit directory with\n      #     # :type => :unit\n      #     config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|\n      #       metadata[:type] = :unit\n      #     end\n      #   end\n      def define_derived_metadata(*filters, &block)\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        @derived_metadata_blocks.append(block, meta)\n      end\n\n      # Defines a callback that runs after the first example with matching\n      # metadata is defined. If no examples are defined with matching metadata,\n      # it will not get called at all.\n      #\n      # This can be used to ensure some setup is performed (such as bootstrapping\n      # a DB or loading a specific file that adds significantly to the boot time)\n      # if needed (as indicated by the presence of an example with matching metadata)\n      # but avoided otherwise.\n      #\n      # @example\n      #   RSpec.configure do |config|\n      #     config.when_first_matching_example_defined(:db) do\n      #       # Load a support file that does some heavyweight setup,\n      #       # including bootstrapping the DB, but only if we have loaded\n      #       # any examples tagged with `:db`.\n      #       require 'support/db'\n      #     end\n      #   end\n      def when_first_matching_example_defined(*filters)\n        specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n\n        callback = lambda do |example_or_group_meta|\n          # Example groups do not have `:example_group` metadata\n          # (instead they have `:parent_example_group` metadata).\n          return unless example_or_group_meta.key?(:example_group)\n\n          # Ensure the callback only fires once.\n          @derived_metadata_blocks.delete(callback, specified_meta)\n\n          yield\n        end\n\n        @derived_metadata_blocks.append(callback, specified_meta)\n      end\n\n      # @private\n      def apply_derived_metadata_to(metadata)\n        already_run_blocks = Set.new\n\n        # We loop and attempt to re-apply metadata blocks to support cascades\n        # (e.g. where a derived bit of metadata triggers the application of\n        # another piece of derived metadata, etc)\n        #\n        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.\n        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.\n        200.times do\n          return if @derived_metadata_blocks.items_for(metadata).all? do |block|\n            already_run_blocks.include?(block).tap do |skip_block|\n              block.call(metadata) unless skip_block\n              already_run_blocks << block\n            end\n          end\n        end\n\n        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned\n        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail\n        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit\n        # the looping above.\n        raise SystemStackError, \"Attempted to recursively derive metadata indefinitely.\"\n      end\n\n      # Defines a `before` hook. See {Hooks#before} for full docs.\n      #\n      # This method differs from {Hooks#before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #prepend_before\n      # @see #after\n      # @see #append_after\n      def before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks << Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :append_before, :before\n\n      # Adds `block` to the start of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#before},\n      # which adds the hook to the end of the list.\n      #\n      # See {Hooks#before} for full `before` hook docs.\n      #\n      # This method differs from {Hooks#prepend_before} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once before\n      # the first example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #before\n      # @see #after\n      # @see #append_after\n      def prepend_before(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Defines a `after` hook. See {Hooks#after} for full docs.\n      #\n      # This method differs from {Hooks#after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the end of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`), in contrast to {#after},\n      # which adds the hook to the start of the list.\n      #\n      # See {Hooks#after} for full `after` hook docs.\n      #\n      # This method differs from {Hooks#append_after} in only one way: it supports\n      # the `:suite` scope. Hooks with the `:suite` scope will be run once after\n      # the last example of the entire suite is executed. Conditions passed along\n      # with `:suite` are effectively ignored.\n      #\n      # @see #append_after\n      # @see #before\n      # @see #prepend_before\n      def append_after(scope=nil, *meta, &block)\n        handle_suite_hook(scope, meta) do\n          @after_suite_hooks << Hooks::AfterHook.new(block, {})\n        end || begin\n          # defeat Ruby 2.5 lazy proc allocation to ensure\n          # the methods below are passed the same proc instances\n          # so `Hook` equality is preserved. For more info, see:\n          # https://bugs.ruby-lang.org/issues/14045#note-5\n          block.__id__\n\n          add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }\n          super(scope, *meta, &block)\n        end\n      end\n\n      # Registers `block` as an `around` hook.\n      #\n      # See {Hooks#around} for full `around` hook docs.\n      def around(scope=nil, *meta, &block)\n        # defeat Ruby 2.5 lazy proc allocation to ensure\n        # the methods below are passed the same proc instances\n        # so `Hook` equality is preserved. For more info, see:\n        # https://bugs.ruby-lang.org/issues/14045#note-5\n        block.__id__\n\n        add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }\n        super(scope, *meta, &block)\n      end\n\n      # @private\n      def with_suite_hooks\n        return yield if dry_run?\n\n        begin\n          RSpec.current_scope = :before_suite_hook\n          run_suite_hooks(\"a `before(:suite)` hook\", @before_suite_hooks)\n          yield\n        ensure\n          RSpec.current_scope = :after_suite_hook\n          run_suite_hooks(\"an `after(:suite)` hook\", @after_suite_hooks)\n          RSpec.current_scope = :suite\n        end\n      end\n\n      # @private\n      # Holds the various registered hooks. Here we use a FilterableItemRepository\n      # implementation that is specifically optimized for the read/write patterns\n      # of the config object.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)\n      end\n\n      # Invokes block before defining an example group\n      def on_example_group_definition(&block)\n        on_example_group_definition_callbacks << block\n      end\n\n      # @api private\n      # Returns an array of blocks to call before defining an example group\n      def on_example_group_definition_callbacks\n        @on_example_group_definition_callbacks ||= []\n      end\n\n      # @private\n      def bisect_runner_class\n        @bisect_runner_class ||= begin\n          case bisect_runner\n          when :fork\n            RSpec::Support.require_rspec_core 'bisect/fork_runner'\n            Bisect::ForkRunner\n          when :shell\n            RSpec::Support.require_rspec_core 'bisect/shell_runner'\n            Bisect::ShellRunner\n          else\n            raise \"Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). \" \\\n                  \"Only `:fork` and `:shell` are supported.\"\n          end\n        end\n      end\n\n    private\n\n      def load_file_handling_errors(method, file)\n        __send__(method, file)\n      rescue LoadError => ex\n        relative_file = Metadata.relative_path(file)\n        suggestions = DidYouMean.new(relative_file).call\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.#{suggestions}\")\n        RSpec.world.wants_to_quit = true\n      rescue SyntaxError => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(ex, \"An error occurred while loading #{relative_file}.\")\n        RSpec.world.wants_to_quit = true\n      rescue SystemExit => ex\n        relative_file = Metadata.relative_path(file)\n        reporter.notify_non_example_exception(\n          ex,\n          \"While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit.\"\n        )\n        RSpec.world.rspec_is_quitting = true\n        raise ex\n      end\n\n      def handle_suite_hook(scope, meta)\n        return nil unless scope == :suite\n\n        unless meta.empty?\n          # TODO: in RSpec 4, consider raising an error here.\n          # We warn only for backwards compatibility.\n          RSpec.warn_with \"WARNING: `:suite` hooks do not support metadata since \" \\\n                          \"they apply to the suite as a whole rather than \" \\\n                          \"any individual example or example group that has metadata. \" \\\n                          \"The metadata you have provided (#{meta.inspect}) will be ignored.\"\n        end\n\n        yield\n      end\n\n      def run_suite_hooks(hook_description, hooks)\n        context = SuiteHookContext.new(hook_description, reporter)\n\n        hooks.each do |hook|\n          begin\n            hook.run(context)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n            context.set_exception(ex)\n\n            # Do not run subsequent `before` hooks if one fails.\n            # But for `after` hooks, we run them all so that all\n            # cleanup bits get a chance to complete, minimizing the\n            # chance that resources get left behind.\n            break if hooks.equal?(@before_suite_hooks)\n          end\n        end\n      end\n\n      def get_files_to_run(paths)\n        files = FlatMap.flat_map(paths_to_check(paths)) do |path|\n          path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR\n          File.directory?(path) ? gather_directories(path) : extract_location(path)\n        end.uniq\n\n        return files unless only_failures?\n        relative_files = files.map { |f| Metadata.relative_path(File.expand_path f) }\n        intersection = (relative_files & spec_files_with_failures.to_a)\n        intersection.empty? ? files : intersection\n      end\n\n      def paths_to_check(paths)\n        return paths if pattern_might_load_specs_from_vendored_dirs?\n        paths + [Dir.getwd]\n      end\n\n      def pattern_might_load_specs_from_vendored_dirs?\n        pattern.split(File::SEPARATOR).first.include?('**')\n      end\n\n      def gather_directories(path)\n        include_files = get_matching_files(path, pattern)\n        exclude_files = get_matching_files(path, exclude_pattern)\n        (include_files - exclude_files).uniq\n      end\n\n      def get_matching_files(path, pattern)\n        raw_files = Dir[file_glob_from(path, pattern)]\n        raw_files.map { |file| File.expand_path(file) }.sort\n      end\n\n      def file_glob_from(path, pattern)\n        stripped = \"{#{pattern.gsub(/\\s*,\\s*/, ',')}}\"\n        return stripped if pattern =~ /^(\\.\\/)?#{Regexp.escape path}/ || absolute_pattern?(pattern)\n        File.join(path, stripped)\n      end\n\n      if RSpec::Support::OS.windows?\n        # :nocov:\n        def absolute_pattern?(pattern)\n          pattern =~ /\\A[A-Z]:\\\\/ || windows_absolute_network_path?(pattern)\n        end\n\n        def windows_absolute_network_path?(pattern)\n          return false unless ::File::ALT_SEPARATOR\n          pattern.start_with?(::File::ALT_SEPARATOR + ::File::ALT_SEPARATOR)\n        end\n        # :nocov:\n      else\n        def absolute_pattern?(pattern)\n          pattern.start_with?(File::Separator)\n        end\n      end\n\n      def extract_location(path)\n        match = /^(.*?)((?:\\:\\d+)+)$/.match(path)\n\n        if match\n          captures = match.captures\n          path = captures[0]\n          lines = captures[1][1..-1].split(\":\").map(&:to_i)\n          filter_manager.add_location path, lines\n        else\n          path, scoped_ids = Example.parse_id(path)\n          filter_manager.add_ids(path, scoped_ids.split(/\\s*,\\s*/)) if scoped_ids\n        end\n\n        return [] if path == default_path\n        File.expand_path(path)\n      end\n\n      def command\n        $0.split(File::SEPARATOR).last\n      end\n\n      def value_for(key)\n        @preferred_options.fetch(key) { yield }\n      end\n\n      def define_built_in_hooks\n        around(:example, :aggregate_failures => true) do |procsy|\n          begin\n            aggregate_failures(nil, :hide_backtrace => true, &procsy)\n          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception\n            procsy.example.set_aggregate_failures_exception(exception)\n          end\n        end\n      end\n\n      def assert_no_example_groups_defined(config_option)\n        return unless world.example_groups.any?\n\n        raise MustBeConfiguredBeforeExampleGroupsError.new(\n          \"RSpec's #{config_option} configuration option must be configured before \" \\\n          \"any example groups are defined, but you have already defined a group.\"\n        )\n      end\n\n      def output_wrapper\n        @output_wrapper ||= OutputWrapper.new(output_stream)\n      end\n\n      def output_to_tty?(output=output_stream)\n        output.respond_to?(:tty?) && output.tty?\n      end\n\n      def conditionally_disable_mocks_monkey_patching\n        return unless disable_monkey_patching && rspec_mocks_loaded?\n\n        RSpec::Mocks.configuration.tap do |config|\n          config.syntax = :expect\n          config.patch_marshal_to_support_partial_doubles = false\n        end\n      end\n\n      def conditionally_disable_expectations_monkey_patching\n        return unless disable_monkey_patching && rspec_expectations_loaded?\n\n        RSpec::Expectations.configuration.syntax = :expect\n      end\n\n      def rspec_mocks_loaded?\n        defined?(RSpec::Mocks.configuration)\n      end\n\n      def rspec_expectations_loaded?\n        defined?(RSpec::Expectations.configuration)\n      end\n\n      def update_pattern_attr(name, value)\n        if @spec_files_loaded\n          RSpec.warning \"Configuring `#{name}` to #{value} has no effect since \" \\\n                        \"RSpec has already loaded the spec files.\"\n        end\n\n        instance_variable_set(:\"@#{name}\", value)\n        @files_to_run = nil\n      end\n\n      def clear_values_derived_from_example_status_persistence_file_path\n        @last_run_statuses = nil\n        @spec_files_with_failures = nil\n      end\n\n      def configure_group_with(group, module_list, application_method)\n        module_list.items_for(group.metadata).each do |mod|\n          __send__(application_method, mod, group)\n        end\n      end\n\n      def add_hook_to_existing_matching_groups(meta, scope, &block)\n        # For example hooks, we have to apply it to each of the top level\n        # groups, even if the groups do not match. When we apply it, we\n        # apply it with the metadata, so it will only apply to examples\n        # in the group that match the metadata.\n        # #2280 for background and discussion.\n        if scope == :example || scope == :each || scope.nil?\n          world.example_groups.each(&block)\n        else\n          meta = Metadata.build_hash_from(meta.dup)\n          on_existing_matching_groups(meta, &block)\n        end\n      end\n\n      def on_existing_matching_groups(meta)\n        world.traverse_example_group_trees_until do |group|\n          metadata_applies_to_group?(meta, group).tap do |applies|\n            yield group if applies\n          end\n        end\n      end\n\n      def metadata_applies_to_group?(meta, group)\n        meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)\n      end\n\n      if RSpec::Support::RubyFeatures.module_prepends_supported?\n        def safe_prepend(mod, host)\n          host.__send__(:prepend, mod) unless host < mod\n        end\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host < mod\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless host.singleton_class < mod\n        end\n      else # for 1.8.7\n        # :nocov:\n        def safe_include(mod, host)\n          host.__send__(:include, mod) unless host.included_modules.include?(mod)\n        end\n\n        def safe_extend(mod, host)\n          host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)\n        end\n        # :nocov:\n      end\n\n      def define_mixed_in_module(mod, filters, mod_list, config_method, &block)\n        unless Module === mod\n          raise TypeError, \"`RSpec.configuration.#{config_method}` expects a module but got: #{mod.inspect}\"\n        end\n\n        meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)\n        mod_list.append(mod, meta)\n        on_existing_matching_groups(meta, &block)\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "Ruby", "function_component": {"name": "extract_location", "signature": "def extract_location(path)", "start_line": 2266, "end_line": 2281}, "metadata": {"module": "RSpec", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 248}
{"function_name": "organize_options", "file_path": "rspec-core/lib/rspec/core/configuration_options.rb", "focal_code": "def organize_options\n        @filter_manager_options = []\n\n        @options = (file_options << command_line_options << env_options).each do |opts|\n          @filter_manager_options << [:include, opts.delete(:inclusion_filter)] if opts.key?(:inclusion_filter)\n          @filter_manager_options << [:exclude, opts.delete(:exclusion_filter)] if opts.key?(:exclusion_filter)\n        end\n\n        @options = @options.inject(:libs => [], :requires => []) do |hash, opts|\n          hash.merge(opts) do |key, oldval, newval|\n            [:libs, :requires].include?(key) ? oldval + newval : newval\n          end\n        end\n      end", "file_content": "require 'erb'\nrequire 'shellwords'\n\nmodule RSpec\n  module Core\n    # Responsible for utilizing externally provided configuration options,\n    # whether via the command line, `.rspec`, `~/.rspec`,\n    # `$XDG_CONFIG_HOME/rspec/options`, `.rspec-local` or a custom options\n    # file.\n    class ConfigurationOptions\n      # @param args [Array<String>] command line arguments\n      def initialize(args)\n        @args = args.dup\n        organize_options\n      end\n\n      # Updates the provided {Configuration} instance based on the provided\n      # external configuration options.\n      #\n      # @param config [Configuration] the configuration instance to update\n      def configure(config)\n        process_options_into config\n        configure_filter_manager config.filter_manager\n        load_formatters_into config\n      end\n\n      # @api private\n      # Updates the provided {FilterManager} based on the filter options.\n      # @param filter_manager [FilterManager] instance to update\n      def configure_filter_manager(filter_manager)\n        @filter_manager_options.each do |command, value|\n          filter_manager.__send__ command, value\n        end\n      end\n\n      # @return [Hash] the final merged options, drawn from all external sources\n      attr_reader :options\n\n      # @return [Array<String>] the original command-line arguments\n      attr_reader :args\n\n    private\n\n      def organize_options\n        @filter_manager_options = []\n\n        @options = (file_options << command_line_options << env_options).each do |opts|\n          @filter_manager_options << [:include, opts.delete(:inclusion_filter)] if opts.key?(:inclusion_filter)\n          @filter_manager_options << [:exclude, opts.delete(:exclusion_filter)] if opts.key?(:exclusion_filter)\n        end\n\n        @options = @options.inject(:libs => [], :requires => []) do |hash, opts|\n          hash.merge(opts) do |key, oldval, newval|\n            [:libs, :requires].include?(key) ? oldval + newval : newval\n          end\n        end\n      end\n\n      UNFORCED_OPTIONS = Set.new([\n        :requires, :profile, :drb, :libs, :files_or_directories_to_run,\n        :full_description, :full_backtrace, :tty\n      ])\n\n      UNPROCESSABLE_OPTIONS = Set.new([:formatters])\n\n      def force?(key)\n        !UNFORCED_OPTIONS.include?(key)\n      end\n\n      def order(keys)\n        OPTIONS_ORDER.reverse_each do |key|\n          keys.unshift(key) if keys.delete(key)\n        end\n        keys\n      end\n\n      OPTIONS_ORDER = [\n        # It's important to set this before anything that might issue a\n        # deprecation (or otherwise access the reporter).\n        :deprecation_stream,\n\n        # In order for `RSpec.configuration.dry_run?` to return `true` during\n        # processing the `requires` option, it must be parsed before it.\n        :dry_run,\n\n        # load paths depend on nothing, but must be set before `requires`\n        # to support load-path-relative requires.\n        :libs,\n\n        # `files_or_directories_to_run` uses `default_path` so it must be\n        # set before it.\n        :default_path, :only_failures,\n\n        # These must be set before `requires` to support checking\n        # `config.files_to_run` from within `spec_helper.rb` when a\n        # `-rspec_helper` option is used.\n        :files_or_directories_to_run, :pattern, :exclude_pattern,\n\n        # Necessary so that the `--seed` option is applied before requires,\n        # in case required files do something with the provided seed.\n        # (such as seed global randomization with it).\n        :order,\n\n        # In general, we want to require the specified files as early as\n        # possible. The `--require` option is specifically intended to allow\n        # early requires. For later requires, they can just put the require in\n        # their spec files, but `--require` provides a unique opportunity for\n        # users to instruct RSpec to load an extension file early for maximum\n        # flexibility.\n        :requires\n      ]\n\n      def process_options_into(config)\n        opts = options.reject { |k, _| UNPROCESSABLE_OPTIONS.include? k }\n\n        order(opts.keys).each do |key|\n          force?(key) ? config.force(key => opts[key]) : config.__send__(\"#{key}=\", opts[key])\n        end\n      end\n\n      def load_formatters_into(config)\n        options[:formatters].each { |pair| config.add_formatter(*pair) } if options[:formatters]\n      end\n\n      def file_options\n        if custom_options_file\n          [custom_options]\n        else\n          [global_options, project_options, local_options]\n        end\n      end\n\n      def env_options\n        return {} unless ENV['SPEC_OPTS']\n\n        parse_args_ignoring_files_or_dirs_to_run(\n          Shellwords.split(ENV[\"SPEC_OPTS\"]),\n          \"ENV['SPEC_OPTS']\"\n        )\n      end\n\n      def command_line_options\n        @command_line_options ||= Parser.parse(@args)\n      end\n\n      def custom_options\n        options_from(custom_options_file)\n      end\n\n      def local_options\n        @local_options ||= options_from(local_options_file)\n      end\n\n      def project_options\n        @project_options ||= options_from(project_options_file)\n      end\n\n      def global_options\n        @global_options ||= options_from(global_options_file)\n      end\n\n      def options_from(path)\n        args = args_from_options_file(path)\n        parse_args_ignoring_files_or_dirs_to_run(args, path)\n      end\n\n      def parse_args_ignoring_files_or_dirs_to_run(args, source)\n        options = Parser.parse(args, source)\n        options.delete(:files_or_directories_to_run)\n        options\n      end\n\n      def args_from_options_file(path)\n        return [] unless path && File.exist?(path)\n        config_string = options_file_as_erb_string(path)\n        config_lines = config_string.split(/\\n+/).reject { |s| s =~ /\\A\\s*#/ }\n        FlatMap.flat_map(config_lines, &:shellsplit)\n      end\n\n      # :nocov:\n      def options_file_as_erb_string(path)\n        if RUBY_VERSION >= '2.6'\n          ERB.new(File.read(path), :trim_mode => '-').result(binding)\n        else\n          ERB.new(File.read(path), nil, '-').result(binding)\n        end\n      end\n      # :nocov:\n\n      def custom_options_file\n        command_line_options[:custom_options_file]\n      end\n\n      def project_options_file\n        \"./.rspec\"\n      end\n\n      def local_options_file\n        \"./.rspec-local\"\n      end\n\n      def global_options_file\n        xdg_options_file_if_exists || home_options_file_path\n      end\n\n      def xdg_options_file_if_exists\n        path = xdg_options_file_path\n        if path && File.exist?(path)\n          path\n        end\n      end\n\n      def home_options_file_path\n        File.join(File.expand_path(\"~\"), \".rspec\")\n      rescue ArgumentError\n        # :nocov:\n        RSpec.warning \"Unable to find ~/.rspec because the HOME environment variable is not set\"\n        nil\n        # :nocov:\n      end\n\n      def xdg_options_file_path\n        xdg_config_home = resolve_xdg_config_home\n        if xdg_config_home\n          File.join(xdg_config_home, \"rspec\", \"options\")\n        end\n      end\n\n      def resolve_xdg_config_home\n        File.expand_path(ENV.fetch(\"XDG_CONFIG_HOME\", \"~/.config\"))\n      rescue ArgumentError\n        # :nocov:\n        # On Ruby 2.4, `File.expand(\"~\")` works even if `ENV['HOME']` is not set.\n        # But on earlier versions, it fails.\n        nil\n        # :nocov:\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "organize_options", "signature": "def organize_options @filter_manager_options = []", "start_line": 44, "end_line": 57}, "metadata": {"module": "RSpec", "class_name": "ConfigurationOptions", "class_signature": "class ConfigurationOptions"}, "task_id": 249}
{"function_name": "options", "file_path": "rspec-core/lib/rspec/core/drb.rb", "focal_code": "def options\n        argv = []\n        argv << \"--color\"        if @submitted_options[:color]\n        argv << \"--force-color\"  if @submitted_options[:color_mode] == :on\n        argv << \"--no-color\"     if @submitted_options[:color_mode] == :off\n        argv << \"--profile\"      if @submitted_options[:profile_examples]\n        argv << \"--backtrace\"    if @submitted_options[:full_backtrace]\n        argv << \"--tty\"          if @submitted_options[:tty]\n        argv << \"--fail-fast\"    if @submitted_options[:fail_fast]\n        argv << \"--options\"      << @submitted_options[:custom_options_file] if @submitted_options[:custom_options_file]\n        argv << \"--order\"        << @submitted_options[:order]               if @submitted_options[:order]\n\n        add_failure_exit_code(argv)\n        add_error_exit_code(argv)\n        add_full_description(argv)\n        add_filter(argv, :inclusion, @filter_manager.inclusions)\n        add_filter(argv, :exclusion, @filter_manager.exclusions)\n        add_formatters(argv)\n        add_libs(argv)\n        add_requires(argv)\n\n        argv + @submitted_options[:files_or_directories_to_run]\n      end", "file_content": "require 'drb/drb'\n\nmodule RSpec\n  module Core\n    # @private\n    class DRbRunner\n      def initialize(options, configuration=RSpec.configuration)\n        @options       = options\n        @configuration = configuration\n      end\n\n      def drb_port\n        @options.options[:drb_port] || ENV['RSPEC_DRB'] || 8989\n      end\n\n      def run(err, out)\n        begin\n          DRb.start_service(\"druby://localhost:0\")\n        rescue SocketError, Errno::EADDRNOTAVAIL\n          DRb.start_service(\"druby://:0\")\n        end\n        spec_server = DRbObject.new_with_uri(\"druby://127.0.0.1:#{drb_port}\")\n        spec_server.run(drb_argv, err, out)\n      end\n\n      def drb_argv\n        @drb_argv ||= begin\n          @options.configure_filter_manager(@configuration.filter_manager)\n          DRbOptions.new(@options.options, @configuration.filter_manager).options\n        end\n      end\n    end\n\n    # @private\n    class DRbOptions\n      def initialize(submitted_options, filter_manager)\n        @submitted_options = submitted_options\n        @filter_manager = filter_manager\n      end\n\n      def options\n        argv = []\n        argv << \"--color\"        if @submitted_options[:color]\n        argv << \"--force-color\"  if @submitted_options[:color_mode] == :on\n        argv << \"--no-color\"     if @submitted_options[:color_mode] == :off\n        argv << \"--profile\"      if @submitted_options[:profile_examples]\n        argv << \"--backtrace\"    if @submitted_options[:full_backtrace]\n        argv << \"--tty\"          if @submitted_options[:tty]\n        argv << \"--fail-fast\"    if @submitted_options[:fail_fast]\n        argv << \"--options\"      << @submitted_options[:custom_options_file] if @submitted_options[:custom_options_file]\n        argv << \"--order\"        << @submitted_options[:order]               if @submitted_options[:order]\n\n        add_failure_exit_code(argv)\n        add_error_exit_code(argv)\n        add_full_description(argv)\n        add_filter(argv, :inclusion, @filter_manager.inclusions)\n        add_filter(argv, :exclusion, @filter_manager.exclusions)\n        add_formatters(argv)\n        add_libs(argv)\n        add_requires(argv)\n\n        argv + @submitted_options[:files_or_directories_to_run]\n      end\n\n      def add_failure_exit_code(argv)\n        return unless @submitted_options[:failure_exit_code]\n\n        argv << \"--failure-exit-code\" << @submitted_options[:failure_exit_code].to_s\n      end\n\n      def add_error_exit_code(argv)\n        return unless @submitted_options[:error_exit_code]\n\n        argv << \"--error-exit-code\" << @submitted_options[:error_exit_code].to_s\n      end\n\n      def add_full_description(argv)\n        return unless @submitted_options[:full_description]\n\n        # The argument to --example is regexp-escaped before being stuffed\n        # into a regexp when received for the first time (see OptionParser).\n        # Hence, merely grabbing the source of this regexp will retain the\n        # backslashes, so we must remove them.\n        @submitted_options[:full_description].each do |description|\n          argv << \"--example\" << description.source.delete('\\\\')\n        end\n      end\n\n      CONDITIONAL_FILTERS = [:if, :unless]\n\n      def add_filter(argv, name, hash)\n        hash.each_pair do |k, v|\n          next if CONDITIONAL_FILTERS.include?(k)\n          tag = name == :inclusion ? k.to_s.dup : \"~#{k}\".dup\n          tag << \":#{v}\" if v.is_a?(String)\n          argv << \"--tag\" << tag\n        end unless hash.empty?\n      end\n\n      def add_formatters(argv)\n        @submitted_options[:formatters].each do |pair|\n          argv << \"--format\" << pair[0]\n          argv << \"--out\" << pair[1] if pair[1]\n        end if @submitted_options[:formatters]\n      end\n\n      def add_libs(argv)\n        @submitted_options[:libs].each do |path|\n          argv << \"-I\" << path\n        end if @submitted_options[:libs]\n      end\n\n      def add_requires(argv)\n        @submitted_options[:requires].each do |path|\n          argv << \"--require\" << path\n        end if @submitted_options[:requires]\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "options", "signature": "def options argv = []", "start_line": 41, "end_line": 63}, "metadata": {"module": "RSpec", "class_name": "DRbOptions", "class_signature": "class DRbOptions"}, "task_id": 250}
{"function_name": "find_and_eval_shared", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_and_eval_shared", "signature": "def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)", "start_line": 379, "end_line": 390}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 251}
{"function_name": "set_it_up", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "set_it_up", "signature": "def self.set_it_up(description, args, registration_collection, &example_group_block)", "start_line": 410, "end_line": 447}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 252}
{"function_name": "run_before_context_hooks", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "run_before_context_hooks", "signature": "def self.run_before_context_hooks(example_group_instance)", "start_line": 547, "end_line": 558}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 253}
{"function_name": "run_after_context_hooks", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "run_after_context_hooks", "signature": "def self.run_after_context_hooks(example_group_instance)", "start_line": 585, "end_line": 596}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 254}
{"function_name": "ordering_strategy", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "ordering_strategy", "signature": "def self.ordering_strategy order = metadata.fetch(:order, :global)", "start_line": 625, "end_line": 638}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 255}
{"function_name": "method_missing", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def self.method_missing(name, *args)", "start_line": 742, "end_line": 753}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 256}
{"function_name": "method_missing", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, *args)", "start_line": 758, "end_line": 768}, "metadata": {"module": "RSpec", "class_name": "ExampleGroup", "class_signature": "class ExampleGroup"}, "task_id": 257}
{"function_name": "with_frame", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "with_frame", "signature": "def self.with_frame(name, location)", "start_line": 816, "end_line": 826}, "metadata": {"module": "RSpec", "class_name": "SharedExampleGroupInclusionStackFrame", "class_signature": "class SharedExampleGroupInclusionStackFrame"}, "task_id": 258}
{"function_name": "base_name_for", "file_path": "rspec-core/lib/rspec/core/example_group.rb", "focal_code": "def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end", "file_content": "RSpec::Support.require_rspec_support 'recursive_const_methods'\n\nmodule RSpec\n  module Core\n    # rubocop:disable Metrics/ClassLength\n\n    # ExampleGroup and {Example} are the main structural elements of\n    # rspec-core. Consider this example:\n    #\n    #     RSpec.describe Thing do\n    #       it \"does something\" do\n    #       end\n    #     end\n    #\n    # The object returned by `describe Thing` is a subclass of ExampleGroup.\n    # The object returned by `it \"does something\"` is an instance of Example,\n    # which serves as a wrapper for an instance of the ExampleGroup in which it\n    # is declared.\n    #\n    # Example group bodies (e.g. `describe` or `context` blocks) are evaluated\n    # in the context of a new subclass of ExampleGroup. Individual examples are\n    # evaluated in the context of an instance of the specific ExampleGroup\n    # subclass to which they belong.\n    #\n    # Besides the class methods defined here, there are other interesting macros\n    # defined in {Hooks}, {MemoizedHelpers::ClassMethods} and\n    # {SharedExampleGroup}. There are additional instance methods available to\n    # your examples defined in {MemoizedHelpers} and {Pending}.\n    class ExampleGroup\n      extend Hooks\n\n      include MemoizedHelpers\n      extend MemoizedHelpers::ClassMethods\n      include Pending\n      extend SharedExampleGroup\n\n      # Define a singleton method for the singleton class (remove the method if\n      # it's already been defined).\n      # @private\n      def self.idempotently_define_singleton_method(name, &definition)\n        (class << self; self; end).module_exec do\n          remove_method(name) if method_defined?(name) && instance_method(name).owner == self\n          define_method(name, &definition)\n        end\n      end\n\n      # @!group Metadata\n\n      # The [Metadata](Metadata) object associated with this group.\n      # @see Metadata\n      def self.metadata\n        @metadata ||= nil\n      end\n\n      # Temporarily replace the provided metadata.\n      # Intended primarily to allow an example group's singleton class\n      # to return the metadata of the example that it exists for. This\n      # is necessary for shared example group inclusion to work properly\n      # with singleton example groups.\n      # @private\n      def self.with_replaced_metadata(meta)\n        orig_metadata = metadata\n        @metadata = meta\n        yield\n      ensure\n        @metadata = orig_metadata\n      end\n\n      # @private\n      # @return [Metadata] belonging to the parent of a nested {ExampleGroup}\n      def self.superclass_metadata\n        @superclass_metadata ||= superclass.respond_to?(:metadata) ? superclass.metadata : nil\n      end\n\n      # @private\n      def self.delegate_to_metadata(*names)\n        names.each do |name|\n          idempotently_define_singleton_method(name) { metadata.fetch(name) }\n        end\n      end\n\n      delegate_to_metadata :described_class, :file_path, :location\n\n      # @return [String] the current example group description\n      def self.description\n        description = metadata[:description]\n        RSpec.configuration.format_docstrings_block.call(description)\n      end\n\n      # Returns the class or module passed to the `describe` method (or alias).\n      # Returns nil if the subject is not a class or module.\n      # @example\n      #     RSpec.describe Thing do\n      #       it \"does something\" do\n      #         described_class == Thing\n      #       end\n      #     end\n      #\n      def described_class\n        self.class.described_class\n      end\n\n      # @!endgroup\n\n      # @!group Defining Examples\n\n      # @private\n      # @macro [attach] define_example_method\n      #   @!scope class\n      #   @method $1\n      #   @overload $1\n      #   @overload $1(&example_implementation)\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @overload $1(doc_string, *metadata)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The example's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_implementation [Block] The implementation of the example.\n      #   @yield [Example] the example object\n      #   @example\n      #     $1 do\n      #     end\n      #\n      #     $1 \"does something\" do\n      #     end\n      #\n      #     $1 \"does something\", :slow, :uses_js do\n      #     end\n      #\n      #     $1 \"does something\", :with => 'additional metadata' do\n      #     end\n      #\n      #     $1 \"does something\" do |ex|\n      #       # ex is the Example object that contains metadata about the example\n      #     end\n      #\n      #  @example\n      #     $1 \"does something\", :slow, :load_factor => 100 do\n      #     end\n      #\n      def self.define_example_method(name, extra_options={})\n        idempotently_define_singleton_method(name) do |*all_args, &block|\n          desc, *args = *all_args\n\n          options = Metadata.build_hash_from(args)\n          options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block\n          options.update(extra_options)\n\n          RSpec::Core::Example.new(self, desc, options, block)\n        end\n      end\n\n      # Defines an example within a group.\n      define_example_method :example\n      # Defines an example within a group.\n      # This is the primary API to define a code example.\n      define_example_method :it\n      # Defines an example within a group.\n      # Useful for when your docstring does not read well off of `it`.\n      # @example\n      #  RSpec.describe MyClass do\n      #    specify \"#do_something is deprecated\" do\n      #      # ...\n      #    end\n      #  end\n      define_example_method :specify\n\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :focus,    :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fexample, :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fit,      :focus => true\n      # Shortcut to define an example with `:focus => true`.\n      # @see example\n      define_example_method :fspecify, :focus => true\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xexample'`.\n      # @see example\n      define_example_method :xexample, :skip => 'Temporarily skipped with xexample'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xit'`.\n      # @see example\n      define_example_method :xit,      :skip => 'Temporarily skipped with xit'\n      # Shortcut to define an example with `:skip => 'Temporarily skipped with xspecify'`.\n      # @see example\n      define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'\n      # Shortcut to define an example with `:skip => true`\n      # @see example\n      define_example_method :skip,     :skip => true\n      # Shortcut to define an example with `:pending => true`\n      # @see example\n      define_example_method :pending,  :pending => true\n\n      # @!endgroup\n\n      # @!group Defining Example Groups\n\n      # @private\n      # @macro [attach] define_example_group_method\n      #   @!scope class\n      #   @overload $1\n      #   @overload $1(&example_group_definition)\n      #     @param example_group_definition [Block] The definition of the example group.\n      #   @overload $1(doc_string, *metadata, &example_implementation)\n      #     @param doc_string [String] The group's doc string.\n      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.\n      #       Symbols will be transformed into hash entries with `true` values.\n      #     @param example_group_definition [Block] The definition of the example group.\n      #\n      #   Generates a subclass of this example group which inherits\n      #   everything except the examples themselves.\n      #\n      #   @example\n      #\n      #     RSpec.describe \"something\" do # << This describe method is defined in\n      #                                   # << RSpec::Core::DSL, included in the\n      #                                   # << global namespace (optional)\n      #       before do\n      #         do_something_before\n      #       end\n      #\n      #       before(:example, :clean_env) do\n      #         env.clear!\n      #       end\n      #\n      #       let(:thing) { Thing.new }\n      #\n      #       $1 \"attribute (of something)\" do\n      #         # examples in the group get the before hook\n      #         # declared above, and can access `thing`\n      #       end\n      #\n      #       $1 \"needs additional setup\", :clean_env, :implementation => JSON do\n      #         # specifies that hooks with matching metadata\n      #         # should be be run additionally\n      #       end\n      #     end\n      #\n      # @see DSL#describe\n      def self.define_example_group_method(name, metadata={})\n        idempotently_define_singleton_method(name) do |*args, &example_group_block|\n          thread_data = RSpec::Support.thread_local_data\n          top_level   = self == ExampleGroup\n\n          registration_collection =\n            if top_level\n              if thread_data[:in_example_group]\n                raise \"Creating an isolated context from within a context is \" \\\n                      \"not allowed. Change `RSpec.#{name}` to `#{name}` or \" \\\n                      \"move this to a top-level scope.\"\n              end\n\n              thread_data[:in_example_group] = true\n              RSpec.world.example_groups\n            else\n              children\n            end\n\n          begin\n            description = args.shift\n            combined_metadata = metadata.dup\n            combined_metadata.merge!(args.pop) if args.last.is_a? Hash\n            args << combined_metadata\n\n            subclass(self, description, args, registration_collection, &example_group_block)\n          ensure\n            thread_data.delete(:in_example_group) if top_level\n          end\n        end\n\n        RSpec::Core::DSL.expose_example_group_alias(name)\n      end\n\n      define_example_group_method :example_group\n\n      # An alias of `example_group`. Generally used when grouping examples by a\n      # thing you are describing (e.g. an object, class or method).\n      # @see example_group\n      define_example_group_method :describe\n\n      # An alias of `example_group`. Generally used when grouping examples\n      # contextually (e.g. \"with xyz\", \"when xyz\" or \"if xyz\").\n      # @see example_group\n      define_example_group_method :context\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xdescribe, :skip => \"Temporarily skipped with xdescribe\"\n\n      # Shortcut to temporarily make an example group skipped.\n      # @see example_group\n      define_example_group_method :xcontext,  :skip => \"Temporarily skipped with xcontext\"\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fdescribe, :focus => true\n\n      # Shortcut to define an example group with `:focus => true`.\n      # @see example_group\n      define_example_group_method :fcontext,  :focus => true\n\n      # @!endgroup\n\n      # @!group Including Shared Example Groups\n\n      # @private\n      # @macro [attach] define_nested_shared_group_method\n      #   @!scope class\n      #\n      #   @see SharedExampleGroup\n      def self.define_nested_shared_group_method(new_name, report_label=\"it should behave like\")\n        idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|\n          # Pass :caller so the :location metadata is set properly.\n          # Otherwise, it'll be set to the next line because that's\n          # the block's source_location.\n          group = example_group(\"#{report_label} #{name}\", :caller => (the_caller = caller)) do\n            find_and_eval_shared(\"examples\", name, the_caller.first, *args, &customization_block)\n          end\n          group.metadata[:shared_group_name] = name\n          group\n        end\n      end\n\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_behaves_like, \"behaves like\"\n      # Generates a nested example group and includes the shared content\n      # mapped to `name` in the nested group.\n      define_nested_shared_group_method :it_should_behave_like\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_context(name, *args, &block)\n        find_and_eval_shared(\"context\", name, caller.first, *args, &block)\n      end\n\n      # Includes shared content mapped to `name` directly in the group in which\n      # it is declared, as opposed to `it_behaves_like`, which creates a nested\n      # group. If given a block, that block is also eval'd in the current\n      # context.\n      #\n      # @see SharedExampleGroup\n      def self.include_examples(name, *args, &block)\n        find_and_eval_shared(\"examples\", name, caller.first, *args, &block)\n      end\n\n      # Clear memoized values when adding/removing examples\n      # @private\n      def self.reset_memoized\n        @descendant_filtered_examples = nil\n        @_descendants = nil\n        @parent_groups = nil\n        @declaration_locations = nil\n      end\n\n      # Adds an example to the example group\n      def self.add_example(example)\n        reset_memoized\n        examples << example\n      end\n\n      # Removes an example from the example group\n      def self.remove_example(example)\n        reset_memoized\n        examples.delete example\n      end\n\n      # @private\n      def self.find_and_eval_shared(label, name, inclusion_location, *args, &customization_block)\n        shared_module = RSpec.world.shared_example_group_registry.find(parent_groups, name)\n\n        unless shared_module\n          raise ArgumentError, \"Could not find shared #{label} #{name.inspect}\"\n        end\n\n        shared_module.include_in(\n          self, Metadata.relative_path(inclusion_location),\n          args, customization_block\n        )\n      end\n\n      # @!endgroup\n\n      # @private\n      def self.subclass(parent, description, args, registration_collection, &example_group_block)\n        subclass = Class.new(parent)\n        subclass.set_it_up(description, args, registration_collection, &example_group_block)\n        subclass.module_exec(&example_group_block) if example_group_block\n\n        # The LetDefinitions module must be included _after_ other modules\n        # to ensure that it takes precedence when there are name collisions.\n        # Thus, we delay including it until after the example group block\n        # has been eval'd.\n        MemoizedHelpers.define_helpers_on(subclass)\n\n        subclass\n      end\n\n      # @private\n      def self.set_it_up(description, args, registration_collection, &example_group_block)\n        # Ruby 1.9 has a bug that can lead to infinite recursion and a\n        # SystemStackError if you include a module in a superclass after\n        # including it in a subclass: https://gist.github.com/845896\n        # To prevent this, we must include any modules in\n        # RSpec::Core::ExampleGroup before users create example groups and have\n        # a chance to include the same module in a subclass of\n        # RSpec::Core::ExampleGroup. So we need to configure example groups\n        # here.\n        ensure_example_groups_are_configured\n\n        # Register the example with the group before creating the metadata hash.\n        # This is necessary since creating the metadata hash triggers\n        # `when_first_matching_example_defined` callbacks, in which users can\n        # load RSpec support code which defines hooks. For that to work, the\n        # examples and example groups must be registered at the time the\n        # support code is called or be defined afterwards.\n        # Begin defined beforehand but registered afterwards causes hooks to\n        # not be applied where they should.\n        registration_collection << self\n\n        @user_metadata = Metadata.build_hash_from(args)\n\n        @metadata = Metadata::ExampleGroupHash.create(\n          superclass_metadata, @user_metadata,\n          superclass.method(:next_runnable_index_for),\n          description, *args, &example_group_block\n        )\n\n        config = RSpec.configuration\n        config.apply_derived_metadata_to(@metadata)\n\n        ExampleGroups.assign_const(self)\n\n        @currently_executing_a_context_hook = false\n\n        config.configure_group(self)\n      end\n\n      # @private\n      def self.examples\n        @examples ||= []\n      end\n\n      # @private\n      def self.filtered_examples\n        RSpec.world.filtered_examples[self]\n      end\n\n      # @private\n      def self.descendant_filtered_examples\n        @descendant_filtered_examples ||= filtered_examples +\n          FlatMap.flat_map(children, &:descendant_filtered_examples)\n      end\n\n      # @private\n      def self.children\n        @children ||= []\n      end\n\n      # @private\n      # Traverses the tree of groups, starting with `self`, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def self.traverse_tree_until(&block)\n        return if yield self\n\n        children.each do |child|\n          child.traverse_tree_until(&block)\n        end\n      end\n\n      # @private\n      def self.next_runnable_index_for(file)\n        if self == ExampleGroup\n          # We add 1 so the ids start at 1 instead of 0. This is\n          # necessary for this branch (but not for the other one)\n          # because we register examples and groups with the\n          # `children` and `examples` collection BEFORE this\n          # method is called as part of metadata hash creation,\n          # but the example group is recorded with\n          # `RSpec.world.example_group_counts_by_spec_file` AFTER\n          # the metadata hash is created and the group is returned\n          # to the caller.\n          RSpec.world.num_example_groups_defined_in(file) + 1\n        else\n          children.count + examples.count\n        end\n      end\n\n      # @private\n      def self.descendants\n        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)\n      end\n\n      ## @private\n      def self.parent_groups\n        @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }\n      end\n\n      # @private\n      def self.top_level?\n        superclass == ExampleGroup\n      end\n\n      # @private\n      def self.ensure_example_groups_are_configured\n        unless defined?(@@example_groups_configured)\n          RSpec.configuration.configure_mock_framework\n          RSpec.configuration.configure_expectation_framework\n          # rubocop:disable Style/ClassVars\n          @@example_groups_configured = true\n          # rubocop:enable Style/ClassVars\n        end\n      end\n\n      # @private\n      def self.before_context_ivars\n        @before_context_ivars ||= {}\n      end\n\n      # @private\n      def self.store_before_context_ivars(example_group_instance)\n        each_instance_variable_for_example(example_group_instance) do |ivar|\n          before_context_ivars[ivar] = example_group_instance.instance_variable_get(ivar)\n        end\n      end\n\n      # Returns true if a `before(:context)` or `after(:context)`\n      # hook is currently executing.\n      def self.currently_executing_a_context_hook?\n        @currently_executing_a_context_hook\n      end\n\n      # @private\n      def self.run_before_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, superclass_before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:before, :context, example_group_instance)\n        end\n      ensure\n        store_before_context_ivars(example_group_instance)\n        @currently_executing_a_context_hook = false\n      end\n\n      if RUBY_VERSION.to_f >= 1.9\n        # @private\n        def self.superclass_before_context_ivars\n          superclass.before_context_ivars\n        end\n      else # 1.8.7\n        # :nocov:\n        # @private\n        def self.superclass_before_context_ivars\n          if superclass.respond_to?(:before_context_ivars)\n            superclass.before_context_ivars\n          else\n            # `self` must be the singleton class of an ExampleGroup instance.\n            # On 1.8.7, the superclass of a singleton class of an instance of A\n            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor\n            # is A, so we can mirror 1.8.7's behavior here. Note that we have to\n            # search for the first that responds to `before_context_ivars`\n            # in case a module has been included in the singleton class.\n            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars\n          end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.run_after_context_hooks(example_group_instance)\n        set_ivars(example_group_instance, before_context_ivars)\n\n        @currently_executing_a_context_hook = true\n\n        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do\n          hooks.run(:after, :context, example_group_instance)\n        end\n      ensure\n        before_context_ivars.clear\n        @currently_executing_a_context_hook = false\n      end\n\n      # Runs all the examples in this group.\n      def self.run(reporter=RSpec::Core::NullReporter)\n        return if RSpec.world.wants_to_quit\n        reporter.example_group_started(self)\n\n        should_run_context_hooks = descendant_filtered_examples.any?\n        begin\n          RSpec.current_scope = :before_context_hook\n          run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks\n          result_for_this_group = run_examples(reporter)\n          results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?\n          result_for_this_group && results_for_descendants\n        rescue Pending::SkipDeclaredInExample => ex\n          for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }\n          true\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }\n          RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?\n          false\n        ensure\n          RSpec.current_scope = :after_context_hook\n          run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks\n          reporter.example_group_finished(self)\n        end\n      end\n\n      # @private\n      def self.ordering_strategy\n        order = metadata.fetch(:order, :global)\n        registry = RSpec.configuration.ordering_registry\n\n        registry.fetch(order) do\n          warn <<-WARNING.gsub(/^ +\\|/, '')\n            |WARNING: Ignoring unknown ordering specified using `:order => #{order.inspect}` metadata.\n            |         Falling back to configured global ordering.\n            |         Unrecognized ordering specified at: #{location}\n          WARNING\n\n          registry.fetch(:global)\n        end\n      end\n\n      # @private\n      def self.run_examples(reporter)\n        ordering_strategy.order(filtered_examples).map do |example|\n          next if RSpec.world.wants_to_quit\n          instance = new(example.inspect_output)\n          set_ivars(instance, before_context_ivars)\n          succeeded = example.run(instance, reporter)\n          if !succeeded && reporter.fail_fast_limit_met?\n            RSpec.world.wants_to_quit = true\n          end\n          succeeded\n        end.all?\n      end\n\n      # @private\n      def self.for_filtered_examples(reporter, &block)\n        filtered_examples.each(&block)\n\n        children.each do |child|\n          reporter.example_group_started(child)\n          child.for_filtered_examples(reporter, &block)\n          reporter.example_group_finished(child)\n        end\n        false\n      end\n\n      # @private\n      def self.declaration_locations\n        @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +\n          examples.map { |e| Metadata.location_tuple_from(e.metadata) } +\n          FlatMap.flat_map(children, &:declaration_locations)\n      end\n\n      # @return [String] the unique id of this example group. Pass\n      #   this at the command line to re-run this exact example group.\n      def self.id\n        Metadata.id_from(metadata)\n      end\n\n      # @private\n      def self.top_level_description\n        parent_groups.last.description\n      end\n\n      # @private\n      def self.set_ivars(instance, ivars)\n        ivars.each { |name, value| instance.instance_variable_set(name, value) }\n      end\n\n      if RUBY_VERSION.to_f < 1.9\n        # :nocov:\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze\n        # :nocov:\n      else\n        # @private\n        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output\n      end\n\n      # @private\n      def self.each_instance_variable_for_example(group)\n        group.instance_variables.each do |ivar|\n          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE\n        end\n      end\n\n      # @private\n      def initialize(inspect_output=nil)\n        @__inspect_output = inspect_output || '(no description provided)'\n        super() # no args get passed\n      end\n\n      # @private\n      def inspect\n        \"#<#{self.class} #{@__inspect_output}>\"\n      end\n\n      unless method_defined?(:singleton_class) # for 1.8.7\n        # :nocov:\n        # @private\n        def singleton_class\n          class << self; self; end\n        end\n        # :nocov:\n      end\n\n      # @private\n      def self.update_inherited_metadata(updates)\n        metadata.update(updates) do |key, existing_group_value, new_inherited_value|\n          @user_metadata.key?(key) ? existing_group_value : new_inherited_value\n        end\n\n        RSpec.configuration.configure_group(self)\n        examples.each { |ex| ex.update_inherited_metadata(updates) }\n        children.each { |group| group.update_inherited_metadata(updates) }\n      end\n\n      # Raised when an RSpec API is called in the wrong scope, such as `before`\n      # being called from within an example rather than from within an example\n      # group block.\n      WrongScopeError = Class.new(NoMethodError)\n\n      def self.method_missing(name, *args)\n        if method_defined?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available on an example group (e.g. a \" \\\n                \"`describe` or `context` block). It is only available from \" \\\n                \"within individual examples (e.g. `it` blocks) or from \" \\\n                \"constructs that run in the scope of an example (e.g. \" \\\n                \"`before`, `let`, etc).\"\n        end\n\n        super\n      end\n      private_class_method :method_missing\n\n    private\n\n      def method_missing(name, *args)\n        if self.class.respond_to?(name)\n          raise WrongScopeError,\n                \"`#{name}` is not available from within an example (e.g. an \" \\\n                \"`it` block) or from constructs that run in the scope of an \" \\\n                \"example (e.g. `before`, `let`, etc). It is only available \" \\\n                \"on an example group (e.g. a `describe` or `context` block).\"\n        end\n\n        super(name, *args)\n      end\n      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)\n    end\n    # rubocop:enable Metrics/ClassLength\n\n    # @private\n    # Unnamed example group used by `SuiteHookContext`.\n    class AnonymousExampleGroup < ExampleGroup\n      def self.metadata\n        {}\n      end\n    end\n\n    # Contains information about the inclusion site of a shared example group.\n    class SharedExampleGroupInclusionStackFrame\n      # @return [String] the name of the shared example group\n      attr_reader :shared_group_name\n      # @return [String] the location where the shared example was included\n      attr_reader :inclusion_location\n\n      # @private\n      def initialize(shared_group_name, inclusion_location)\n        @shared_group_name  = shared_group_name\n        @inclusion_location = inclusion_location\n      end\n\n      # @return [String] The {#inclusion_location}, formatted for display by a formatter.\n      def formatted_inclusion_location\n        @formatted_inclusion_location ||= begin\n          RSpec.configuration.backtrace_formatter.backtrace_line(\n            inclusion_location.sub(/(:\\d+):in .+$/, '\\1')\n          )\n        end\n      end\n\n      # @return [String] Description of this stack frame, in the form used by\n      #   RSpec's built-in formatters.\n      def description\n        @description ||= \"Shared Example Group: #{shared_group_name.inspect} \" \\\n          \"called from #{formatted_inclusion_location}\"\n      end\n\n      # @private\n      def self.current_backtrace\n        shared_example_group_inclusions.reverse\n      end\n\n      # @private\n      def self.with_frame(name, location)\n        current_stack = shared_example_group_inclusions\n        if current_stack.any? { |frame| frame.shared_group_name == name }\n          raise ArgumentError, \"can't include shared examples recursively\"\n        else\n          current_stack << new(name, location)\n          yield\n        end\n      ensure\n        current_stack.pop\n      end\n\n      # @private\n      def self.shared_example_group_inclusions\n        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []\n      end\n    end\n  end\n\n  # @private\n  #\n  # Namespace for the example group subclasses generated by top-level\n  # `describe`.\n  module ExampleGroups\n    extend Support::RecursiveConstMethods\n\n    def self.assign_const(group)\n      base_name   = base_name_for(group)\n      const_scope = constant_scope_for(group)\n      name        = disambiguate(base_name, const_scope)\n\n      const_scope.const_set(name, group)\n    end\n\n    def self.constant_scope_for(group)\n      const_scope = group.superclass\n      const_scope = self if const_scope == ::RSpec::Core::ExampleGroup\n      const_scope\n    end\n\n    def self.remove_all_constants\n      constants.each do |constant|\n        __send__(:remove_const, constant)\n      end\n    end\n\n    def self.base_name_for(group)\n      return \"Anonymous\".dup if group.description.empty?\n\n      # Convert to CamelCase.\n      name = ' ' + group.description\n      name.gsub!(/[^0-9a-zA-Z]+([0-9a-zA-Z])/) do\n        match = ::Regexp.last_match[1]\n        match.upcase!\n        match\n      end\n\n      name.lstrip!                # Remove leading whitespace\n      name.gsub!(/\\W/, ''.freeze) # JRuby, RBX and others don't like non-ascii in const names\n\n      # Ruby requires first const letter to be A-Z. Use `Nested`\n      # as necessary to enforce that.\n      name.gsub!(/\\A([^A-Z]|\\z)/, 'Nested\\1'.freeze)\n\n      name\n    end\n\n    if RUBY_VERSION == '1.9.2'\n      # :nocov:\n      class << self\n        alias _base_name_for base_name_for\n        def base_name_for(group)\n          _base_name_for(group) + '_'\n        end\n      end\n      private_class_method :_base_name_for\n      # :nocov:\n    end\n\n    def self.disambiguate(name, const_scope)\n      return name unless const_defined_on?(const_scope, name)\n\n      # Add a trailing number if needed to disambiguate from an existing\n      # constant.\n      name << \"_2\"\n      name.next! while const_defined_on?(const_scope, name)\n      name\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "base_name_for", "signature": "def self.base_name_for(group)", "start_line": 862, "end_line": 881}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 259}
{"function_name": "persist", "file_path": "rspec-core/lib/rspec/core/example_status_persister.rb", "focal_code": "def persist\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(@file_name))\n        File.open(@file_name, File::RDWR | File::CREAT) do |f|\n          # lock the file while reading / persisting to avoid a race\n          # condition where parallel or unrelated spec runs race to\n          # update the same file\n          f.flock(File::LOCK_EX)\n          unparsed_previous_runs = f.read\n          f.rewind\n          f.write(dump_statuses(unparsed_previous_runs))\n          f.flush\n          f.truncate(f.pos)\n        end\n      end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\nmodule RSpec\n  module Core\n    # Persists example ids and their statuses so that we can filter\n    # to just the ones that failed the last time they ran.\n    # @private\n    class ExampleStatusPersister\n      def self.load_from(file_name)\n        return [] unless File.exist?(file_name)\n        ExampleStatusParser.parse(File.read(file_name))\n      end\n\n      def self.persist(examples, file_name)\n        new(examples, file_name).persist\n      end\n\n      def initialize(examples, file_name)\n        @examples  = examples\n        @file_name = file_name\n      end\n\n      def persist\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(@file_name))\n        File.open(@file_name, File::RDWR | File::CREAT) do |f|\n          # lock the file while reading / persisting to avoid a race\n          # condition where parallel or unrelated spec runs race to\n          # update the same file\n          f.flock(File::LOCK_EX)\n          unparsed_previous_runs = f.read\n          f.rewind\n          f.write(dump_statuses(unparsed_previous_runs))\n          f.flush\n          f.truncate(f.pos)\n        end\n      end\n\n    private\n\n      def dump_statuses(unparsed_previous_runs)\n        statuses_from_previous_runs = ExampleStatusParser.parse(unparsed_previous_runs)\n        merged_statuses = ExampleStatusMerger.merge(statuses_from_this_run, statuses_from_previous_runs)\n        ExampleStatusDumper.dump(merged_statuses)\n      end\n\n      def statuses_from_this_run\n        @examples.map do |ex|\n          result = ex.execution_result\n\n          {\n            :example_id => ex.id,\n            :status     => result.status ? result.status.to_s : Configuration::UNKNOWN_STATUS,\n            :run_time   => result.run_time ? Formatters::Helpers.format_duration(result.run_time) : \"\"\n          }\n        end\n      end\n    end\n\n    # Merges together a list of example statuses from this run\n    # and a list from previous runs (presumably loaded from disk).\n    # Each example status object is expected to be a hash with\n    # at least an `:example_id` and a `:status` key. Examples that\n    # were loaded but not executed (due to filtering, `--fail-fast`\n    # or whatever) should have a `:status` of `UNKNOWN_STATUS`.\n    #\n    # This will produce a new list that:\n    #   - Will be missing examples from previous runs that we know for sure\n    #     no longer exist.\n    #   - Will have the latest known status for any examples that either\n    #     definitively do exist or may still exist.\n    #   - Is sorted by file name and example definition order, so that\n    #     the saved file is easily scannable if users want to inspect it.\n    # @private\n    class ExampleStatusMerger\n      def self.merge(this_run, from_previous_runs)\n        new(this_run, from_previous_runs).merge\n      end\n\n      def initialize(this_run, from_previous_runs)\n        @this_run           = hash_from(this_run)\n        @from_previous_runs = hash_from(from_previous_runs)\n        @file_exists_cache  = Hash.new { |hash, file| hash[file] = File.exist?(file) }\n      end\n\n      def merge\n        delete_previous_examples_that_no_longer_exist\n\n        @this_run.merge(@from_previous_runs) do |_ex_id, new, old|\n          new.fetch(:status) == Configuration::UNKNOWN_STATUS ? old : new\n        end.values.sort_by(&method(:sort_value_from))\n      end\n\n    private\n\n      def hash_from(example_list)\n        example_list.inject({}) do |hash, example|\n          hash[example.fetch(:example_id)] = example\n          hash\n        end\n      end\n\n      def delete_previous_examples_that_no_longer_exist\n        @from_previous_runs.delete_if do |ex_id, _|\n          example_must_no_longer_exist?(ex_id)\n        end\n      end\n\n      def example_must_no_longer_exist?(ex_id)\n        # Obviously, it exists if it was loaded for this spec run...\n        return false if @this_run.key?(ex_id)\n\n        spec_file = spec_file_from(ex_id)\n\n        # `this_run` includes examples that were loaded but not executed.\n        # Given that, if the spec file for this example was loaded,\n        # but the id does not still exist, it's safe to assume that\n        # the example must no longer exist.\n        return true if loaded_spec_files.include?(spec_file)\n\n        # The example may still exist as long as the file exists...\n        !@file_exists_cache[spec_file]\n      end\n\n      def loaded_spec_files\n        @loaded_spec_files ||= Set.new(@this_run.keys.map(&method(:spec_file_from)))\n      end\n\n      def spec_file_from(ex_id)\n        ex_id.split(\"[\").first\n      end\n\n      def sort_value_from(example)\n        file, scoped_id = Example.parse_id(example.fetch(:example_id))\n        [file, *scoped_id.split(\":\").map(&method(:Integer))]\n      end\n    end\n\n    # Dumps a list of hashes in a pretty, human readable format\n    # for later parsing. The hashes are expected to have symbol\n    # keys and string values, and each hash should have the same\n    # set of keys.\n    # @private\n    class ExampleStatusDumper\n      def self.dump(examples)\n        new(examples).dump\n      end\n\n      def initialize(examples)\n        @examples = examples\n      end\n\n      def dump\n        return nil if @examples.empty?\n        (formatted_header_rows + formatted_value_rows).join(\"\\n\") << \"\\n\"\n      end\n\n    private\n\n      def formatted_header_rows\n        @formatted_header_rows ||= begin\n          dividers = column_widths.map { |w| \"-\" * w }\n          [formatted_row_from(headers.map(&:to_s)), formatted_row_from(dividers)]\n        end\n      end\n\n      def formatted_value_rows\n        @formatted_value_rows ||= rows.map do |row|\n          formatted_row_from(row)\n        end\n      end\n\n      def rows\n        @rows ||= @examples.map { |ex| ex.values_at(*headers) }\n      end\n\n      def formatted_row_from(row_values)\n        padded_values = row_values.each_with_index.map do |value, index|\n          value.ljust(column_widths[index])\n        end\n\n        padded_values.join(\" | \") << \" |\"\n      end\n\n      def headers\n        @headers ||= @examples.first.keys\n      end\n\n      def column_widths\n        @column_widths ||= begin\n          value_sets = rows.transpose\n\n          headers.each_with_index.map do |header, index|\n            values = value_sets[index] << header.to_s\n            values.map(&:length).max\n          end\n        end\n      end\n    end\n\n    # Parses a string that has been previously dumped by ExampleStatusDumper.\n    # Note that this parser is a bit naive in that it does a simple split on\n    # \"\\n\" and \" | \", with no concern for handling escaping. For now, that's\n    # OK because the values we plan to persist (example id, status, and perhaps\n    # example duration) are highly unlikely to contain \"\\n\" or \" | \" -- after\n    # all, who puts those in file names?\n    # @private\n    class ExampleStatusParser\n      def self.parse(string)\n        new(string).parse\n      end\n\n      def initialize(string)\n        @header_line, _, *@row_lines = string.lines.to_a\n      end\n\n      def parse\n        @row_lines.map { |line| parse_row(line) }\n      end\n\n    private\n\n      def parse_row(line)\n        Hash[headers.zip(split_line(line))]\n      end\n\n      def headers\n        @headers ||= split_line(@header_line).grep(/\\S/).map(&:to_sym)\n      end\n\n      def split_line(line)\n        line.split(/\\s+\\|\\s+?/, -1)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "persist", "signature": "def persist RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(@file_name))", "start_line": 23, "end_line": 36}, "metadata": {"module": "RSpec", "class_name": "ExampleStatusPersister", "class_signature": "class ExampleStatusPersister"}, "task_id": 260}
{"function_name": "statuses_from_this_run", "file_path": "rspec-core/lib/rspec/core/example_status_persister.rb", "focal_code": "def statuses_from_this_run\n        @examples.map do |ex|\n          result = ex.execution_result\n\n          {\n            :example_id => ex.id,\n            :status     => result.status ? result.status.to_s : Configuration::UNKNOWN_STATUS,\n            :run_time   => result.run_time ? Formatters::Helpers.format_duration(result.run_time) : \"\"\n          }\n        end\n      end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\nmodule RSpec\n  module Core\n    # Persists example ids and their statuses so that we can filter\n    # to just the ones that failed the last time they ran.\n    # @private\n    class ExampleStatusPersister\n      def self.load_from(file_name)\n        return [] unless File.exist?(file_name)\n        ExampleStatusParser.parse(File.read(file_name))\n      end\n\n      def self.persist(examples, file_name)\n        new(examples, file_name).persist\n      end\n\n      def initialize(examples, file_name)\n        @examples  = examples\n        @file_name = file_name\n      end\n\n      def persist\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(@file_name))\n        File.open(@file_name, File::RDWR | File::CREAT) do |f|\n          # lock the file while reading / persisting to avoid a race\n          # condition where parallel or unrelated spec runs race to\n          # update the same file\n          f.flock(File::LOCK_EX)\n          unparsed_previous_runs = f.read\n          f.rewind\n          f.write(dump_statuses(unparsed_previous_runs))\n          f.flush\n          f.truncate(f.pos)\n        end\n      end\n\n    private\n\n      def dump_statuses(unparsed_previous_runs)\n        statuses_from_previous_runs = ExampleStatusParser.parse(unparsed_previous_runs)\n        merged_statuses = ExampleStatusMerger.merge(statuses_from_this_run, statuses_from_previous_runs)\n        ExampleStatusDumper.dump(merged_statuses)\n      end\n\n      def statuses_from_this_run\n        @examples.map do |ex|\n          result = ex.execution_result\n\n          {\n            :example_id => ex.id,\n            :status     => result.status ? result.status.to_s : Configuration::UNKNOWN_STATUS,\n            :run_time   => result.run_time ? Formatters::Helpers.format_duration(result.run_time) : \"\"\n          }\n        end\n      end\n    end\n\n    # Merges together a list of example statuses from this run\n    # and a list from previous runs (presumably loaded from disk).\n    # Each example status object is expected to be a hash with\n    # at least an `:example_id` and a `:status` key. Examples that\n    # were loaded but not executed (due to filtering, `--fail-fast`\n    # or whatever) should have a `:status` of `UNKNOWN_STATUS`.\n    #\n    # This will produce a new list that:\n    #   - Will be missing examples from previous runs that we know for sure\n    #     no longer exist.\n    #   - Will have the latest known status for any examples that either\n    #     definitively do exist or may still exist.\n    #   - Is sorted by file name and example definition order, so that\n    #     the saved file is easily scannable if users want to inspect it.\n    # @private\n    class ExampleStatusMerger\n      def self.merge(this_run, from_previous_runs)\n        new(this_run, from_previous_runs).merge\n      end\n\n      def initialize(this_run, from_previous_runs)\n        @this_run           = hash_from(this_run)\n        @from_previous_runs = hash_from(from_previous_runs)\n        @file_exists_cache  = Hash.new { |hash, file| hash[file] = File.exist?(file) }\n      end\n\n      def merge\n        delete_previous_examples_that_no_longer_exist\n\n        @this_run.merge(@from_previous_runs) do |_ex_id, new, old|\n          new.fetch(:status) == Configuration::UNKNOWN_STATUS ? old : new\n        end.values.sort_by(&method(:sort_value_from))\n      end\n\n    private\n\n      def hash_from(example_list)\n        example_list.inject({}) do |hash, example|\n          hash[example.fetch(:example_id)] = example\n          hash\n        end\n      end\n\n      def delete_previous_examples_that_no_longer_exist\n        @from_previous_runs.delete_if do |ex_id, _|\n          example_must_no_longer_exist?(ex_id)\n        end\n      end\n\n      def example_must_no_longer_exist?(ex_id)\n        # Obviously, it exists if it was loaded for this spec run...\n        return false if @this_run.key?(ex_id)\n\n        spec_file = spec_file_from(ex_id)\n\n        # `this_run` includes examples that were loaded but not executed.\n        # Given that, if the spec file for this example was loaded,\n        # but the id does not still exist, it's safe to assume that\n        # the example must no longer exist.\n        return true if loaded_spec_files.include?(spec_file)\n\n        # The example may still exist as long as the file exists...\n        !@file_exists_cache[spec_file]\n      end\n\n      def loaded_spec_files\n        @loaded_spec_files ||= Set.new(@this_run.keys.map(&method(:spec_file_from)))\n      end\n\n      def spec_file_from(ex_id)\n        ex_id.split(\"[\").first\n      end\n\n      def sort_value_from(example)\n        file, scoped_id = Example.parse_id(example.fetch(:example_id))\n        [file, *scoped_id.split(\":\").map(&method(:Integer))]\n      end\n    end\n\n    # Dumps a list of hashes in a pretty, human readable format\n    # for later parsing. The hashes are expected to have symbol\n    # keys and string values, and each hash should have the same\n    # set of keys.\n    # @private\n    class ExampleStatusDumper\n      def self.dump(examples)\n        new(examples).dump\n      end\n\n      def initialize(examples)\n        @examples = examples\n      end\n\n      def dump\n        return nil if @examples.empty?\n        (formatted_header_rows + formatted_value_rows).join(\"\\n\") << \"\\n\"\n      end\n\n    private\n\n      def formatted_header_rows\n        @formatted_header_rows ||= begin\n          dividers = column_widths.map { |w| \"-\" * w }\n          [formatted_row_from(headers.map(&:to_s)), formatted_row_from(dividers)]\n        end\n      end\n\n      def formatted_value_rows\n        @formatted_value_rows ||= rows.map do |row|\n          formatted_row_from(row)\n        end\n      end\n\n      def rows\n        @rows ||= @examples.map { |ex| ex.values_at(*headers) }\n      end\n\n      def formatted_row_from(row_values)\n        padded_values = row_values.each_with_index.map do |value, index|\n          value.ljust(column_widths[index])\n        end\n\n        padded_values.join(\" | \") << \" |\"\n      end\n\n      def headers\n        @headers ||= @examples.first.keys\n      end\n\n      def column_widths\n        @column_widths ||= begin\n          value_sets = rows.transpose\n\n          headers.each_with_index.map do |header, index|\n            values = value_sets[index] << header.to_s\n            values.map(&:length).max\n          end\n        end\n      end\n    end\n\n    # Parses a string that has been previously dumped by ExampleStatusDumper.\n    # Note that this parser is a bit naive in that it does a simple split on\n    # \"\\n\" and \" | \", with no concern for handling escaping. For now, that's\n    # OK because the values we plan to persist (example id, status, and perhaps\n    # example duration) are highly unlikely to contain \"\\n\" or \" | \" -- after\n    # all, who puts those in file names?\n    # @private\n    class ExampleStatusParser\n      def self.parse(string)\n        new(string).parse\n      end\n\n      def initialize(string)\n        @header_line, _, *@row_lines = string.lines.to_a\n      end\n\n      def parse\n        @row_lines.map { |line| parse_row(line) }\n      end\n\n    private\n\n      def parse_row(line)\n        Hash[headers.zip(split_line(line))]\n      end\n\n      def headers\n        @headers ||= split_line(@header_line).grep(/\\S/).map(&:to_sym)\n      end\n\n      def split_line(line)\n        line.split(/\\s+\\|\\s+?/, -1)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "statuses_from_this_run", "signature": "def statuses_from_this_run @examples.map do |ex|", "start_line": 46, "end_line": 56}, "metadata": {"module": "RSpec", "class_name": "ExampleStatusPersister", "class_signature": "class ExampleStatusPersister"}, "task_id": 261}
{"function_name": "prune", "file_path": "rspec-core/lib/rspec/core/filter_manager.rb", "focal_code": "def prune(examples)\n        # Semantically, this is unnecessary (the filtering below will return the empty\n        # array unmodified), but for perf reasons it's worth exiting early here. Users\n        # commonly have top-level examples groups that do not have any direct examples\n        # and instead have nested groups with examples. In that kind of situation,\n        # `examples` will be empty.\n        return examples if examples.empty?\n\n        examples = prune_conditionally_filtered_examples(examples)\n\n        if inclusions.standalone?\n          examples.select { |e| inclusions.include_example?(e) }\n        else\n          locations, ids, non_scoped_inclusions = inclusions.split_file_scoped_rules\n\n          examples.select do |ex|\n            file_scoped_include?(ex.metadata, ids, locations) do\n              !exclusions.include_example?(ex) && non_scoped_inclusions.include_example?(ex)\n            end\n          end\n        end\n      end", "file_content": "module RSpec\n  module Core\n    # @private\n    class FilterManager\n      attr_reader :exclusions, :inclusions\n\n      def initialize\n        @exclusions, @inclusions = FilterRules.build\n      end\n\n      # @api private\n      #\n      # @param file_path [String]\n      # @param line_numbers [Array]\n      def add_location(file_path, line_numbers)\n        # locations is a hash of expanded paths to arrays of line\n        # numbers to match against. e.g.\n        #   { \"path/to/file.rb\" => [37, 42] }\n        add_path_to_arrays_filter(:locations, File.expand_path(file_path), line_numbers)\n      end\n\n      def add_ids(rerun_path, scoped_ids)\n        # ids is a hash of relative paths to arrays of ids\n        # to match against. e.g.\n        #   { \"./path/to/file.rb\" => [\"1:1\", \"2:4\"] }\n        rerun_path = Metadata.relative_path(File.expand_path rerun_path)\n        add_path_to_arrays_filter(:ids, rerun_path, scoped_ids)\n      end\n\n      def empty?\n        inclusions.empty? && exclusions.empty?\n      end\n\n      def prune(examples)\n        # Semantically, this is unnecessary (the filtering below will return the empty\n        # array unmodified), but for perf reasons it's worth exiting early here. Users\n        # commonly have top-level examples groups that do not have any direct examples\n        # and instead have nested groups with examples. In that kind of situation,\n        # `examples` will be empty.\n        return examples if examples.empty?\n\n        examples = prune_conditionally_filtered_examples(examples)\n\n        if inclusions.standalone?\n          examples.select { |e| inclusions.include_example?(e) }\n        else\n          locations, ids, non_scoped_inclusions = inclusions.split_file_scoped_rules\n\n          examples.select do |ex|\n            file_scoped_include?(ex.metadata, ids, locations) do\n              !exclusions.include_example?(ex) && non_scoped_inclusions.include_example?(ex)\n            end\n          end\n        end\n      end\n\n      def exclude(*args)\n        exclusions.add(args.last)\n      end\n\n      def exclude_only(*args)\n        exclusions.use_only(args.last)\n      end\n\n      def exclude_with_low_priority(*args)\n        exclusions.add_with_low_priority(args.last)\n      end\n\n      def include(*args)\n        inclusions.add(args.last)\n      end\n\n      def include_only(*args)\n        inclusions.use_only(args.last)\n      end\n\n      def include_with_low_priority(*args)\n        inclusions.add_with_low_priority(args.last)\n      end\n\n    private\n\n      def add_path_to_arrays_filter(filter_key, path, values)\n        filter = inclusions.delete(filter_key) || Hash.new { |h, k| h[k] = [] }\n        filter[path].concat(values)\n        inclusions.add(filter_key => filter)\n      end\n\n      def prune_conditionally_filtered_examples(examples)\n        examples.reject do |ex|\n          meta = ex.metadata\n          !meta.fetch(:if, true) || meta[:unless]\n        end\n      end\n\n      # When a user specifies a particular spec location, that takes priority\n      # over any exclusion filters (such as if the spec is tagged with `:slow`\n      # and there is a `:slow => true` exclusion filter), but only for specs\n      # defined in the same file as the location filters. Excluded specs in\n      # other files should still be excluded.\n      def file_scoped_include?(ex_metadata, ids, locations)\n        no_id_filters = ids[ex_metadata[:rerun_file_path]].empty?\n        no_location_filters = locations[\n          File.expand_path(ex_metadata[:rerun_file_path])\n        ].empty?\n\n        return yield if no_location_filters && no_id_filters\n\n        MetadataFilter.filter_applies?(:ids, ids, ex_metadata) ||\n        MetadataFilter.filter_applies?(:locations, locations, ex_metadata)\n      end\n    end\n\n    # @private\n    class FilterRules\n      PROC_HEX_NUMBER = /0x[0-9a-f]+@?/\n      PROJECT_DIR = File.expand_path('.')\n\n      attr_accessor :opposite\n      attr_reader :rules\n\n      def self.build\n        exclusions = ExclusionRules.new\n        inclusions = InclusionRules.new\n        exclusions.opposite = inclusions\n        inclusions.opposite = exclusions\n        [exclusions, inclusions]\n      end\n\n      def initialize(rules={})\n        @rules = rules\n      end\n\n      def add(updated)\n        @rules.merge!(updated).each_key { |k| opposite.delete(k) }\n      end\n\n      def add_with_low_priority(updated)\n        updated = updated.merge(@rules)\n        opposite.each_pair { |k, v| updated.delete(k) if updated[k] == v }\n        @rules.replace(updated)\n      end\n\n      def use_only(updated)\n        updated.each_key { |k| opposite.delete(k) }\n        @rules.replace(updated)\n      end\n\n      def clear\n        @rules.clear\n      end\n\n      def delete(key)\n        @rules.delete(key)\n      end\n\n      def fetch(*args, &block)\n        @rules.fetch(*args, &block)\n      end\n\n      def [](key)\n        @rules[key]\n      end\n\n      def empty?\n        rules.empty?\n      end\n\n      def each_pair(&block)\n        @rules.each_pair(&block)\n      end\n\n      def description\n        rules.inspect.gsub(PROC_HEX_NUMBER, '').gsub(PROJECT_DIR, '.').gsub(' (lambda)', '')\n      end\n\n      def include_example?(example)\n        MetadataFilter.apply?(:any?, @rules, example.metadata)\n      end\n    end\n\n    # @private\n    ExclusionRules = FilterRules\n\n    # @private\n    class InclusionRules < FilterRules\n      def add(*args)\n        apply_standalone_filter(*args) || super\n      end\n\n      def add_with_low_priority(*args)\n        apply_standalone_filter(*args) || super\n      end\n\n      def include_example?(example)\n        @rules.empty? || super\n      end\n\n      def standalone?\n        is_standalone_filter?(@rules)\n      end\n\n      def split_file_scoped_rules\n        rules_dup = @rules.dup\n        locations = rules_dup.delete(:locations) { Hash.new([]) }\n        ids       = rules_dup.delete(:ids)       { Hash.new([]) }\n\n        return locations, ids, self.class.new(rules_dup)\n      end\n\n    private\n\n      def apply_standalone_filter(updated)\n        return true if standalone?\n        return nil unless is_standalone_filter?(updated)\n\n        replace_filters(updated)\n        true\n      end\n\n      def replace_filters(new_rules)\n        @rules.replace(new_rules)\n        opposite.clear\n      end\n\n      def is_standalone_filter?(rules)\n        rules.key?(:full_description)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "prune", "signature": "def prune(examples)", "start_line": 34, "end_line": 55}, "metadata": {"module": "RSpec", "class_name": "FilterManager", "class_signature": "class FilterManager"}, "task_id": 262}
{"function_name": "setup_default", "file_path": "rspec-core/lib/rspec/core/formatters.rb", "focal_code": "def setup_default(output_stream, deprecation_stream)\n      add default_formatter, output_stream if @formatters.empty?\n\n      unless @formatters.any? { |formatter| DeprecationFormatter === formatter }\n        add DeprecationFormatter, deprecation_stream, output_stream\n      end\n\n      unless existing_formatter_implements?(:message)\n        add FallbackMessageFormatter, output_stream\n      end\n\n      return unless RSpec.configuration.profile_examples?\n      return if existing_formatter_implements?(:dump_profile)\n\n      add RSpec::Core::Formatters::ProfileFormatter, output_stream\n    end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\n# ## Built-in Formatters\n#\n# * progress (default) - Prints dots for passing examples, `F` for failures, `*`\n#                        for pending.\n# * documentation - Prints the docstrings passed to `describe` and `it` methods\n#                   (and their aliases).\n# * html\n# * json - Useful for archiving data for subsequent analysis.\n#\n# The progress formatter is the default, but you can choose any one or more of\n# the other formatters by passing with the `--format` (or `-f` for short)\n# command-line option, e.g.\n#\n#     rspec --format documentation\n#\n# You can also send the output of multiple formatters to different streams, e.g.\n#\n#     rspec --format documentation --format html --out results.html\n#\n# This example sends the output of the documentation formatter to `$stdout`, and\n# the output of the html formatter to results.html.\n#\n# ## Custom Formatters\n#\n# You can tell RSpec to use a custom formatter by passing its path and name to\n# the `rspec` command. For example, if you define MyCustomFormatter in\n# path/to/my_custom_formatter.rb, you would type this command:\n#\n#     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter\n#\n# The reporter calls every formatter with this protocol:\n#\n# * To start\n#   * `start(StartNotification)`\n# * Once per example group\n#   * `example_group_started(GroupNotification)`\n# * Once per example\n#   * `example_started(ExampleNotification)`\n# * One of these per example, depending on outcome\n#   * `example_passed(ExampleNotification)`\n#   * `example_failed(FailedExampleNotification)`\n#   * `example_pending(ExampleNotification)`\n# * Optionally at any time\n#   * `message(MessageNotification)`\n# * At the end of the suite\n#   * `stop(ExamplesNotification)`\n#   * `start_dump(NullNotification)`\n#   * `dump_pending(ExamplesNotification)`\n#   * `dump_failures(ExamplesNotification)`\n#   * `dump_summary(SummaryNotification)`\n#   * `seed(SeedNotification)`\n#   * `close(NullNotification)`\n#\n# Only the notifications to which you subscribe your formatter will be called\n# on your formatter. To subscribe your formatter use:\n# `RSpec::Core::Formatters#register` e.g.\n#\n# `RSpec::Core::Formatters.register FormatterClassName, :example_passed, :example_failed`\n#\n# We recommend you implement the methods yourself; for simplicity we provide the\n# default formatter output via our notification objects but if you prefer you\n# can subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the\n# methods you wish to enhance.\n#\n# @see RSpec::Core::Formatters::BaseTextFormatter\n# @see RSpec::Core::Reporter\nmodule RSpec::Core::Formatters\n  autoload :DocumentationFormatter,   'rspec/core/formatters/documentation_formatter'\n  autoload :HtmlFormatter,            'rspec/core/formatters/html_formatter'\n  autoload :FallbackMessageFormatter, 'rspec/core/formatters/fallback_message_formatter'\n  autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'\n  autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'\n  autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'\n  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'\n  autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'\n  autoload :FailureListFormatter,     'rspec/core/formatters/failure_list_formatter'\n\n  # Register the formatter class\n  # @param formatter_class [Class] formatter class to register\n  # @param notifications [Array<Symbol>] one or more notifications to be\n  #   registered to the specified formatter\n  #\n  # @see RSpec::Core::Formatters::BaseFormatter\n  def self.register(formatter_class, *notifications)\n    Loader.formatters[formatter_class] = notifications\n  end\n\n  # @api private\n  #\n  # `RSpec::Core::Formatters::Loader` is an internal class for\n  # managing formatters used by a particular configuration. It is\n  # not expected to be used directly, but only through the configuration\n  # interface.\n  class Loader\n    # @api private\n    #\n    # Internal formatters are stored here when loaded.\n    def self.formatters\n      @formatters ||= {}\n    end\n\n    # @api private\n    def initialize(reporter)\n      @formatters = []\n      @reporter = reporter\n      self.default_formatter = 'progress'\n    end\n\n    # @return [Array] the loaded formatters\n    attr_reader :formatters\n\n    # @return [Reporter] the reporter\n    attr_reader :reporter\n\n    # @return [String] the default formatter to setup, defaults to `progress`\n    attr_accessor :default_formatter\n\n    # @private\n    def prepare_default(output_stream, deprecation_stream)\n      reporter.prepare_default(self, output_stream, deprecation_stream)\n    end\n\n    # @private\n    def setup_default(output_stream, deprecation_stream)\n      add default_formatter, output_stream if @formatters.empty?\n\n      unless @formatters.any? { |formatter| DeprecationFormatter === formatter }\n        add DeprecationFormatter, deprecation_stream, output_stream\n      end\n\n      unless existing_formatter_implements?(:message)\n        add FallbackMessageFormatter, output_stream\n      end\n\n      return unless RSpec.configuration.profile_examples?\n      return if existing_formatter_implements?(:dump_profile)\n\n      add RSpec::Core::Formatters::ProfileFormatter, output_stream\n    end\n\n    # @private\n    def add(formatter_to_use, *paths)\n      # If a formatter instance was passed, we can register it directly,\n      # with no need for any of the further processing that happens below.\n      if Loader.formatters.key?(formatter_to_use.class)\n        register formatter_to_use, notifications_for(formatter_to_use.class)\n        return\n      end\n\n      formatter_class = find_formatter(formatter_to_use)\n\n      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }\n\n      if !Loader.formatters[formatter_class].nil?\n        formatter = formatter_class.new(*args)\n        register formatter, notifications_for(formatter_class)\n      elsif defined?(RSpec::LegacyFormatters)\n        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args\n        register formatter, formatter.notifications\n      else\n        call_site = \"Formatter added at: #{::RSpec::CallerFilter.first_non_rspec_line}\"\n\n        RSpec.warn_deprecation <<-WARNING.gsub(/\\s*\\|/, ' ')\n          |The #{formatter_class} formatter uses the deprecated formatter\n          |interface not supported directly by RSpec 3.\n          |\n          |To continue to use this formatter you must install the\n          |`rspec-legacy_formatters` gem, which provides support\n          |for legacy formatters or upgrade the formatter to a\n          |compatible version.\n          |\n          |#{call_site}\n        WARNING\n      end\n    end\n\n  private\n\n    def find_formatter(formatter_to_use)\n      built_in_formatter(formatter_to_use) ||\n      custom_formatter(formatter_to_use)   ||\n      (raise ArgumentError, \"Formatter '#{formatter_to_use}' unknown - \" \\\n                            \"maybe you meant 'documentation' or 'progress'?.\")\n    end\n\n    def register(formatter, notifications)\n      return if duplicate_formatter_exists?(formatter)\n      @reporter.register_listener formatter, *notifications\n      @formatters << formatter\n      formatter\n    end\n\n    def duplicate_formatter_exists?(new_formatter)\n      @formatters.any? do |formatter|\n        formatter.class == new_formatter.class &&\n          has_matching_output?(formatter, new_formatter)\n      end\n    end\n\n    def has_matching_output?(formatter, new_formatter)\n      return true unless formatter.respond_to?(:output) && new_formatter.respond_to?(:output)\n      formatter.output == new_formatter.output\n    end\n\n    def existing_formatter_implements?(notification)\n      @reporter.registered_listeners(notification).any?\n    end\n\n    def built_in_formatter(key)\n      case key.to_s\n      when 'd', 'doc', 'documentation'\n        DocumentationFormatter\n      when 'h', 'html'\n        HtmlFormatter\n      when 'p', 'progress'\n        ProgressFormatter\n      when 'j', 'json'\n        JsonFormatter\n      when 'bisect-drb'\n        BisectDRbFormatter\n      when 'f', 'failures'\n        FailureListFormatter\n      end\n    end\n\n    def notifications_for(formatter_class)\n      formatter_class.ancestors.inject(::RSpec::Core::Set.new) do |notifications, klass|\n        notifications.merge Loader.formatters.fetch(klass) { ::RSpec::Core::Set.new }\n      end\n    end\n\n    def custom_formatter(formatter_ref)\n      if Class === formatter_ref\n        formatter_ref\n      elsif string_const?(formatter_ref)\n        begin\n          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }\n        rescue NameError\n          require(path_for(formatter_ref)) ? retry : raise\n        end\n      end\n    end\n\n    def string_const?(str)\n      str.is_a?(String) && /\\A[A-Z][a-zA-Z0-9_:]*\\z/ =~ str\n    end\n\n    def path_for(const_ref)\n      underscore_with_fix_for_non_standard_rspec_naming(const_ref)\n    end\n\n    def underscore_with_fix_for_non_standard_rspec_naming(string)\n      underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\\\1rspec\\\\2')\n    end\n\n    # activesupport/lib/active_support/inflector/methods.rb, line 48\n    def underscore(camel_cased_word)\n      word = camel_cased_word.to_s.dup\n      word.gsub!(/::/, '/')\n      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')\n      word.gsub!(/([a-z\\d])([A-Z])/, '\\1_\\2')\n      word.tr!(\"-\", \"_\")\n      word.downcase!\n      word\n    end\n\n    def open_stream(path_or_wrapper)\n      if RSpec::Core::OutputWrapper === path_or_wrapper\n        path_or_wrapper.output = open_stream(path_or_wrapper.output)\n        path_or_wrapper\n      else\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path_or_wrapper))\n        File.new(path_or_wrapper, 'w')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "setup_default", "signature": "def setup_default(output_stream, deprecation_stream)", "start_line": 126, "end_line": 141}, "metadata": {"module": "RSpec", "class_name": "Loader", "class_signature": "class Loader"}, "task_id": 263}
{"function_name": "add", "file_path": "rspec-core/lib/rspec/core/formatters.rb", "focal_code": "def add(formatter_to_use, *paths)\n      # If a formatter instance was passed, we can register it directly,\n      # with no need for any of the further processing that happens below.\n      if Loader.formatters.key?(formatter_to_use.class)\n        register formatter_to_use, notifications_for(formatter_to_use.class)\n        return\n      end\n\n      formatter_class = find_formatter(formatter_to_use)\n\n      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }\n\n      if !Loader.formatters[formatter_class].nil?\n        formatter = formatter_class.new(*args)\n        register formatter, notifications_for(formatter_class)\n      elsif defined?(RSpec::LegacyFormatters)\n        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args\n        register formatter, formatter.notifications\n      else\n        call_site = \"Formatter added at: #{::RSpec::CallerFilter.first_non_rspec_line}\"\n\n        RSpec.warn_deprecation <<-WARNING.gsub(/\\s*\\|/, ' ')\n          |The #{formatter_class} formatter uses the deprecated formatter\n          |interface not supported directly by RSpec 3.\n          |\n          |To continue to use this formatter you must install the\n          |`rspec-legacy_formatters` gem, which provides support\n          |for legacy formatters or upgrade the formatter to a\n          |compatible version.\n          |\n          |#{call_site}\n        WARNING\n      end\n    end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\n# ## Built-in Formatters\n#\n# * progress (default) - Prints dots for passing examples, `F` for failures, `*`\n#                        for pending.\n# * documentation - Prints the docstrings passed to `describe` and `it` methods\n#                   (and their aliases).\n# * html\n# * json - Useful for archiving data for subsequent analysis.\n#\n# The progress formatter is the default, but you can choose any one or more of\n# the other formatters by passing with the `--format` (or `-f` for short)\n# command-line option, e.g.\n#\n#     rspec --format documentation\n#\n# You can also send the output of multiple formatters to different streams, e.g.\n#\n#     rspec --format documentation --format html --out results.html\n#\n# This example sends the output of the documentation formatter to `$stdout`, and\n# the output of the html formatter to results.html.\n#\n# ## Custom Formatters\n#\n# You can tell RSpec to use a custom formatter by passing its path and name to\n# the `rspec` command. For example, if you define MyCustomFormatter in\n# path/to/my_custom_formatter.rb, you would type this command:\n#\n#     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter\n#\n# The reporter calls every formatter with this protocol:\n#\n# * To start\n#   * `start(StartNotification)`\n# * Once per example group\n#   * `example_group_started(GroupNotification)`\n# * Once per example\n#   * `example_started(ExampleNotification)`\n# * One of these per example, depending on outcome\n#   * `example_passed(ExampleNotification)`\n#   * `example_failed(FailedExampleNotification)`\n#   * `example_pending(ExampleNotification)`\n# * Optionally at any time\n#   * `message(MessageNotification)`\n# * At the end of the suite\n#   * `stop(ExamplesNotification)`\n#   * `start_dump(NullNotification)`\n#   * `dump_pending(ExamplesNotification)`\n#   * `dump_failures(ExamplesNotification)`\n#   * `dump_summary(SummaryNotification)`\n#   * `seed(SeedNotification)`\n#   * `close(NullNotification)`\n#\n# Only the notifications to which you subscribe your formatter will be called\n# on your formatter. To subscribe your formatter use:\n# `RSpec::Core::Formatters#register` e.g.\n#\n# `RSpec::Core::Formatters.register FormatterClassName, :example_passed, :example_failed`\n#\n# We recommend you implement the methods yourself; for simplicity we provide the\n# default formatter output via our notification objects but if you prefer you\n# can subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the\n# methods you wish to enhance.\n#\n# @see RSpec::Core::Formatters::BaseTextFormatter\n# @see RSpec::Core::Reporter\nmodule RSpec::Core::Formatters\n  autoload :DocumentationFormatter,   'rspec/core/formatters/documentation_formatter'\n  autoload :HtmlFormatter,            'rspec/core/formatters/html_formatter'\n  autoload :FallbackMessageFormatter, 'rspec/core/formatters/fallback_message_formatter'\n  autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'\n  autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'\n  autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'\n  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'\n  autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'\n  autoload :FailureListFormatter,     'rspec/core/formatters/failure_list_formatter'\n\n  # Register the formatter class\n  # @param formatter_class [Class] formatter class to register\n  # @param notifications [Array<Symbol>] one or more notifications to be\n  #   registered to the specified formatter\n  #\n  # @see RSpec::Core::Formatters::BaseFormatter\n  def self.register(formatter_class, *notifications)\n    Loader.formatters[formatter_class] = notifications\n  end\n\n  # @api private\n  #\n  # `RSpec::Core::Formatters::Loader` is an internal class for\n  # managing formatters used by a particular configuration. It is\n  # not expected to be used directly, but only through the configuration\n  # interface.\n  class Loader\n    # @api private\n    #\n    # Internal formatters are stored here when loaded.\n    def self.formatters\n      @formatters ||= {}\n    end\n\n    # @api private\n    def initialize(reporter)\n      @formatters = []\n      @reporter = reporter\n      self.default_formatter = 'progress'\n    end\n\n    # @return [Array] the loaded formatters\n    attr_reader :formatters\n\n    # @return [Reporter] the reporter\n    attr_reader :reporter\n\n    # @return [String] the default formatter to setup, defaults to `progress`\n    attr_accessor :default_formatter\n\n    # @private\n    def prepare_default(output_stream, deprecation_stream)\n      reporter.prepare_default(self, output_stream, deprecation_stream)\n    end\n\n    # @private\n    def setup_default(output_stream, deprecation_stream)\n      add default_formatter, output_stream if @formatters.empty?\n\n      unless @formatters.any? { |formatter| DeprecationFormatter === formatter }\n        add DeprecationFormatter, deprecation_stream, output_stream\n      end\n\n      unless existing_formatter_implements?(:message)\n        add FallbackMessageFormatter, output_stream\n      end\n\n      return unless RSpec.configuration.profile_examples?\n      return if existing_formatter_implements?(:dump_profile)\n\n      add RSpec::Core::Formatters::ProfileFormatter, output_stream\n    end\n\n    # @private\n    def add(formatter_to_use, *paths)\n      # If a formatter instance was passed, we can register it directly,\n      # with no need for any of the further processing that happens below.\n      if Loader.formatters.key?(formatter_to_use.class)\n        register formatter_to_use, notifications_for(formatter_to_use.class)\n        return\n      end\n\n      formatter_class = find_formatter(formatter_to_use)\n\n      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }\n\n      if !Loader.formatters[formatter_class].nil?\n        formatter = formatter_class.new(*args)\n        register formatter, notifications_for(formatter_class)\n      elsif defined?(RSpec::LegacyFormatters)\n        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args\n        register formatter, formatter.notifications\n      else\n        call_site = \"Formatter added at: #{::RSpec::CallerFilter.first_non_rspec_line}\"\n\n        RSpec.warn_deprecation <<-WARNING.gsub(/\\s*\\|/, ' ')\n          |The #{formatter_class} formatter uses the deprecated formatter\n          |interface not supported directly by RSpec 3.\n          |\n          |To continue to use this formatter you must install the\n          |`rspec-legacy_formatters` gem, which provides support\n          |for legacy formatters or upgrade the formatter to a\n          |compatible version.\n          |\n          |#{call_site}\n        WARNING\n      end\n    end\n\n  private\n\n    def find_formatter(formatter_to_use)\n      built_in_formatter(formatter_to_use) ||\n      custom_formatter(formatter_to_use)   ||\n      (raise ArgumentError, \"Formatter '#{formatter_to_use}' unknown - \" \\\n                            \"maybe you meant 'documentation' or 'progress'?.\")\n    end\n\n    def register(formatter, notifications)\n      return if duplicate_formatter_exists?(formatter)\n      @reporter.register_listener formatter, *notifications\n      @formatters << formatter\n      formatter\n    end\n\n    def duplicate_formatter_exists?(new_formatter)\n      @formatters.any? do |formatter|\n        formatter.class == new_formatter.class &&\n          has_matching_output?(formatter, new_formatter)\n      end\n    end\n\n    def has_matching_output?(formatter, new_formatter)\n      return true unless formatter.respond_to?(:output) && new_formatter.respond_to?(:output)\n      formatter.output == new_formatter.output\n    end\n\n    def existing_formatter_implements?(notification)\n      @reporter.registered_listeners(notification).any?\n    end\n\n    def built_in_formatter(key)\n      case key.to_s\n      when 'd', 'doc', 'documentation'\n        DocumentationFormatter\n      when 'h', 'html'\n        HtmlFormatter\n      when 'p', 'progress'\n        ProgressFormatter\n      when 'j', 'json'\n        JsonFormatter\n      when 'bisect-drb'\n        BisectDRbFormatter\n      when 'f', 'failures'\n        FailureListFormatter\n      end\n    end\n\n    def notifications_for(formatter_class)\n      formatter_class.ancestors.inject(::RSpec::Core::Set.new) do |notifications, klass|\n        notifications.merge Loader.formatters.fetch(klass) { ::RSpec::Core::Set.new }\n      end\n    end\n\n    def custom_formatter(formatter_ref)\n      if Class === formatter_ref\n        formatter_ref\n      elsif string_const?(formatter_ref)\n        begin\n          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }\n        rescue NameError\n          require(path_for(formatter_ref)) ? retry : raise\n        end\n      end\n    end\n\n    def string_const?(str)\n      str.is_a?(String) && /\\A[A-Z][a-zA-Z0-9_:]*\\z/ =~ str\n    end\n\n    def path_for(const_ref)\n      underscore_with_fix_for_non_standard_rspec_naming(const_ref)\n    end\n\n    def underscore_with_fix_for_non_standard_rspec_naming(string)\n      underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\\\1rspec\\\\2')\n    end\n\n    # activesupport/lib/active_support/inflector/methods.rb, line 48\n    def underscore(camel_cased_word)\n      word = camel_cased_word.to_s.dup\n      word.gsub!(/::/, '/')\n      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')\n      word.gsub!(/([a-z\\d])([A-Z])/, '\\1_\\2')\n      word.tr!(\"-\", \"_\")\n      word.downcase!\n      word\n    end\n\n    def open_stream(path_or_wrapper)\n      if RSpec::Core::OutputWrapper === path_or_wrapper\n        path_or_wrapper.output = open_stream(path_or_wrapper.output)\n        path_or_wrapper\n      else\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path_or_wrapper))\n        File.new(path_or_wrapper, 'w')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add", "signature": "def add(formatter_to_use, *paths)", "start_line": 144, "end_line": 177}, "metadata": {"module": "RSpec", "class_name": "Loader", "class_signature": "class Loader"}, "task_id": 264}
{"function_name": "built_in_formatter", "file_path": "rspec-core/lib/rspec/core/formatters.rb", "focal_code": "def built_in_formatter(key)\n      case key.to_s\n      when 'd', 'doc', 'documentation'\n        DocumentationFormatter\n      when 'h', 'html'\n        HtmlFormatter\n      when 'p', 'progress'\n        ProgressFormatter\n      when 'j', 'json'\n        JsonFormatter\n      when 'bisect-drb'\n        BisectDRbFormatter\n      when 'f', 'failures'\n        FailureListFormatter\n      end\n    end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\n# ## Built-in Formatters\n#\n# * progress (default) - Prints dots for passing examples, `F` for failures, `*`\n#                        for pending.\n# * documentation - Prints the docstrings passed to `describe` and `it` methods\n#                   (and their aliases).\n# * html\n# * json - Useful for archiving data for subsequent analysis.\n#\n# The progress formatter is the default, but you can choose any one or more of\n# the other formatters by passing with the `--format` (or `-f` for short)\n# command-line option, e.g.\n#\n#     rspec --format documentation\n#\n# You can also send the output of multiple formatters to different streams, e.g.\n#\n#     rspec --format documentation --format html --out results.html\n#\n# This example sends the output of the documentation formatter to `$stdout`, and\n# the output of the html formatter to results.html.\n#\n# ## Custom Formatters\n#\n# You can tell RSpec to use a custom formatter by passing its path and name to\n# the `rspec` command. For example, if you define MyCustomFormatter in\n# path/to/my_custom_formatter.rb, you would type this command:\n#\n#     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter\n#\n# The reporter calls every formatter with this protocol:\n#\n# * To start\n#   * `start(StartNotification)`\n# * Once per example group\n#   * `example_group_started(GroupNotification)`\n# * Once per example\n#   * `example_started(ExampleNotification)`\n# * One of these per example, depending on outcome\n#   * `example_passed(ExampleNotification)`\n#   * `example_failed(FailedExampleNotification)`\n#   * `example_pending(ExampleNotification)`\n# * Optionally at any time\n#   * `message(MessageNotification)`\n# * At the end of the suite\n#   * `stop(ExamplesNotification)`\n#   * `start_dump(NullNotification)`\n#   * `dump_pending(ExamplesNotification)`\n#   * `dump_failures(ExamplesNotification)`\n#   * `dump_summary(SummaryNotification)`\n#   * `seed(SeedNotification)`\n#   * `close(NullNotification)`\n#\n# Only the notifications to which you subscribe your formatter will be called\n# on your formatter. To subscribe your formatter use:\n# `RSpec::Core::Formatters#register` e.g.\n#\n# `RSpec::Core::Formatters.register FormatterClassName, :example_passed, :example_failed`\n#\n# We recommend you implement the methods yourself; for simplicity we provide the\n# default formatter output via our notification objects but if you prefer you\n# can subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the\n# methods you wish to enhance.\n#\n# @see RSpec::Core::Formatters::BaseTextFormatter\n# @see RSpec::Core::Reporter\nmodule RSpec::Core::Formatters\n  autoload :DocumentationFormatter,   'rspec/core/formatters/documentation_formatter'\n  autoload :HtmlFormatter,            'rspec/core/formatters/html_formatter'\n  autoload :FallbackMessageFormatter, 'rspec/core/formatters/fallback_message_formatter'\n  autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'\n  autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'\n  autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'\n  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'\n  autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'\n  autoload :FailureListFormatter,     'rspec/core/formatters/failure_list_formatter'\n\n  # Register the formatter class\n  # @param formatter_class [Class] formatter class to register\n  # @param notifications [Array<Symbol>] one or more notifications to be\n  #   registered to the specified formatter\n  #\n  # @see RSpec::Core::Formatters::BaseFormatter\n  def self.register(formatter_class, *notifications)\n    Loader.formatters[formatter_class] = notifications\n  end\n\n  # @api private\n  #\n  # `RSpec::Core::Formatters::Loader` is an internal class for\n  # managing formatters used by a particular configuration. It is\n  # not expected to be used directly, but only through the configuration\n  # interface.\n  class Loader\n    # @api private\n    #\n    # Internal formatters are stored here when loaded.\n    def self.formatters\n      @formatters ||= {}\n    end\n\n    # @api private\n    def initialize(reporter)\n      @formatters = []\n      @reporter = reporter\n      self.default_formatter = 'progress'\n    end\n\n    # @return [Array] the loaded formatters\n    attr_reader :formatters\n\n    # @return [Reporter] the reporter\n    attr_reader :reporter\n\n    # @return [String] the default formatter to setup, defaults to `progress`\n    attr_accessor :default_formatter\n\n    # @private\n    def prepare_default(output_stream, deprecation_stream)\n      reporter.prepare_default(self, output_stream, deprecation_stream)\n    end\n\n    # @private\n    def setup_default(output_stream, deprecation_stream)\n      add default_formatter, output_stream if @formatters.empty?\n\n      unless @formatters.any? { |formatter| DeprecationFormatter === formatter }\n        add DeprecationFormatter, deprecation_stream, output_stream\n      end\n\n      unless existing_formatter_implements?(:message)\n        add FallbackMessageFormatter, output_stream\n      end\n\n      return unless RSpec.configuration.profile_examples?\n      return if existing_formatter_implements?(:dump_profile)\n\n      add RSpec::Core::Formatters::ProfileFormatter, output_stream\n    end\n\n    # @private\n    def add(formatter_to_use, *paths)\n      # If a formatter instance was passed, we can register it directly,\n      # with no need for any of the further processing that happens below.\n      if Loader.formatters.key?(formatter_to_use.class)\n        register formatter_to_use, notifications_for(formatter_to_use.class)\n        return\n      end\n\n      formatter_class = find_formatter(formatter_to_use)\n\n      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }\n\n      if !Loader.formatters[formatter_class].nil?\n        formatter = formatter_class.new(*args)\n        register formatter, notifications_for(formatter_class)\n      elsif defined?(RSpec::LegacyFormatters)\n        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args\n        register formatter, formatter.notifications\n      else\n        call_site = \"Formatter added at: #{::RSpec::CallerFilter.first_non_rspec_line}\"\n\n        RSpec.warn_deprecation <<-WARNING.gsub(/\\s*\\|/, ' ')\n          |The #{formatter_class} formatter uses the deprecated formatter\n          |interface not supported directly by RSpec 3.\n          |\n          |To continue to use this formatter you must install the\n          |`rspec-legacy_formatters` gem, which provides support\n          |for legacy formatters or upgrade the formatter to a\n          |compatible version.\n          |\n          |#{call_site}\n        WARNING\n      end\n    end\n\n  private\n\n    def find_formatter(formatter_to_use)\n      built_in_formatter(formatter_to_use) ||\n      custom_formatter(formatter_to_use)   ||\n      (raise ArgumentError, \"Formatter '#{formatter_to_use}' unknown - \" \\\n                            \"maybe you meant 'documentation' or 'progress'?.\")\n    end\n\n    def register(formatter, notifications)\n      return if duplicate_formatter_exists?(formatter)\n      @reporter.register_listener formatter, *notifications\n      @formatters << formatter\n      formatter\n    end\n\n    def duplicate_formatter_exists?(new_formatter)\n      @formatters.any? do |formatter|\n        formatter.class == new_formatter.class &&\n          has_matching_output?(formatter, new_formatter)\n      end\n    end\n\n    def has_matching_output?(formatter, new_formatter)\n      return true unless formatter.respond_to?(:output) && new_formatter.respond_to?(:output)\n      formatter.output == new_formatter.output\n    end\n\n    def existing_formatter_implements?(notification)\n      @reporter.registered_listeners(notification).any?\n    end\n\n    def built_in_formatter(key)\n      case key.to_s\n      when 'd', 'doc', 'documentation'\n        DocumentationFormatter\n      when 'h', 'html'\n        HtmlFormatter\n      when 'p', 'progress'\n        ProgressFormatter\n      when 'j', 'json'\n        JsonFormatter\n      when 'bisect-drb'\n        BisectDRbFormatter\n      when 'f', 'failures'\n        FailureListFormatter\n      end\n    end\n\n    def notifications_for(formatter_class)\n      formatter_class.ancestors.inject(::RSpec::Core::Set.new) do |notifications, klass|\n        notifications.merge Loader.formatters.fetch(klass) { ::RSpec::Core::Set.new }\n      end\n    end\n\n    def custom_formatter(formatter_ref)\n      if Class === formatter_ref\n        formatter_ref\n      elsif string_const?(formatter_ref)\n        begin\n          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }\n        rescue NameError\n          require(path_for(formatter_ref)) ? retry : raise\n        end\n      end\n    end\n\n    def string_const?(str)\n      str.is_a?(String) && /\\A[A-Z][a-zA-Z0-9_:]*\\z/ =~ str\n    end\n\n    def path_for(const_ref)\n      underscore_with_fix_for_non_standard_rspec_naming(const_ref)\n    end\n\n    def underscore_with_fix_for_non_standard_rspec_naming(string)\n      underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\\\1rspec\\\\2')\n    end\n\n    # activesupport/lib/active_support/inflector/methods.rb, line 48\n    def underscore(camel_cased_word)\n      word = camel_cased_word.to_s.dup\n      word.gsub!(/::/, '/')\n      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')\n      word.gsub!(/([a-z\\d])([A-Z])/, '\\1_\\2')\n      word.tr!(\"-\", \"_\")\n      word.downcase!\n      word\n    end\n\n    def open_stream(path_or_wrapper)\n      if RSpec::Core::OutputWrapper === path_or_wrapper\n        path_or_wrapper.output = open_stream(path_or_wrapper.output)\n        path_or_wrapper\n      else\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path_or_wrapper))\n        File.new(path_or_wrapper, 'w')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "built_in_formatter", "signature": "def built_in_formatter(key)", "start_line": 211, "end_line": 226}, "metadata": {"module": "RSpec", "class_name": "Loader", "class_signature": "class Loader"}, "task_id": 265}
{"function_name": "custom_formatter", "file_path": "rspec-core/lib/rspec/core/formatters.rb", "focal_code": "def custom_formatter(formatter_ref)\n      if Class === formatter_ref\n        formatter_ref\n      elsif string_const?(formatter_ref)\n        begin\n          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }\n        rescue NameError\n          require(path_for(formatter_ref)) ? retry : raise\n        end\n      end\n    end", "file_content": "RSpec::Support.require_rspec_support \"directory_maker\"\n\n# ## Built-in Formatters\n#\n# * progress (default) - Prints dots for passing examples, `F` for failures, `*`\n#                        for pending.\n# * documentation - Prints the docstrings passed to `describe` and `it` methods\n#                   (and their aliases).\n# * html\n# * json - Useful for archiving data for subsequent analysis.\n#\n# The progress formatter is the default, but you can choose any one or more of\n# the other formatters by passing with the `--format` (or `-f` for short)\n# command-line option, e.g.\n#\n#     rspec --format documentation\n#\n# You can also send the output of multiple formatters to different streams, e.g.\n#\n#     rspec --format documentation --format html --out results.html\n#\n# This example sends the output of the documentation formatter to `$stdout`, and\n# the output of the html formatter to results.html.\n#\n# ## Custom Formatters\n#\n# You can tell RSpec to use a custom formatter by passing its path and name to\n# the `rspec` command. For example, if you define MyCustomFormatter in\n# path/to/my_custom_formatter.rb, you would type this command:\n#\n#     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter\n#\n# The reporter calls every formatter with this protocol:\n#\n# * To start\n#   * `start(StartNotification)`\n# * Once per example group\n#   * `example_group_started(GroupNotification)`\n# * Once per example\n#   * `example_started(ExampleNotification)`\n# * One of these per example, depending on outcome\n#   * `example_passed(ExampleNotification)`\n#   * `example_failed(FailedExampleNotification)`\n#   * `example_pending(ExampleNotification)`\n# * Optionally at any time\n#   * `message(MessageNotification)`\n# * At the end of the suite\n#   * `stop(ExamplesNotification)`\n#   * `start_dump(NullNotification)`\n#   * `dump_pending(ExamplesNotification)`\n#   * `dump_failures(ExamplesNotification)`\n#   * `dump_summary(SummaryNotification)`\n#   * `seed(SeedNotification)`\n#   * `close(NullNotification)`\n#\n# Only the notifications to which you subscribe your formatter will be called\n# on your formatter. To subscribe your formatter use:\n# `RSpec::Core::Formatters#register` e.g.\n#\n# `RSpec::Core::Formatters.register FormatterClassName, :example_passed, :example_failed`\n#\n# We recommend you implement the methods yourself; for simplicity we provide the\n# default formatter output via our notification objects but if you prefer you\n# can subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the\n# methods you wish to enhance.\n#\n# @see RSpec::Core::Formatters::BaseTextFormatter\n# @see RSpec::Core::Reporter\nmodule RSpec::Core::Formatters\n  autoload :DocumentationFormatter,   'rspec/core/formatters/documentation_formatter'\n  autoload :HtmlFormatter,            'rspec/core/formatters/html_formatter'\n  autoload :FallbackMessageFormatter, 'rspec/core/formatters/fallback_message_formatter'\n  autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'\n  autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'\n  autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'\n  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'\n  autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'\n  autoload :FailureListFormatter,     'rspec/core/formatters/failure_list_formatter'\n\n  # Register the formatter class\n  # @param formatter_class [Class] formatter class to register\n  # @param notifications [Array<Symbol>] one or more notifications to be\n  #   registered to the specified formatter\n  #\n  # @see RSpec::Core::Formatters::BaseFormatter\n  def self.register(formatter_class, *notifications)\n    Loader.formatters[formatter_class] = notifications\n  end\n\n  # @api private\n  #\n  # `RSpec::Core::Formatters::Loader` is an internal class for\n  # managing formatters used by a particular configuration. It is\n  # not expected to be used directly, but only through the configuration\n  # interface.\n  class Loader\n    # @api private\n    #\n    # Internal formatters are stored here when loaded.\n    def self.formatters\n      @formatters ||= {}\n    end\n\n    # @api private\n    def initialize(reporter)\n      @formatters = []\n      @reporter = reporter\n      self.default_formatter = 'progress'\n    end\n\n    # @return [Array] the loaded formatters\n    attr_reader :formatters\n\n    # @return [Reporter] the reporter\n    attr_reader :reporter\n\n    # @return [String] the default formatter to setup, defaults to `progress`\n    attr_accessor :default_formatter\n\n    # @private\n    def prepare_default(output_stream, deprecation_stream)\n      reporter.prepare_default(self, output_stream, deprecation_stream)\n    end\n\n    # @private\n    def setup_default(output_stream, deprecation_stream)\n      add default_formatter, output_stream if @formatters.empty?\n\n      unless @formatters.any? { |formatter| DeprecationFormatter === formatter }\n        add DeprecationFormatter, deprecation_stream, output_stream\n      end\n\n      unless existing_formatter_implements?(:message)\n        add FallbackMessageFormatter, output_stream\n      end\n\n      return unless RSpec.configuration.profile_examples?\n      return if existing_formatter_implements?(:dump_profile)\n\n      add RSpec::Core::Formatters::ProfileFormatter, output_stream\n    end\n\n    # @private\n    def add(formatter_to_use, *paths)\n      # If a formatter instance was passed, we can register it directly,\n      # with no need for any of the further processing that happens below.\n      if Loader.formatters.key?(formatter_to_use.class)\n        register formatter_to_use, notifications_for(formatter_to_use.class)\n        return\n      end\n\n      formatter_class = find_formatter(formatter_to_use)\n\n      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }\n\n      if !Loader.formatters[formatter_class].nil?\n        formatter = formatter_class.new(*args)\n        register formatter, notifications_for(formatter_class)\n      elsif defined?(RSpec::LegacyFormatters)\n        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args\n        register formatter, formatter.notifications\n      else\n        call_site = \"Formatter added at: #{::RSpec::CallerFilter.first_non_rspec_line}\"\n\n        RSpec.warn_deprecation <<-WARNING.gsub(/\\s*\\|/, ' ')\n          |The #{formatter_class} formatter uses the deprecated formatter\n          |interface not supported directly by RSpec 3.\n          |\n          |To continue to use this formatter you must install the\n          |`rspec-legacy_formatters` gem, which provides support\n          |for legacy formatters or upgrade the formatter to a\n          |compatible version.\n          |\n          |#{call_site}\n        WARNING\n      end\n    end\n\n  private\n\n    def find_formatter(formatter_to_use)\n      built_in_formatter(formatter_to_use) ||\n      custom_formatter(formatter_to_use)   ||\n      (raise ArgumentError, \"Formatter '#{formatter_to_use}' unknown - \" \\\n                            \"maybe you meant 'documentation' or 'progress'?.\")\n    end\n\n    def register(formatter, notifications)\n      return if duplicate_formatter_exists?(formatter)\n      @reporter.register_listener formatter, *notifications\n      @formatters << formatter\n      formatter\n    end\n\n    def duplicate_formatter_exists?(new_formatter)\n      @formatters.any? do |formatter|\n        formatter.class == new_formatter.class &&\n          has_matching_output?(formatter, new_formatter)\n      end\n    end\n\n    def has_matching_output?(formatter, new_formatter)\n      return true unless formatter.respond_to?(:output) && new_formatter.respond_to?(:output)\n      formatter.output == new_formatter.output\n    end\n\n    def existing_formatter_implements?(notification)\n      @reporter.registered_listeners(notification).any?\n    end\n\n    def built_in_formatter(key)\n      case key.to_s\n      when 'd', 'doc', 'documentation'\n        DocumentationFormatter\n      when 'h', 'html'\n        HtmlFormatter\n      when 'p', 'progress'\n        ProgressFormatter\n      when 'j', 'json'\n        JsonFormatter\n      when 'bisect-drb'\n        BisectDRbFormatter\n      when 'f', 'failures'\n        FailureListFormatter\n      end\n    end\n\n    def notifications_for(formatter_class)\n      formatter_class.ancestors.inject(::RSpec::Core::Set.new) do |notifications, klass|\n        notifications.merge Loader.formatters.fetch(klass) { ::RSpec::Core::Set.new }\n      end\n    end\n\n    def custom_formatter(formatter_ref)\n      if Class === formatter_ref\n        formatter_ref\n      elsif string_const?(formatter_ref)\n        begin\n          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }\n        rescue NameError\n          require(path_for(formatter_ref)) ? retry : raise\n        end\n      end\n    end\n\n    def string_const?(str)\n      str.is_a?(String) && /\\A[A-Z][a-zA-Z0-9_:]*\\z/ =~ str\n    end\n\n    def path_for(const_ref)\n      underscore_with_fix_for_non_standard_rspec_naming(const_ref)\n    end\n\n    def underscore_with_fix_for_non_standard_rspec_naming(string)\n      underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\\\1rspec\\\\2')\n    end\n\n    # activesupport/lib/active_support/inflector/methods.rb, line 48\n    def underscore(camel_cased_word)\n      word = camel_cased_word.to_s.dup\n      word.gsub!(/::/, '/')\n      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')\n      word.gsub!(/([a-z\\d])([A-Z])/, '\\1_\\2')\n      word.tr!(\"-\", \"_\")\n      word.downcase!\n      word\n    end\n\n    def open_stream(path_or_wrapper)\n      if RSpec::Core::OutputWrapper === path_or_wrapper\n        path_or_wrapper.output = open_stream(path_or_wrapper.output)\n        path_or_wrapper\n      else\n        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path_or_wrapper))\n        File.new(path_or_wrapper, 'w')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "custom_formatter", "signature": "def custom_formatter(formatter_ref)", "start_line": 234, "end_line": 244}, "metadata": {"module": "RSpec", "class_name": "Loader", "class_signature": "class Loader"}, "task_id": 266}
{"function_name": "register", "file_path": "rspec-core/lib/rspec/core/hooks.rb", "focal_code": "def register(prepend_or_append, position, *args, &block)\n          scope, options = scope_and_options_from(*args)\n\n          if scope == :suite\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `#{position}(:suite)` hooks are only supported on \" \\\n                            \"the RSpec configuration object. This \" \\\n                            \"`#{position}(:suite)` hook, registered on an example \" \\\n                            \"group, will be ignored.\"\n            return\n          elsif scope == :context && position == :around\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `around(:context)` hooks are not supported and \" \\\n                            \"behave like `around(:example)`.\"\n          end\n\n          hook = HOOK_TYPES[position][scope].new(block, options)\n          ensure_hooks_initialized_for(position, scope).__send__(prepend_or_append, hook, options)\n        end", "file_content": "module RSpec\n  module Core\n    # Provides `before`, `after` and `around` hooks as a means of\n    # supporting common setup and teardown. This module is extended\n    # onto {ExampleGroup}, making the methods available from any `describe`\n    # or `context` block and included in {Configuration}, making them\n    # available off of the configuration object to define global setup\n    # or teardown logic.\n    module Hooks\n      # @api public\n      #\n      # @overload before(&block)\n      # @overload before(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      # @overload before(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload before(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #after\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run before each example (using `:example`)\n      # or once before any example (using `:context`). These are usually\n      # declared directly in the {ExampleGroup} to which they apply, but they\n      # can also be shared across multiple groups.\n      #\n      # You can also use `before(:suite)` to run a block of code before any\n      # example groups are run. This should be declared in {RSpec.configure}.\n      #\n      # Instance variables declared in `before(:example)` or `before(:context)`\n      # are accessible within each example.\n      #\n      # ### Order\n      #\n      # `before` hooks are stored in three scopes, which are run in order:\n      # `:suite`, `:context`, and `:example`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     before(:suite)    # Declared in RSpec.configure.\n      #     before(:context)  # Declared in RSpec.configure.\n      #     before(:context)  # Declared in a parent group.\n      #     before(:context)  # Declared in the current group.\n      #     before(:example)  # Declared in RSpec.configure.\n      #     before(:example)  # Declared in a parent group.\n      #     before(:example)  # Declared in the current group.\n      #\n      # If more than one `before` is declared within any one example group, they\n      # are run in the order in which they are declared. Any `around` hooks will\n      # execute after `before` context hooks but before any `before` example\n      # hook regardless of where they are declared.\n      #\n      # ### Conditions\n      #\n      # When you add a conditions hash to `before(:example)` or\n      # `before(:context)`, RSpec will only apply that hook to groups or\n      # examples that match the conditions. e.g.\n      #\n      #     RSpec.configure do |config|\n      #       config.before(:example, :authorized => true) do\n      #         log_in_as :authorized_user\n      #       end\n      #     end\n      #\n      #     RSpec.describe Something, :authorized => true do\n      #       # The before hook will run in before each example in this group.\n      #     end\n      #\n      #     RSpec.describe SomethingElse do\n      #       it \"does something\", :authorized => true do\n      #         # The before hook will run before this example.\n      #       end\n      #\n      #       it \"does something else\" do\n      #         # The hook will not run before this example.\n      #       end\n      #     end\n      #\n      # Note that filtered config `:context` hooks can still be applied\n      # to individual examples that have matching metadata. Just like\n      # Ruby's object model is that every object has a singleton class\n      # which has only a single instance, RSpec's model is that every\n      # example has a singleton example group containing just the one\n      # example.\n      #\n      # ### Warning: `before(:suite, :with => :conditions)`\n      #\n      # The conditions hash is used to match against specific examples. Since\n      # `before(:suite)` is not run in relation to any specific example or\n      # group, conditions passed along with `:suite` are effectively ignored.\n      #\n      # ### Exceptions\n      #\n      # When an exception is raised in a `before` block, RSpec skips any\n      # subsequent `before` blocks and the example, but runs all of the\n      # `after(:example)` and `after(:context)` hooks.\n      #\n      # ### Warning: implicit before blocks\n      #\n      # `before` hooks can also be declared in shared contexts which get\n      # included implicitly either by you or by extension libraries. Since\n      # RSpec runs these in the order in which they are declared within each\n      # scope, load order matters, and can lead to confusing results when one\n      # before block depends on state that is prepared in another before block\n      # that gets run later.\n      #\n      # ### Warning: `before(:context)`\n      #\n      # It is very tempting to use `before(:context)` to speed things up, but we\n      # recommend that you avoid this as there are a number of gotchas, as well\n      # as things that simply don't work.\n      #\n      # #### Context\n      #\n      # `before(:context)` is run in an example that is generated to provide\n      # group context for the block.\n      #\n      # #### Instance variables\n      #\n      # Instance variables declared in `before(:context)` are shared across all\n      # the examples in the group. This means that each example can change the\n      # state of a shared object, resulting in an ordering dependency that can\n      # make it difficult to reason about failures.\n      #\n      # #### Unsupported RSpec constructs\n      #\n      # RSpec has several constructs that reset state between each example\n      # automatically. These are not intended for use from within\n      # `before(:context)`:\n      #\n      #   * `let` declarations\n      #   * `subject` declarations\n      #   * Any mocking, stubbing or test double declaration\n      #\n      # ### other frameworks\n      #\n      # Mock object frameworks and database transaction managers (like\n      # ActiveRecord) are typically designed around the idea of setting up\n      # before an example, running that one example, and then tearing down. This\n      # means that mocks and stubs can (sometimes) be declared in\n      # `before(:context)`, but get torn down before the first real example is\n      # ever run.\n      #\n      # You _can_ create database-backed model objects in a `before(:context)`\n      # in rspec-rails, but it will not be wrapped in a transaction for you, so\n      # you are on your own to clean up in an `after(:context)` block.\n      #\n      # @example before(:example) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Thing do\n      #       before(:example) do\n      #         @thing = Thing.new\n      #       end\n      #\n      #       it \"does something\" do\n      #         # Here you can access @thing.\n      #       end\n      #     end\n      #\n      # @example before(:context) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Parser do\n      #       before(:context) do\n      #         File.open(file_to_parse, 'w') do |f|\n      #           f.write <<-CONTENT\n      #             stuff in the file\n      #           CONTENT\n      #         end\n      #       end\n      #\n      #       it \"parses the file\" do\n      #         Parser.parse(file_to_parse)\n      #       end\n      #\n      #       after(:context) do\n      #         File.delete(file_to_parse)\n      #       end\n      #     end\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def before(*args, &block)\n        hooks.register :append, :before, *args, &block\n      end\n\n      alias_method :append_before, :before\n\n      # Adds `block` to the front of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#before} for scoping semantics.\n      def prepend_before(*args, &block)\n        hooks.register :prepend, :before, *args, &block\n      end\n\n      # @api public\n      # @overload after(&block)\n      # @overload after(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      # @overload after(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload after(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #before\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run after each example (using `:example`)\n      # or once after all examples n the context (using `:context`). See\n      # {#before} for more information about ordering.\n      #\n      # ### Exceptions\n      #\n      # `after` hooks are guaranteed to run even when there are exceptions in\n      # `before` hooks or examples. When an exception is raised in an after\n      # block, the exception is captured for later reporting, and subsequent\n      # `after` blocks are run.\n      #\n      # ### Order\n      #\n      # `after` hooks are stored in three scopes, which are run in order:\n      # `:example`, `:context`, and `:suite`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     after(:example) # Declared in the current group.\n      #     after(:example) # Declared in a parent group.\n      #     after(:example) # Declared in RSpec.configure.\n      #     after(:context) # Declared in the current group.\n      #     after(:context) # Declared in a parent group.\n      #     after(:context) # Declared in RSpec.configure.\n      #     after(:suite)   # Declared in RSpec.configure.\n      #\n      # This is the reverse of the order in which `before` hooks are run.\n      # Similarly, if more than one `after` is declared within any example\n      # group, they are run in reverse order of that in which they are declared.\n      # Also `around` hooks will run after any `after` example hooks are\n      # invoked but before any `after` context hooks.\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def after(*args, &block)\n        hooks.register :prepend, :after, *args, &block\n      end\n\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the back of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#after} for scoping semantics.\n      def append_after(*args, &block)\n        hooks.register :append, :after, *args, &block\n      end\n\n      # @api public\n      # @overload around(&block)\n      # @overload around(scope, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      # @overload around(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `around(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload around(conditions, &block)\n      #   @param conditions [Hash] constrains this hook to examples matching\n      #     these conditions e.g. `around(:example, :ui => true) { ... }` will\n      #     only run with examples or groups declared with `:ui => true`.\n      #\n      # @yield [Example] the example to run\n      #\n      # @note the syntax of `around` is similar to that of `before` and `after`\n      #   but the semantics are quite different. `before` and `after` hooks are\n      #   run in the context of the examples with which they are associated,\n      #   whereas `around` hooks are actually responsible for running the\n      #   examples. Consequently, `around` hooks do not have direct access to\n      #   resources that are made available within the examples and their\n      #   associated `before` and `after` hooks.\n      #\n      # @note `:example`/`:each` is the only supported scope.\n      #\n      # Declare a block of code, parts of which will be run before and parts\n      # after the example. It is your responsibility to run the example:\n      #\n      #     around(:example) do |ex|\n      #       # Do some stuff before.\n      #       ex.run\n      #       # Do some stuff after.\n      #     end\n      #\n      # The yielded example aliases `run` with `call`, which lets you treat it\n      # like a `Proc`. This is especially handy when working with libraries\n      # that manage their own setup and teardown using a block or proc syntax,\n      # e.g.\n      #\n      #     around(:example) {|ex| Database.transaction(&ex)}\n      #     around(:example) {|ex| FakeFS(&ex)}\n      #\n      # ### Order\n      #\n      # The `around` hooks execute surrounding an example and its hooks.\n      #\n      # This means after any `before` context hooks, but before any `before`\n      # example hooks, and similarly after any `after` example hooks but before\n      # any `after` context hooks.\n      #\n      # They are not a synonym for `before`/`after`.\n      def around(*args, &block)\n        hooks.register :prepend, :around, *args, &block\n      end\n\n      # @private\n      # Holds the various registered hooks.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)\n      end\n\n      # @private\n      Hook = Struct.new(:block, :options)\n\n      # @private\n      class BeforeHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        end\n      end\n\n      # @private\n      class AfterHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          example.set_exception(ex)\n        end\n      end\n\n      # @private\n      class AfterContextHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e\n          RSpec.configuration.reporter.notify_non_example_exception(e, \"An error occurred in an `after(:context)` hook.\")\n        end\n      end\n\n      # @private\n      class AroundHook < Hook\n        def execute_with(example, procsy)\n          example.instance_exec(procsy, &block)\n          return if procsy.executed?\n          Pending.mark_skipped!(example,\n                                \"#{hook_description} did not execute the example\")\n        end\n\n        if Proc.method_defined?(:source_location)\n          def hook_description\n            \"around hook at #{Metadata.relative_path(block.source_location.join(':'))}\"\n          end\n        else # for 1.8.7\n          # :nocov:\n          def hook_description\n            \"around hook\"\n          end\n          # :nocov:\n        end\n      end\n\n      # @private\n      #\n      # This provides the primary API used by other parts of rspec-core. By hiding all\n      # implementation details behind this facade, it's allowed us to heavily optimize\n      # this, so that, for example, hook collection objects are only instantiated when\n      # a hook is added. This allows us to avoid many object allocations for the common\n      # case of a group having no hooks.\n      #\n      # This is only possible because this interface provides a \"tell, don't ask\"-style\n      # API, so that callers _tell_ this class what to do with the hooks, rather than\n      # asking this class for a list of hooks, and then doing something with them.\n      class HookCollections\n        def initialize(owner, filterable_item_repo_class)\n          @owner                      = owner\n          @filterable_item_repo_class = filterable_item_repo_class\n          @before_example_hooks       = nil\n          @after_example_hooks        = nil\n          @before_context_hooks       = nil\n          @after_context_hooks        = nil\n          @around_example_hooks       = nil\n        end\n\n        def register_globals(host, globals)\n          parent_groups = host.parent_groups\n\n          process(host, parent_groups, globals, :before, :example, &:options)\n          process(host, parent_groups, globals, :after,  :example, &:options)\n          process(host, parent_groups, globals, :around, :example, &:options)\n\n          process(host, parent_groups, globals, :before, :context, &:options)\n          process(host, parent_groups, globals, :after,  :context, &:options)\n        end\n\n        def register_global_singleton_context_hooks(example, globals)\n          parent_groups = example.example_group.parent_groups\n\n          process(example, parent_groups, globals, :before, :context) { {} }\n          process(example, parent_groups, globals, :after,  :context) { {} }\n        end\n\n        def register(prepend_or_append, position, *args, &block)\n          scope, options = scope_and_options_from(*args)\n\n          if scope == :suite\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `#{position}(:suite)` hooks are only supported on \" \\\n                            \"the RSpec configuration object. This \" \\\n                            \"`#{position}(:suite)` hook, registered on an example \" \\\n                            \"group, will be ignored.\"\n            return\n          elsif scope == :context && position == :around\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `around(:context)` hooks are not supported and \" \\\n                            \"behave like `around(:example)`.\"\n          end\n\n          hook = HOOK_TYPES[position][scope].new(block, options)\n          ensure_hooks_initialized_for(position, scope).__send__(prepend_or_append, hook, options)\n        end\n\n        # @private\n        #\n        # Runs all of the blocks stored with the hook in the context of the\n        # example. If no example is provided, just calls the hook directly.\n        def run(position, scope, example_or_group)\n          return if RSpec.configuration.dry_run?\n\n          if scope == :context\n            unless example_or_group.class.metadata[:skip]\n              run_owned_hooks_for(position, :context, example_or_group)\n            end\n          else\n            case position\n            when :before then run_example_hooks_for(example_or_group, :before, :reverse_each)\n            when :after  then run_example_hooks_for(example_or_group, :after,  :each)\n            when :around then run_around_example_hooks_for(example_or_group) { yield }\n            end\n          end\n        end\n\n        SCOPES = [:example, :context]\n\n        SCOPE_ALIASES = { :each => :example, :all => :context }\n\n        HOOK_TYPES = {\n          :before => Hash.new { BeforeHook },\n          :after  => Hash.new { AfterHook  },\n          :around => Hash.new { AroundHook }\n        }\n\n        HOOK_TYPES[:after][:context] = AfterContextHook\n\n      protected\n\n        EMPTY_HOOK_ARRAY = [].freeze\n\n        def matching_hooks_for(position, scope, example_or_group)\n          repository = hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }\n\n          # It would be nice to not have to switch on type here, but\n          # we don't want to define `ExampleGroup#metadata` because then\n          # `metadata` from within an individual example would return the\n          # group's metadata but the user would probably expect it to be\n          # the example's metadata.\n          metadata = case example_or_group\n                     when ExampleGroup then example_or_group.class.metadata\n                     else example_or_group.metadata\n                     end\n\n          repository.items_for(metadata)\n        end\n\n        def all_hooks_for(position, scope)\n          hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }.items_and_filters.map(&:first)\n        end\n\n        def run_owned_hooks_for(position, scope, example_or_group)\n          matching_hooks_for(position, scope, example_or_group).each do |hook|\n            hook.run(example_or_group)\n          end\n        end\n\n        def processable_hooks_for(position, scope, host)\n          if scope == :example\n            all_hooks_for(position, scope)\n          else\n            matching_hooks_for(position, scope, host)\n          end\n        end\n\n      private\n\n        def hooks_for(position, scope)\n          if position == :before\n            scope == :example ? @before_example_hooks : @before_context_hooks\n          elsif position == :after\n            scope == :example ? @after_example_hooks : @after_context_hooks\n          else # around\n            @around_example_hooks\n          end || yield\n        end\n\n        def ensure_hooks_initialized_for(position, scope)\n          if position == :before\n            if scope == :example\n              @before_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @before_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          elsif position == :after\n            if scope == :example\n              @after_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @after_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          else # around\n            @around_example_hooks ||= @filterable_item_repo_class.new(:all?)\n          end\n        end\n\n        def process(host, parent_groups, globals, position, scope)\n          hooks_to_process = globals.processable_hooks_for(position, scope, host)\n          return if hooks_to_process.empty?\n\n          hooks_to_process -= FlatMap.flat_map(parent_groups) do |group|\n            group.hooks.all_hooks_for(position, scope)\n          end\n          return if hooks_to_process.empty?\n\n          repository = ensure_hooks_initialized_for(position, scope)\n          hooks_to_process.each { |hook| repository.append hook, (yield hook) }\n        end\n\n        def scope_and_options_from(*args)\n          return :suite if args.first == :suite\n          scope = extract_scope_from(args)\n          meta  = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n          return scope, meta\n        end\n\n        def extract_scope_from(args)\n          if known_scope?(args.first)\n            normalized_scope_for(args.shift)\n          elsif args.any? { |a| a.is_a?(Symbol) }\n            error_message = \"You must explicitly give a scope \" \\\n              \"(#{SCOPES.join(\", \")}) or scope alias \" \\\n              \"(#{SCOPE_ALIASES.keys.join(\", \")}) when using symbols as \" \\\n              \"metadata for a hook.\"\n            raise ArgumentError.new error_message\n          else\n            :example\n          end\n        end\n\n        def known_scope?(scope)\n          SCOPES.include?(scope) || SCOPE_ALIASES.keys.include?(scope)\n        end\n\n        def normalized_scope_for(scope)\n          SCOPE_ALIASES[scope] || scope\n        end\n\n        def run_example_hooks_for(example, position, each_method)\n          owner_parent_groups.__send__(each_method) do |group|\n            group.hooks.run_owned_hooks_for(position, :example, example)\n          end\n        end\n\n        def run_around_example_hooks_for(example)\n          hooks = FlatMap.flat_map(owner_parent_groups) do |group|\n            group.hooks.matching_hooks_for(:around, :example, example)\n          end\n\n          return yield if hooks.empty? # exit early to avoid the extra allocation cost of `Example::Procsy`\n\n          initial_procsy = Example::Procsy.new(example) { yield }\n          hooks.inject(initial_procsy) do |procsy, around_hook|\n            procsy.wrap { around_hook.execute_with(example, procsy) }\n          end.call\n        end\n\n        if respond_to?(:singleton_class) && singleton_class.ancestors.include?(singleton_class)\n          def owner_parent_groups\n            @owner.parent_groups\n          end\n        else # Ruby < 2.1 (see https://bugs.ruby-lang.org/issues/8035)\n          # :nocov:\n          def owner_parent_groups\n            @owner_parent_groups ||= [@owner] + @owner.parent_groups\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "register", "signature": "def register(prepend_or_append, position, *args, &block)", "start_line": 449, "end_line": 469}, "metadata": {"module": "RSpec", "class_name": "HookCollections", "class_signature": "class HookCollections"}, "task_id": 267}
{"function_name": "ensure_hooks_initialized_for", "file_path": "rspec-core/lib/rspec/core/hooks.rb", "focal_code": "def ensure_hooks_initialized_for(position, scope)\n          if position == :before\n            if scope == :example\n              @before_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @before_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          elsif position == :after\n            if scope == :example\n              @after_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @after_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          else # around\n            @around_example_hooks ||= @filterable_item_repo_class.new(:all?)\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # Provides `before`, `after` and `around` hooks as a means of\n    # supporting common setup and teardown. This module is extended\n    # onto {ExampleGroup}, making the methods available from any `describe`\n    # or `context` block and included in {Configuration}, making them\n    # available off of the configuration object to define global setup\n    # or teardown logic.\n    module Hooks\n      # @api public\n      #\n      # @overload before(&block)\n      # @overload before(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      # @overload before(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload before(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #after\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run before each example (using `:example`)\n      # or once before any example (using `:context`). These are usually\n      # declared directly in the {ExampleGroup} to which they apply, but they\n      # can also be shared across multiple groups.\n      #\n      # You can also use `before(:suite)` to run a block of code before any\n      # example groups are run. This should be declared in {RSpec.configure}.\n      #\n      # Instance variables declared in `before(:example)` or `before(:context)`\n      # are accessible within each example.\n      #\n      # ### Order\n      #\n      # `before` hooks are stored in three scopes, which are run in order:\n      # `:suite`, `:context`, and `:example`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     before(:suite)    # Declared in RSpec.configure.\n      #     before(:context)  # Declared in RSpec.configure.\n      #     before(:context)  # Declared in a parent group.\n      #     before(:context)  # Declared in the current group.\n      #     before(:example)  # Declared in RSpec.configure.\n      #     before(:example)  # Declared in a parent group.\n      #     before(:example)  # Declared in the current group.\n      #\n      # If more than one `before` is declared within any one example group, they\n      # are run in the order in which they are declared. Any `around` hooks will\n      # execute after `before` context hooks but before any `before` example\n      # hook regardless of where they are declared.\n      #\n      # ### Conditions\n      #\n      # When you add a conditions hash to `before(:example)` or\n      # `before(:context)`, RSpec will only apply that hook to groups or\n      # examples that match the conditions. e.g.\n      #\n      #     RSpec.configure do |config|\n      #       config.before(:example, :authorized => true) do\n      #         log_in_as :authorized_user\n      #       end\n      #     end\n      #\n      #     RSpec.describe Something, :authorized => true do\n      #       # The before hook will run in before each example in this group.\n      #     end\n      #\n      #     RSpec.describe SomethingElse do\n      #       it \"does something\", :authorized => true do\n      #         # The before hook will run before this example.\n      #       end\n      #\n      #       it \"does something else\" do\n      #         # The hook will not run before this example.\n      #       end\n      #     end\n      #\n      # Note that filtered config `:context` hooks can still be applied\n      # to individual examples that have matching metadata. Just like\n      # Ruby's object model is that every object has a singleton class\n      # which has only a single instance, RSpec's model is that every\n      # example has a singleton example group containing just the one\n      # example.\n      #\n      # ### Warning: `before(:suite, :with => :conditions)`\n      #\n      # The conditions hash is used to match against specific examples. Since\n      # `before(:suite)` is not run in relation to any specific example or\n      # group, conditions passed along with `:suite` are effectively ignored.\n      #\n      # ### Exceptions\n      #\n      # When an exception is raised in a `before` block, RSpec skips any\n      # subsequent `before` blocks and the example, but runs all of the\n      # `after(:example)` and `after(:context)` hooks.\n      #\n      # ### Warning: implicit before blocks\n      #\n      # `before` hooks can also be declared in shared contexts which get\n      # included implicitly either by you or by extension libraries. Since\n      # RSpec runs these in the order in which they are declared within each\n      # scope, load order matters, and can lead to confusing results when one\n      # before block depends on state that is prepared in another before block\n      # that gets run later.\n      #\n      # ### Warning: `before(:context)`\n      #\n      # It is very tempting to use `before(:context)` to speed things up, but we\n      # recommend that you avoid this as there are a number of gotchas, as well\n      # as things that simply don't work.\n      #\n      # #### Context\n      #\n      # `before(:context)` is run in an example that is generated to provide\n      # group context for the block.\n      #\n      # #### Instance variables\n      #\n      # Instance variables declared in `before(:context)` are shared across all\n      # the examples in the group. This means that each example can change the\n      # state of a shared object, resulting in an ordering dependency that can\n      # make it difficult to reason about failures.\n      #\n      # #### Unsupported RSpec constructs\n      #\n      # RSpec has several constructs that reset state between each example\n      # automatically. These are not intended for use from within\n      # `before(:context)`:\n      #\n      #   * `let` declarations\n      #   * `subject` declarations\n      #   * Any mocking, stubbing or test double declaration\n      #\n      # ### other frameworks\n      #\n      # Mock object frameworks and database transaction managers (like\n      # ActiveRecord) are typically designed around the idea of setting up\n      # before an example, running that one example, and then tearing down. This\n      # means that mocks and stubs can (sometimes) be declared in\n      # `before(:context)`, but get torn down before the first real example is\n      # ever run.\n      #\n      # You _can_ create database-backed model objects in a `before(:context)`\n      # in rspec-rails, but it will not be wrapped in a transaction for you, so\n      # you are on your own to clean up in an `after(:context)` block.\n      #\n      # @example before(:example) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Thing do\n      #       before(:example) do\n      #         @thing = Thing.new\n      #       end\n      #\n      #       it \"does something\" do\n      #         # Here you can access @thing.\n      #       end\n      #     end\n      #\n      # @example before(:context) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Parser do\n      #       before(:context) do\n      #         File.open(file_to_parse, 'w') do |f|\n      #           f.write <<-CONTENT\n      #             stuff in the file\n      #           CONTENT\n      #         end\n      #       end\n      #\n      #       it \"parses the file\" do\n      #         Parser.parse(file_to_parse)\n      #       end\n      #\n      #       after(:context) do\n      #         File.delete(file_to_parse)\n      #       end\n      #     end\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def before(*args, &block)\n        hooks.register :append, :before, *args, &block\n      end\n\n      alias_method :append_before, :before\n\n      # Adds `block` to the front of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#before} for scoping semantics.\n      def prepend_before(*args, &block)\n        hooks.register :prepend, :before, *args, &block\n      end\n\n      # @api public\n      # @overload after(&block)\n      # @overload after(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      # @overload after(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload after(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #before\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run after each example (using `:example`)\n      # or once after all examples n the context (using `:context`). See\n      # {#before} for more information about ordering.\n      #\n      # ### Exceptions\n      #\n      # `after` hooks are guaranteed to run even when there are exceptions in\n      # `before` hooks or examples. When an exception is raised in an after\n      # block, the exception is captured for later reporting, and subsequent\n      # `after` blocks are run.\n      #\n      # ### Order\n      #\n      # `after` hooks are stored in three scopes, which are run in order:\n      # `:example`, `:context`, and `:suite`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     after(:example) # Declared in the current group.\n      #     after(:example) # Declared in a parent group.\n      #     after(:example) # Declared in RSpec.configure.\n      #     after(:context) # Declared in the current group.\n      #     after(:context) # Declared in a parent group.\n      #     after(:context) # Declared in RSpec.configure.\n      #     after(:suite)   # Declared in RSpec.configure.\n      #\n      # This is the reverse of the order in which `before` hooks are run.\n      # Similarly, if more than one `after` is declared within any example\n      # group, they are run in reverse order of that in which they are declared.\n      # Also `around` hooks will run after any `after` example hooks are\n      # invoked but before any `after` context hooks.\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def after(*args, &block)\n        hooks.register :prepend, :after, *args, &block\n      end\n\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the back of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#after} for scoping semantics.\n      def append_after(*args, &block)\n        hooks.register :append, :after, *args, &block\n      end\n\n      # @api public\n      # @overload around(&block)\n      # @overload around(scope, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      # @overload around(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `around(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload around(conditions, &block)\n      #   @param conditions [Hash] constrains this hook to examples matching\n      #     these conditions e.g. `around(:example, :ui => true) { ... }` will\n      #     only run with examples or groups declared with `:ui => true`.\n      #\n      # @yield [Example] the example to run\n      #\n      # @note the syntax of `around` is similar to that of `before` and `after`\n      #   but the semantics are quite different. `before` and `after` hooks are\n      #   run in the context of the examples with which they are associated,\n      #   whereas `around` hooks are actually responsible for running the\n      #   examples. Consequently, `around` hooks do not have direct access to\n      #   resources that are made available within the examples and their\n      #   associated `before` and `after` hooks.\n      #\n      # @note `:example`/`:each` is the only supported scope.\n      #\n      # Declare a block of code, parts of which will be run before and parts\n      # after the example. It is your responsibility to run the example:\n      #\n      #     around(:example) do |ex|\n      #       # Do some stuff before.\n      #       ex.run\n      #       # Do some stuff after.\n      #     end\n      #\n      # The yielded example aliases `run` with `call`, which lets you treat it\n      # like a `Proc`. This is especially handy when working with libraries\n      # that manage their own setup and teardown using a block or proc syntax,\n      # e.g.\n      #\n      #     around(:example) {|ex| Database.transaction(&ex)}\n      #     around(:example) {|ex| FakeFS(&ex)}\n      #\n      # ### Order\n      #\n      # The `around` hooks execute surrounding an example and its hooks.\n      #\n      # This means after any `before` context hooks, but before any `before`\n      # example hooks, and similarly after any `after` example hooks but before\n      # any `after` context hooks.\n      #\n      # They are not a synonym for `before`/`after`.\n      def around(*args, &block)\n        hooks.register :prepend, :around, *args, &block\n      end\n\n      # @private\n      # Holds the various registered hooks.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)\n      end\n\n      # @private\n      Hook = Struct.new(:block, :options)\n\n      # @private\n      class BeforeHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        end\n      end\n\n      # @private\n      class AfterHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          example.set_exception(ex)\n        end\n      end\n\n      # @private\n      class AfterContextHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e\n          RSpec.configuration.reporter.notify_non_example_exception(e, \"An error occurred in an `after(:context)` hook.\")\n        end\n      end\n\n      # @private\n      class AroundHook < Hook\n        def execute_with(example, procsy)\n          example.instance_exec(procsy, &block)\n          return if procsy.executed?\n          Pending.mark_skipped!(example,\n                                \"#{hook_description} did not execute the example\")\n        end\n\n        if Proc.method_defined?(:source_location)\n          def hook_description\n            \"around hook at #{Metadata.relative_path(block.source_location.join(':'))}\"\n          end\n        else # for 1.8.7\n          # :nocov:\n          def hook_description\n            \"around hook\"\n          end\n          # :nocov:\n        end\n      end\n\n      # @private\n      #\n      # This provides the primary API used by other parts of rspec-core. By hiding all\n      # implementation details behind this facade, it's allowed us to heavily optimize\n      # this, so that, for example, hook collection objects are only instantiated when\n      # a hook is added. This allows us to avoid many object allocations for the common\n      # case of a group having no hooks.\n      #\n      # This is only possible because this interface provides a \"tell, don't ask\"-style\n      # API, so that callers _tell_ this class what to do with the hooks, rather than\n      # asking this class for a list of hooks, and then doing something with them.\n      class HookCollections\n        def initialize(owner, filterable_item_repo_class)\n          @owner                      = owner\n          @filterable_item_repo_class = filterable_item_repo_class\n          @before_example_hooks       = nil\n          @after_example_hooks        = nil\n          @before_context_hooks       = nil\n          @after_context_hooks        = nil\n          @around_example_hooks       = nil\n        end\n\n        def register_globals(host, globals)\n          parent_groups = host.parent_groups\n\n          process(host, parent_groups, globals, :before, :example, &:options)\n          process(host, parent_groups, globals, :after,  :example, &:options)\n          process(host, parent_groups, globals, :around, :example, &:options)\n\n          process(host, parent_groups, globals, :before, :context, &:options)\n          process(host, parent_groups, globals, :after,  :context, &:options)\n        end\n\n        def register_global_singleton_context_hooks(example, globals)\n          parent_groups = example.example_group.parent_groups\n\n          process(example, parent_groups, globals, :before, :context) { {} }\n          process(example, parent_groups, globals, :after,  :context) { {} }\n        end\n\n        def register(prepend_or_append, position, *args, &block)\n          scope, options = scope_and_options_from(*args)\n\n          if scope == :suite\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `#{position}(:suite)` hooks are only supported on \" \\\n                            \"the RSpec configuration object. This \" \\\n                            \"`#{position}(:suite)` hook, registered on an example \" \\\n                            \"group, will be ignored.\"\n            return\n          elsif scope == :context && position == :around\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `around(:context)` hooks are not supported and \" \\\n                            \"behave like `around(:example)`.\"\n          end\n\n          hook = HOOK_TYPES[position][scope].new(block, options)\n          ensure_hooks_initialized_for(position, scope).__send__(prepend_or_append, hook, options)\n        end\n\n        # @private\n        #\n        # Runs all of the blocks stored with the hook in the context of the\n        # example. If no example is provided, just calls the hook directly.\n        def run(position, scope, example_or_group)\n          return if RSpec.configuration.dry_run?\n\n          if scope == :context\n            unless example_or_group.class.metadata[:skip]\n              run_owned_hooks_for(position, :context, example_or_group)\n            end\n          else\n            case position\n            when :before then run_example_hooks_for(example_or_group, :before, :reverse_each)\n            when :after  then run_example_hooks_for(example_or_group, :after,  :each)\n            when :around then run_around_example_hooks_for(example_or_group) { yield }\n            end\n          end\n        end\n\n        SCOPES = [:example, :context]\n\n        SCOPE_ALIASES = { :each => :example, :all => :context }\n\n        HOOK_TYPES = {\n          :before => Hash.new { BeforeHook },\n          :after  => Hash.new { AfterHook  },\n          :around => Hash.new { AroundHook }\n        }\n\n        HOOK_TYPES[:after][:context] = AfterContextHook\n\n      protected\n\n        EMPTY_HOOK_ARRAY = [].freeze\n\n        def matching_hooks_for(position, scope, example_or_group)\n          repository = hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }\n\n          # It would be nice to not have to switch on type here, but\n          # we don't want to define `ExampleGroup#metadata` because then\n          # `metadata` from within an individual example would return the\n          # group's metadata but the user would probably expect it to be\n          # the example's metadata.\n          metadata = case example_or_group\n                     when ExampleGroup then example_or_group.class.metadata\n                     else example_or_group.metadata\n                     end\n\n          repository.items_for(metadata)\n        end\n\n        def all_hooks_for(position, scope)\n          hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }.items_and_filters.map(&:first)\n        end\n\n        def run_owned_hooks_for(position, scope, example_or_group)\n          matching_hooks_for(position, scope, example_or_group).each do |hook|\n            hook.run(example_or_group)\n          end\n        end\n\n        def processable_hooks_for(position, scope, host)\n          if scope == :example\n            all_hooks_for(position, scope)\n          else\n            matching_hooks_for(position, scope, host)\n          end\n        end\n\n      private\n\n        def hooks_for(position, scope)\n          if position == :before\n            scope == :example ? @before_example_hooks : @before_context_hooks\n          elsif position == :after\n            scope == :example ? @after_example_hooks : @after_context_hooks\n          else # around\n            @around_example_hooks\n          end || yield\n        end\n\n        def ensure_hooks_initialized_for(position, scope)\n          if position == :before\n            if scope == :example\n              @before_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @before_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          elsif position == :after\n            if scope == :example\n              @after_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @after_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          else # around\n            @around_example_hooks ||= @filterable_item_repo_class.new(:all?)\n          end\n        end\n\n        def process(host, parent_groups, globals, position, scope)\n          hooks_to_process = globals.processable_hooks_for(position, scope, host)\n          return if hooks_to_process.empty?\n\n          hooks_to_process -= FlatMap.flat_map(parent_groups) do |group|\n            group.hooks.all_hooks_for(position, scope)\n          end\n          return if hooks_to_process.empty?\n\n          repository = ensure_hooks_initialized_for(position, scope)\n          hooks_to_process.each { |hook| repository.append hook, (yield hook) }\n        end\n\n        def scope_and_options_from(*args)\n          return :suite if args.first == :suite\n          scope = extract_scope_from(args)\n          meta  = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n          return scope, meta\n        end\n\n        def extract_scope_from(args)\n          if known_scope?(args.first)\n            normalized_scope_for(args.shift)\n          elsif args.any? { |a| a.is_a?(Symbol) }\n            error_message = \"You must explicitly give a scope \" \\\n              \"(#{SCOPES.join(\", \")}) or scope alias \" \\\n              \"(#{SCOPE_ALIASES.keys.join(\", \")}) when using symbols as \" \\\n              \"metadata for a hook.\"\n            raise ArgumentError.new error_message\n          else\n            :example\n          end\n        end\n\n        def known_scope?(scope)\n          SCOPES.include?(scope) || SCOPE_ALIASES.keys.include?(scope)\n        end\n\n        def normalized_scope_for(scope)\n          SCOPE_ALIASES[scope] || scope\n        end\n\n        def run_example_hooks_for(example, position, each_method)\n          owner_parent_groups.__send__(each_method) do |group|\n            group.hooks.run_owned_hooks_for(position, :example, example)\n          end\n        end\n\n        def run_around_example_hooks_for(example)\n          hooks = FlatMap.flat_map(owner_parent_groups) do |group|\n            group.hooks.matching_hooks_for(:around, :example, example)\n          end\n\n          return yield if hooks.empty? # exit early to avoid the extra allocation cost of `Example::Procsy`\n\n          initial_procsy = Example::Procsy.new(example) { yield }\n          hooks.inject(initial_procsy) do |procsy, around_hook|\n            procsy.wrap { around_hook.execute_with(example, procsy) }\n          end.call\n        end\n\n        if respond_to?(:singleton_class) && singleton_class.ancestors.include?(singleton_class)\n          def owner_parent_groups\n            @owner.parent_groups\n          end\n        else # Ruby < 2.1 (see https://bugs.ruby-lang.org/issues/8035)\n          # :nocov:\n          def owner_parent_groups\n            @owner_parent_groups ||= [@owner] + @owner.parent_groups\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "ensure_hooks_initialized_for", "signature": "def ensure_hooks_initialized_for(position, scope)", "start_line": 553, "end_line": 569}, "metadata": {"module": "RSpec", "class_name": "HookCollections", "class_signature": "class HookCollections"}, "task_id": 268}
{"function_name": "process", "file_path": "rspec-core/lib/rspec/core/hooks.rb", "focal_code": "def process(host, parent_groups, globals, position, scope)\n          hooks_to_process = globals.processable_hooks_for(position, scope, host)\n          return if hooks_to_process.empty?\n\n          hooks_to_process -= FlatMap.flat_map(parent_groups) do |group|\n            group.hooks.all_hooks_for(position, scope)\n          end\n          return if hooks_to_process.empty?\n\n          repository = ensure_hooks_initialized_for(position, scope)\n          hooks_to_process.each { |hook| repository.append hook, (yield hook) }\n        end", "file_content": "module RSpec\n  module Core\n    # Provides `before`, `after` and `around` hooks as a means of\n    # supporting common setup and teardown. This module is extended\n    # onto {ExampleGroup}, making the methods available from any `describe`\n    # or `context` block and included in {Configuration}, making them\n    # available off of the configuration object to define global setup\n    # or teardown logic.\n    module Hooks\n      # @api public\n      #\n      # @overload before(&block)\n      # @overload before(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      # @overload before(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload before(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #after\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run before each example (using `:example`)\n      # or once before any example (using `:context`). These are usually\n      # declared directly in the {ExampleGroup} to which they apply, but they\n      # can also be shared across multiple groups.\n      #\n      # You can also use `before(:suite)` to run a block of code before any\n      # example groups are run. This should be declared in {RSpec.configure}.\n      #\n      # Instance variables declared in `before(:example)` or `before(:context)`\n      # are accessible within each example.\n      #\n      # ### Order\n      #\n      # `before` hooks are stored in three scopes, which are run in order:\n      # `:suite`, `:context`, and `:example`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     before(:suite)    # Declared in RSpec.configure.\n      #     before(:context)  # Declared in RSpec.configure.\n      #     before(:context)  # Declared in a parent group.\n      #     before(:context)  # Declared in the current group.\n      #     before(:example)  # Declared in RSpec.configure.\n      #     before(:example)  # Declared in a parent group.\n      #     before(:example)  # Declared in the current group.\n      #\n      # If more than one `before` is declared within any one example group, they\n      # are run in the order in which they are declared. Any `around` hooks will\n      # execute after `before` context hooks but before any `before` example\n      # hook regardless of where they are declared.\n      #\n      # ### Conditions\n      #\n      # When you add a conditions hash to `before(:example)` or\n      # `before(:context)`, RSpec will only apply that hook to groups or\n      # examples that match the conditions. e.g.\n      #\n      #     RSpec.configure do |config|\n      #       config.before(:example, :authorized => true) do\n      #         log_in_as :authorized_user\n      #       end\n      #     end\n      #\n      #     RSpec.describe Something, :authorized => true do\n      #       # The before hook will run in before each example in this group.\n      #     end\n      #\n      #     RSpec.describe SomethingElse do\n      #       it \"does something\", :authorized => true do\n      #         # The before hook will run before this example.\n      #       end\n      #\n      #       it \"does something else\" do\n      #         # The hook will not run before this example.\n      #       end\n      #     end\n      #\n      # Note that filtered config `:context` hooks can still be applied\n      # to individual examples that have matching metadata. Just like\n      # Ruby's object model is that every object has a singleton class\n      # which has only a single instance, RSpec's model is that every\n      # example has a singleton example group containing just the one\n      # example.\n      #\n      # ### Warning: `before(:suite, :with => :conditions)`\n      #\n      # The conditions hash is used to match against specific examples. Since\n      # `before(:suite)` is not run in relation to any specific example or\n      # group, conditions passed along with `:suite` are effectively ignored.\n      #\n      # ### Exceptions\n      #\n      # When an exception is raised in a `before` block, RSpec skips any\n      # subsequent `before` blocks and the example, but runs all of the\n      # `after(:example)` and `after(:context)` hooks.\n      #\n      # ### Warning: implicit before blocks\n      #\n      # `before` hooks can also be declared in shared contexts which get\n      # included implicitly either by you or by extension libraries. Since\n      # RSpec runs these in the order in which they are declared within each\n      # scope, load order matters, and can lead to confusing results when one\n      # before block depends on state that is prepared in another before block\n      # that gets run later.\n      #\n      # ### Warning: `before(:context)`\n      #\n      # It is very tempting to use `before(:context)` to speed things up, but we\n      # recommend that you avoid this as there are a number of gotchas, as well\n      # as things that simply don't work.\n      #\n      # #### Context\n      #\n      # `before(:context)` is run in an example that is generated to provide\n      # group context for the block.\n      #\n      # #### Instance variables\n      #\n      # Instance variables declared in `before(:context)` are shared across all\n      # the examples in the group. This means that each example can change the\n      # state of a shared object, resulting in an ordering dependency that can\n      # make it difficult to reason about failures.\n      #\n      # #### Unsupported RSpec constructs\n      #\n      # RSpec has several constructs that reset state between each example\n      # automatically. These are not intended for use from within\n      # `before(:context)`:\n      #\n      #   * `let` declarations\n      #   * `subject` declarations\n      #   * Any mocking, stubbing or test double declaration\n      #\n      # ### other frameworks\n      #\n      # Mock object frameworks and database transaction managers (like\n      # ActiveRecord) are typically designed around the idea of setting up\n      # before an example, running that one example, and then tearing down. This\n      # means that mocks and stubs can (sometimes) be declared in\n      # `before(:context)`, but get torn down before the first real example is\n      # ever run.\n      #\n      # You _can_ create database-backed model objects in a `before(:context)`\n      # in rspec-rails, but it will not be wrapped in a transaction for you, so\n      # you are on your own to clean up in an `after(:context)` block.\n      #\n      # @example before(:example) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Thing do\n      #       before(:example) do\n      #         @thing = Thing.new\n      #       end\n      #\n      #       it \"does something\" do\n      #         # Here you can access @thing.\n      #       end\n      #     end\n      #\n      # @example before(:context) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Parser do\n      #       before(:context) do\n      #         File.open(file_to_parse, 'w') do |f|\n      #           f.write <<-CONTENT\n      #             stuff in the file\n      #           CONTENT\n      #         end\n      #       end\n      #\n      #       it \"parses the file\" do\n      #         Parser.parse(file_to_parse)\n      #       end\n      #\n      #       after(:context) do\n      #         File.delete(file_to_parse)\n      #       end\n      #     end\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def before(*args, &block)\n        hooks.register :append, :before, *args, &block\n      end\n\n      alias_method :append_before, :before\n\n      # Adds `block` to the front of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#before} for scoping semantics.\n      def prepend_before(*args, &block)\n        hooks.register :prepend, :before, *args, &block\n      end\n\n      # @api public\n      # @overload after(&block)\n      # @overload after(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      # @overload after(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload after(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #before\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run after each example (using `:example`)\n      # or once after all examples n the context (using `:context`). See\n      # {#before} for more information about ordering.\n      #\n      # ### Exceptions\n      #\n      # `after` hooks are guaranteed to run even when there are exceptions in\n      # `before` hooks or examples. When an exception is raised in an after\n      # block, the exception is captured for later reporting, and subsequent\n      # `after` blocks are run.\n      #\n      # ### Order\n      #\n      # `after` hooks are stored in three scopes, which are run in order:\n      # `:example`, `:context`, and `:suite`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     after(:example) # Declared in the current group.\n      #     after(:example) # Declared in a parent group.\n      #     after(:example) # Declared in RSpec.configure.\n      #     after(:context) # Declared in the current group.\n      #     after(:context) # Declared in a parent group.\n      #     after(:context) # Declared in RSpec.configure.\n      #     after(:suite)   # Declared in RSpec.configure.\n      #\n      # This is the reverse of the order in which `before` hooks are run.\n      # Similarly, if more than one `after` is declared within any example\n      # group, they are run in reverse order of that in which they are declared.\n      # Also `around` hooks will run after any `after` example hooks are\n      # invoked but before any `after` context hooks.\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def after(*args, &block)\n        hooks.register :prepend, :after, *args, &block\n      end\n\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the back of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#after} for scoping semantics.\n      def append_after(*args, &block)\n        hooks.register :append, :after, *args, &block\n      end\n\n      # @api public\n      # @overload around(&block)\n      # @overload around(scope, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      # @overload around(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `around(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload around(conditions, &block)\n      #   @param conditions [Hash] constrains this hook to examples matching\n      #     these conditions e.g. `around(:example, :ui => true) { ... }` will\n      #     only run with examples or groups declared with `:ui => true`.\n      #\n      # @yield [Example] the example to run\n      #\n      # @note the syntax of `around` is similar to that of `before` and `after`\n      #   but the semantics are quite different. `before` and `after` hooks are\n      #   run in the context of the examples with which they are associated,\n      #   whereas `around` hooks are actually responsible for running the\n      #   examples. Consequently, `around` hooks do not have direct access to\n      #   resources that are made available within the examples and their\n      #   associated `before` and `after` hooks.\n      #\n      # @note `:example`/`:each` is the only supported scope.\n      #\n      # Declare a block of code, parts of which will be run before and parts\n      # after the example. It is your responsibility to run the example:\n      #\n      #     around(:example) do |ex|\n      #       # Do some stuff before.\n      #       ex.run\n      #       # Do some stuff after.\n      #     end\n      #\n      # The yielded example aliases `run` with `call`, which lets you treat it\n      # like a `Proc`. This is especially handy when working with libraries\n      # that manage their own setup and teardown using a block or proc syntax,\n      # e.g.\n      #\n      #     around(:example) {|ex| Database.transaction(&ex)}\n      #     around(:example) {|ex| FakeFS(&ex)}\n      #\n      # ### Order\n      #\n      # The `around` hooks execute surrounding an example and its hooks.\n      #\n      # This means after any `before` context hooks, but before any `before`\n      # example hooks, and similarly after any `after` example hooks but before\n      # any `after` context hooks.\n      #\n      # They are not a synonym for `before`/`after`.\n      def around(*args, &block)\n        hooks.register :prepend, :around, *args, &block\n      end\n\n      # @private\n      # Holds the various registered hooks.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)\n      end\n\n      # @private\n      Hook = Struct.new(:block, :options)\n\n      # @private\n      class BeforeHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        end\n      end\n\n      # @private\n      class AfterHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          example.set_exception(ex)\n        end\n      end\n\n      # @private\n      class AfterContextHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e\n          RSpec.configuration.reporter.notify_non_example_exception(e, \"An error occurred in an `after(:context)` hook.\")\n        end\n      end\n\n      # @private\n      class AroundHook < Hook\n        def execute_with(example, procsy)\n          example.instance_exec(procsy, &block)\n          return if procsy.executed?\n          Pending.mark_skipped!(example,\n                                \"#{hook_description} did not execute the example\")\n        end\n\n        if Proc.method_defined?(:source_location)\n          def hook_description\n            \"around hook at #{Metadata.relative_path(block.source_location.join(':'))}\"\n          end\n        else # for 1.8.7\n          # :nocov:\n          def hook_description\n            \"around hook\"\n          end\n          # :nocov:\n        end\n      end\n\n      # @private\n      #\n      # This provides the primary API used by other parts of rspec-core. By hiding all\n      # implementation details behind this facade, it's allowed us to heavily optimize\n      # this, so that, for example, hook collection objects are only instantiated when\n      # a hook is added. This allows us to avoid many object allocations for the common\n      # case of a group having no hooks.\n      #\n      # This is only possible because this interface provides a \"tell, don't ask\"-style\n      # API, so that callers _tell_ this class what to do with the hooks, rather than\n      # asking this class for a list of hooks, and then doing something with them.\n      class HookCollections\n        def initialize(owner, filterable_item_repo_class)\n          @owner                      = owner\n          @filterable_item_repo_class = filterable_item_repo_class\n          @before_example_hooks       = nil\n          @after_example_hooks        = nil\n          @before_context_hooks       = nil\n          @after_context_hooks        = nil\n          @around_example_hooks       = nil\n        end\n\n        def register_globals(host, globals)\n          parent_groups = host.parent_groups\n\n          process(host, parent_groups, globals, :before, :example, &:options)\n          process(host, parent_groups, globals, :after,  :example, &:options)\n          process(host, parent_groups, globals, :around, :example, &:options)\n\n          process(host, parent_groups, globals, :before, :context, &:options)\n          process(host, parent_groups, globals, :after,  :context, &:options)\n        end\n\n        def register_global_singleton_context_hooks(example, globals)\n          parent_groups = example.example_group.parent_groups\n\n          process(example, parent_groups, globals, :before, :context) { {} }\n          process(example, parent_groups, globals, :after,  :context) { {} }\n        end\n\n        def register(prepend_or_append, position, *args, &block)\n          scope, options = scope_and_options_from(*args)\n\n          if scope == :suite\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `#{position}(:suite)` hooks are only supported on \" \\\n                            \"the RSpec configuration object. This \" \\\n                            \"`#{position}(:suite)` hook, registered on an example \" \\\n                            \"group, will be ignored.\"\n            return\n          elsif scope == :context && position == :around\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `around(:context)` hooks are not supported and \" \\\n                            \"behave like `around(:example)`.\"\n          end\n\n          hook = HOOK_TYPES[position][scope].new(block, options)\n          ensure_hooks_initialized_for(position, scope).__send__(prepend_or_append, hook, options)\n        end\n\n        # @private\n        #\n        # Runs all of the blocks stored with the hook in the context of the\n        # example. If no example is provided, just calls the hook directly.\n        def run(position, scope, example_or_group)\n          return if RSpec.configuration.dry_run?\n\n          if scope == :context\n            unless example_or_group.class.metadata[:skip]\n              run_owned_hooks_for(position, :context, example_or_group)\n            end\n          else\n            case position\n            when :before then run_example_hooks_for(example_or_group, :before, :reverse_each)\n            when :after  then run_example_hooks_for(example_or_group, :after,  :each)\n            when :around then run_around_example_hooks_for(example_or_group) { yield }\n            end\n          end\n        end\n\n        SCOPES = [:example, :context]\n\n        SCOPE_ALIASES = { :each => :example, :all => :context }\n\n        HOOK_TYPES = {\n          :before => Hash.new { BeforeHook },\n          :after  => Hash.new { AfterHook  },\n          :around => Hash.new { AroundHook }\n        }\n\n        HOOK_TYPES[:after][:context] = AfterContextHook\n\n      protected\n\n        EMPTY_HOOK_ARRAY = [].freeze\n\n        def matching_hooks_for(position, scope, example_or_group)\n          repository = hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }\n\n          # It would be nice to not have to switch on type here, but\n          # we don't want to define `ExampleGroup#metadata` because then\n          # `metadata` from within an individual example would return the\n          # group's metadata but the user would probably expect it to be\n          # the example's metadata.\n          metadata = case example_or_group\n                     when ExampleGroup then example_or_group.class.metadata\n                     else example_or_group.metadata\n                     end\n\n          repository.items_for(metadata)\n        end\n\n        def all_hooks_for(position, scope)\n          hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }.items_and_filters.map(&:first)\n        end\n\n        def run_owned_hooks_for(position, scope, example_or_group)\n          matching_hooks_for(position, scope, example_or_group).each do |hook|\n            hook.run(example_or_group)\n          end\n        end\n\n        def processable_hooks_for(position, scope, host)\n          if scope == :example\n            all_hooks_for(position, scope)\n          else\n            matching_hooks_for(position, scope, host)\n          end\n        end\n\n      private\n\n        def hooks_for(position, scope)\n          if position == :before\n            scope == :example ? @before_example_hooks : @before_context_hooks\n          elsif position == :after\n            scope == :example ? @after_example_hooks : @after_context_hooks\n          else # around\n            @around_example_hooks\n          end || yield\n        end\n\n        def ensure_hooks_initialized_for(position, scope)\n          if position == :before\n            if scope == :example\n              @before_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @before_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          elsif position == :after\n            if scope == :example\n              @after_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @after_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          else # around\n            @around_example_hooks ||= @filterable_item_repo_class.new(:all?)\n          end\n        end\n\n        def process(host, parent_groups, globals, position, scope)\n          hooks_to_process = globals.processable_hooks_for(position, scope, host)\n          return if hooks_to_process.empty?\n\n          hooks_to_process -= FlatMap.flat_map(parent_groups) do |group|\n            group.hooks.all_hooks_for(position, scope)\n          end\n          return if hooks_to_process.empty?\n\n          repository = ensure_hooks_initialized_for(position, scope)\n          hooks_to_process.each { |hook| repository.append hook, (yield hook) }\n        end\n\n        def scope_and_options_from(*args)\n          return :suite if args.first == :suite\n          scope = extract_scope_from(args)\n          meta  = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n          return scope, meta\n        end\n\n        def extract_scope_from(args)\n          if known_scope?(args.first)\n            normalized_scope_for(args.shift)\n          elsif args.any? { |a| a.is_a?(Symbol) }\n            error_message = \"You must explicitly give a scope \" \\\n              \"(#{SCOPES.join(\", \")}) or scope alias \" \\\n              \"(#{SCOPE_ALIASES.keys.join(\", \")}) when using symbols as \" \\\n              \"metadata for a hook.\"\n            raise ArgumentError.new error_message\n          else\n            :example\n          end\n        end\n\n        def known_scope?(scope)\n          SCOPES.include?(scope) || SCOPE_ALIASES.keys.include?(scope)\n        end\n\n        def normalized_scope_for(scope)\n          SCOPE_ALIASES[scope] || scope\n        end\n\n        def run_example_hooks_for(example, position, each_method)\n          owner_parent_groups.__send__(each_method) do |group|\n            group.hooks.run_owned_hooks_for(position, :example, example)\n          end\n        end\n\n        def run_around_example_hooks_for(example)\n          hooks = FlatMap.flat_map(owner_parent_groups) do |group|\n            group.hooks.matching_hooks_for(:around, :example, example)\n          end\n\n          return yield if hooks.empty? # exit early to avoid the extra allocation cost of `Example::Procsy`\n\n          initial_procsy = Example::Procsy.new(example) { yield }\n          hooks.inject(initial_procsy) do |procsy, around_hook|\n            procsy.wrap { around_hook.execute_with(example, procsy) }\n          end.call\n        end\n\n        if respond_to?(:singleton_class) && singleton_class.ancestors.include?(singleton_class)\n          def owner_parent_groups\n            @owner.parent_groups\n          end\n        else # Ruby < 2.1 (see https://bugs.ruby-lang.org/issues/8035)\n          # :nocov:\n          def owner_parent_groups\n            @owner_parent_groups ||= [@owner] + @owner.parent_groups\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "process", "signature": "def process(host, parent_groups, globals, position, scope)", "start_line": 571, "end_line": 582}, "metadata": {"module": "RSpec", "class_name": "HookCollections", "class_signature": "class HookCollections"}, "task_id": 269}
{"function_name": "extract_scope_from", "file_path": "rspec-core/lib/rspec/core/hooks.rb", "focal_code": "def extract_scope_from(args)\n          if known_scope?(args.first)\n            normalized_scope_for(args.shift)\n          elsif args.any? { |a| a.is_a?(Symbol) }\n            error_message = \"You must explicitly give a scope \" \\\n              \"(#{SCOPES.join(\", \")}) or scope alias \" \\\n              \"(#{SCOPE_ALIASES.keys.join(\", \")}) when using symbols as \" \\\n              \"metadata for a hook.\"\n            raise ArgumentError.new error_message\n          else\n            :example\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # Provides `before`, `after` and `around` hooks as a means of\n    # supporting common setup and teardown. This module is extended\n    # onto {ExampleGroup}, making the methods available from any `describe`\n    # or `context` block and included in {Configuration}, making them\n    # available off of the configuration object to define global setup\n    # or teardown logic.\n    module Hooks\n      # @api public\n      #\n      # @overload before(&block)\n      # @overload before(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      # @overload before(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite`\n      #     (defaults to `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload before(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `before(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #after\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run before each example (using `:example`)\n      # or once before any example (using `:context`). These are usually\n      # declared directly in the {ExampleGroup} to which they apply, but they\n      # can also be shared across multiple groups.\n      #\n      # You can also use `before(:suite)` to run a block of code before any\n      # example groups are run. This should be declared in {RSpec.configure}.\n      #\n      # Instance variables declared in `before(:example)` or `before(:context)`\n      # are accessible within each example.\n      #\n      # ### Order\n      #\n      # `before` hooks are stored in three scopes, which are run in order:\n      # `:suite`, `:context`, and `:example`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     before(:suite)    # Declared in RSpec.configure.\n      #     before(:context)  # Declared in RSpec.configure.\n      #     before(:context)  # Declared in a parent group.\n      #     before(:context)  # Declared in the current group.\n      #     before(:example)  # Declared in RSpec.configure.\n      #     before(:example)  # Declared in a parent group.\n      #     before(:example)  # Declared in the current group.\n      #\n      # If more than one `before` is declared within any one example group, they\n      # are run in the order in which they are declared. Any `around` hooks will\n      # execute after `before` context hooks but before any `before` example\n      # hook regardless of where they are declared.\n      #\n      # ### Conditions\n      #\n      # When you add a conditions hash to `before(:example)` or\n      # `before(:context)`, RSpec will only apply that hook to groups or\n      # examples that match the conditions. e.g.\n      #\n      #     RSpec.configure do |config|\n      #       config.before(:example, :authorized => true) do\n      #         log_in_as :authorized_user\n      #       end\n      #     end\n      #\n      #     RSpec.describe Something, :authorized => true do\n      #       # The before hook will run in before each example in this group.\n      #     end\n      #\n      #     RSpec.describe SomethingElse do\n      #       it \"does something\", :authorized => true do\n      #         # The before hook will run before this example.\n      #       end\n      #\n      #       it \"does something else\" do\n      #         # The hook will not run before this example.\n      #       end\n      #     end\n      #\n      # Note that filtered config `:context` hooks can still be applied\n      # to individual examples that have matching metadata. Just like\n      # Ruby's object model is that every object has a singleton class\n      # which has only a single instance, RSpec's model is that every\n      # example has a singleton example group containing just the one\n      # example.\n      #\n      # ### Warning: `before(:suite, :with => :conditions)`\n      #\n      # The conditions hash is used to match against specific examples. Since\n      # `before(:suite)` is not run in relation to any specific example or\n      # group, conditions passed along with `:suite` are effectively ignored.\n      #\n      # ### Exceptions\n      #\n      # When an exception is raised in a `before` block, RSpec skips any\n      # subsequent `before` blocks and the example, but runs all of the\n      # `after(:example)` and `after(:context)` hooks.\n      #\n      # ### Warning: implicit before blocks\n      #\n      # `before` hooks can also be declared in shared contexts which get\n      # included implicitly either by you or by extension libraries. Since\n      # RSpec runs these in the order in which they are declared within each\n      # scope, load order matters, and can lead to confusing results when one\n      # before block depends on state that is prepared in another before block\n      # that gets run later.\n      #\n      # ### Warning: `before(:context)`\n      #\n      # It is very tempting to use `before(:context)` to speed things up, but we\n      # recommend that you avoid this as there are a number of gotchas, as well\n      # as things that simply don't work.\n      #\n      # #### Context\n      #\n      # `before(:context)` is run in an example that is generated to provide\n      # group context for the block.\n      #\n      # #### Instance variables\n      #\n      # Instance variables declared in `before(:context)` are shared across all\n      # the examples in the group. This means that each example can change the\n      # state of a shared object, resulting in an ordering dependency that can\n      # make it difficult to reason about failures.\n      #\n      # #### Unsupported RSpec constructs\n      #\n      # RSpec has several constructs that reset state between each example\n      # automatically. These are not intended for use from within\n      # `before(:context)`:\n      #\n      #   * `let` declarations\n      #   * `subject` declarations\n      #   * Any mocking, stubbing or test double declaration\n      #\n      # ### other frameworks\n      #\n      # Mock object frameworks and database transaction managers (like\n      # ActiveRecord) are typically designed around the idea of setting up\n      # before an example, running that one example, and then tearing down. This\n      # means that mocks and stubs can (sometimes) be declared in\n      # `before(:context)`, but get torn down before the first real example is\n      # ever run.\n      #\n      # You _can_ create database-backed model objects in a `before(:context)`\n      # in rspec-rails, but it will not be wrapped in a transaction for you, so\n      # you are on your own to clean up in an `after(:context)` block.\n      #\n      # @example before(:example) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Thing do\n      #       before(:example) do\n      #         @thing = Thing.new\n      #       end\n      #\n      #       it \"does something\" do\n      #         # Here you can access @thing.\n      #       end\n      #     end\n      #\n      # @example before(:context) declared in an {ExampleGroup}\n      #\n      #     RSpec.describe Parser do\n      #       before(:context) do\n      #         File.open(file_to_parse, 'w') do |f|\n      #           f.write <<-CONTENT\n      #             stuff in the file\n      #           CONTENT\n      #         end\n      #       end\n      #\n      #       it \"parses the file\" do\n      #         Parser.parse(file_to_parse)\n      #       end\n      #\n      #       after(:context) do\n      #         File.delete(file_to_parse)\n      #       end\n      #     end\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def before(*args, &block)\n        hooks.register :append, :before, *args, &block\n      end\n\n      alias_method :append_before, :before\n\n      # Adds `block` to the front of the list of `before` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#before} for scoping semantics.\n      def prepend_before(*args, &block)\n        hooks.register :prepend, :before, *args, &block\n      end\n\n      # @api public\n      # @overload after(&block)\n      # @overload after(scope, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      # @overload after(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example`, `:context`, or `:suite` (defaults to\n      #     `:example`)\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload after(conditions, &block)\n      #   @param conditions [Hash]\n      #     constrains this hook to examples matching these conditions e.g.\n      #     `after(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`.\n      #\n      # @see #before\n      # @see #around\n      # @see ExampleGroup\n      # @see SharedContext\n      # @see SharedExampleGroup\n      # @see Configuration\n      #\n      # Declare a block of code to be run after each example (using `:example`)\n      # or once after all examples n the context (using `:context`). See\n      # {#before} for more information about ordering.\n      #\n      # ### Exceptions\n      #\n      # `after` hooks are guaranteed to run even when there are exceptions in\n      # `before` hooks or examples. When an exception is raised in an after\n      # block, the exception is captured for later reporting, and subsequent\n      # `after` blocks are run.\n      #\n      # ### Order\n      #\n      # `after` hooks are stored in three scopes, which are run in order:\n      # `:example`, `:context`, and `:suite`. They can also be declared in\n      # several different places: `RSpec.configure`, a parent group, the current\n      # group. They are run in the following order:\n      #\n      #     after(:example) # Declared in the current group.\n      #     after(:example) # Declared in a parent group.\n      #     after(:example) # Declared in RSpec.configure.\n      #     after(:context) # Declared in the current group.\n      #     after(:context) # Declared in a parent group.\n      #     after(:context) # Declared in RSpec.configure.\n      #     after(:suite)   # Declared in RSpec.configure.\n      #\n      # This is the reverse of the order in which `before` hooks are run.\n      # Similarly, if more than one `after` is declared within any example\n      # group, they are run in reverse order of that in which they are declared.\n      # Also `around` hooks will run after any `after` example hooks are\n      # invoked but before any `after` context hooks.\n      #\n      # @note The `:example` and `:context` scopes are also available as\n      #       `:each` and `:all`, respectively. Use whichever you prefer.\n      # @note The `:suite` scope is only supported for hooks registered on\n      #       `RSpec.configuration` since they exist independently of any\n      #       example or example group.\n      def after(*args, &block)\n        hooks.register :prepend, :after, *args, &block\n      end\n\n      alias_method :prepend_after, :after\n\n      # Adds `block` to the back of the list of `after` blocks in the same\n      # scope (`:example`, `:context`, or `:suite`).\n      #\n      # See {#after} for scoping semantics.\n      def append_after(*args, &block)\n        hooks.register :append, :after, *args, &block\n      end\n\n      # @api public\n      # @overload around(&block)\n      # @overload around(scope, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      # @overload around(scope, *conditions, &block)\n      #   @param scope [Symbol] `:example` (defaults to `:example`)\n      #     present for syntax parity with `before` and `after`, but\n      #     `:example`/`:each` is the only supported value.\n      #   @param conditions [Array<Symbol>, Hash] constrains this hook to\n      #     examples matching these conditions e.g.\n      #     `around(:example, :ui => true) { ... }` will only run with examples\n      #     or groups declared with `:ui => true`. Symbols will be transformed\n      #     into hash entries with `true` values.\n      # @overload around(conditions, &block)\n      #   @param conditions [Hash] constrains this hook to examples matching\n      #     these conditions e.g. `around(:example, :ui => true) { ... }` will\n      #     only run with examples or groups declared with `:ui => true`.\n      #\n      # @yield [Example] the example to run\n      #\n      # @note the syntax of `around` is similar to that of `before` and `after`\n      #   but the semantics are quite different. `before` and `after` hooks are\n      #   run in the context of the examples with which they are associated,\n      #   whereas `around` hooks are actually responsible for running the\n      #   examples. Consequently, `around` hooks do not have direct access to\n      #   resources that are made available within the examples and their\n      #   associated `before` and `after` hooks.\n      #\n      # @note `:example`/`:each` is the only supported scope.\n      #\n      # Declare a block of code, parts of which will be run before and parts\n      # after the example. It is your responsibility to run the example:\n      #\n      #     around(:example) do |ex|\n      #       # Do some stuff before.\n      #       ex.run\n      #       # Do some stuff after.\n      #     end\n      #\n      # The yielded example aliases `run` with `call`, which lets you treat it\n      # like a `Proc`. This is especially handy when working with libraries\n      # that manage their own setup and teardown using a block or proc syntax,\n      # e.g.\n      #\n      #     around(:example) {|ex| Database.transaction(&ex)}\n      #     around(:example) {|ex| FakeFS(&ex)}\n      #\n      # ### Order\n      #\n      # The `around` hooks execute surrounding an example and its hooks.\n      #\n      # This means after any `before` context hooks, but before any `before`\n      # example hooks, and similarly after any `after` example hooks but before\n      # any `after` context hooks.\n      #\n      # They are not a synonym for `before`/`after`.\n      def around(*args, &block)\n        hooks.register :prepend, :around, *args, &block\n      end\n\n      # @private\n      # Holds the various registered hooks.\n      def hooks\n        @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)\n      end\n\n      # @private\n      Hook = Struct.new(:block, :options)\n\n      # @private\n      class BeforeHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        end\n      end\n\n      # @private\n      class AfterHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex\n          example.set_exception(ex)\n        end\n      end\n\n      # @private\n      class AfterContextHook < Hook\n        def run(example)\n          example.instance_exec(example, &block)\n        rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e\n          RSpec.configuration.reporter.notify_non_example_exception(e, \"An error occurred in an `after(:context)` hook.\")\n        end\n      end\n\n      # @private\n      class AroundHook < Hook\n        def execute_with(example, procsy)\n          example.instance_exec(procsy, &block)\n          return if procsy.executed?\n          Pending.mark_skipped!(example,\n                                \"#{hook_description} did not execute the example\")\n        end\n\n        if Proc.method_defined?(:source_location)\n          def hook_description\n            \"around hook at #{Metadata.relative_path(block.source_location.join(':'))}\"\n          end\n        else # for 1.8.7\n          # :nocov:\n          def hook_description\n            \"around hook\"\n          end\n          # :nocov:\n        end\n      end\n\n      # @private\n      #\n      # This provides the primary API used by other parts of rspec-core. By hiding all\n      # implementation details behind this facade, it's allowed us to heavily optimize\n      # this, so that, for example, hook collection objects are only instantiated when\n      # a hook is added. This allows us to avoid many object allocations for the common\n      # case of a group having no hooks.\n      #\n      # This is only possible because this interface provides a \"tell, don't ask\"-style\n      # API, so that callers _tell_ this class what to do with the hooks, rather than\n      # asking this class for a list of hooks, and then doing something with them.\n      class HookCollections\n        def initialize(owner, filterable_item_repo_class)\n          @owner                      = owner\n          @filterable_item_repo_class = filterable_item_repo_class\n          @before_example_hooks       = nil\n          @after_example_hooks        = nil\n          @before_context_hooks       = nil\n          @after_context_hooks        = nil\n          @around_example_hooks       = nil\n        end\n\n        def register_globals(host, globals)\n          parent_groups = host.parent_groups\n\n          process(host, parent_groups, globals, :before, :example, &:options)\n          process(host, parent_groups, globals, :after,  :example, &:options)\n          process(host, parent_groups, globals, :around, :example, &:options)\n\n          process(host, parent_groups, globals, :before, :context, &:options)\n          process(host, parent_groups, globals, :after,  :context, &:options)\n        end\n\n        def register_global_singleton_context_hooks(example, globals)\n          parent_groups = example.example_group.parent_groups\n\n          process(example, parent_groups, globals, :before, :context) { {} }\n          process(example, parent_groups, globals, :after,  :context) { {} }\n        end\n\n        def register(prepend_or_append, position, *args, &block)\n          scope, options = scope_and_options_from(*args)\n\n          if scope == :suite\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `#{position}(:suite)` hooks are only supported on \" \\\n                            \"the RSpec configuration object. This \" \\\n                            \"`#{position}(:suite)` hook, registered on an example \" \\\n                            \"group, will be ignored.\"\n            return\n          elsif scope == :context && position == :around\n            # TODO: consider making this an error in RSpec 4. For SemVer reasons,\n            # we are only warning in RSpec 3.\n            RSpec.warn_with \"WARNING: `around(:context)` hooks are not supported and \" \\\n                            \"behave like `around(:example)`.\"\n          end\n\n          hook = HOOK_TYPES[position][scope].new(block, options)\n          ensure_hooks_initialized_for(position, scope).__send__(prepend_or_append, hook, options)\n        end\n\n        # @private\n        #\n        # Runs all of the blocks stored with the hook in the context of the\n        # example. If no example is provided, just calls the hook directly.\n        def run(position, scope, example_or_group)\n          return if RSpec.configuration.dry_run?\n\n          if scope == :context\n            unless example_or_group.class.metadata[:skip]\n              run_owned_hooks_for(position, :context, example_or_group)\n            end\n          else\n            case position\n            when :before then run_example_hooks_for(example_or_group, :before, :reverse_each)\n            when :after  then run_example_hooks_for(example_or_group, :after,  :each)\n            when :around then run_around_example_hooks_for(example_or_group) { yield }\n            end\n          end\n        end\n\n        SCOPES = [:example, :context]\n\n        SCOPE_ALIASES = { :each => :example, :all => :context }\n\n        HOOK_TYPES = {\n          :before => Hash.new { BeforeHook },\n          :after  => Hash.new { AfterHook  },\n          :around => Hash.new { AroundHook }\n        }\n\n        HOOK_TYPES[:after][:context] = AfterContextHook\n\n      protected\n\n        EMPTY_HOOK_ARRAY = [].freeze\n\n        def matching_hooks_for(position, scope, example_or_group)\n          repository = hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }\n\n          # It would be nice to not have to switch on type here, but\n          # we don't want to define `ExampleGroup#metadata` because then\n          # `metadata` from within an individual example would return the\n          # group's metadata but the user would probably expect it to be\n          # the example's metadata.\n          metadata = case example_or_group\n                     when ExampleGroup then example_or_group.class.metadata\n                     else example_or_group.metadata\n                     end\n\n          repository.items_for(metadata)\n        end\n\n        def all_hooks_for(position, scope)\n          hooks_for(position, scope) { return EMPTY_HOOK_ARRAY }.items_and_filters.map(&:first)\n        end\n\n        def run_owned_hooks_for(position, scope, example_or_group)\n          matching_hooks_for(position, scope, example_or_group).each do |hook|\n            hook.run(example_or_group)\n          end\n        end\n\n        def processable_hooks_for(position, scope, host)\n          if scope == :example\n            all_hooks_for(position, scope)\n          else\n            matching_hooks_for(position, scope, host)\n          end\n        end\n\n      private\n\n        def hooks_for(position, scope)\n          if position == :before\n            scope == :example ? @before_example_hooks : @before_context_hooks\n          elsif position == :after\n            scope == :example ? @after_example_hooks : @after_context_hooks\n          else # around\n            @around_example_hooks\n          end || yield\n        end\n\n        def ensure_hooks_initialized_for(position, scope)\n          if position == :before\n            if scope == :example\n              @before_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @before_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          elsif position == :after\n            if scope == :example\n              @after_example_hooks ||= @filterable_item_repo_class.new(:all?)\n            else\n              @after_context_hooks ||= @filterable_item_repo_class.new(:all?)\n            end\n          else # around\n            @around_example_hooks ||= @filterable_item_repo_class.new(:all?)\n          end\n        end\n\n        def process(host, parent_groups, globals, position, scope)\n          hooks_to_process = globals.processable_hooks_for(position, scope, host)\n          return if hooks_to_process.empty?\n\n          hooks_to_process -= FlatMap.flat_map(parent_groups) do |group|\n            group.hooks.all_hooks_for(position, scope)\n          end\n          return if hooks_to_process.empty?\n\n          repository = ensure_hooks_initialized_for(position, scope)\n          hooks_to_process.each { |hook| repository.append hook, (yield hook) }\n        end\n\n        def scope_and_options_from(*args)\n          return :suite if args.first == :suite\n          scope = extract_scope_from(args)\n          meta  = Metadata.build_hash_from(args, :warn_about_example_group_filtering)\n          return scope, meta\n        end\n\n        def extract_scope_from(args)\n          if known_scope?(args.first)\n            normalized_scope_for(args.shift)\n          elsif args.any? { |a| a.is_a?(Symbol) }\n            error_message = \"You must explicitly give a scope \" \\\n              \"(#{SCOPES.join(\", \")}) or scope alias \" \\\n              \"(#{SCOPE_ALIASES.keys.join(\", \")}) when using symbols as \" \\\n              \"metadata for a hook.\"\n            raise ArgumentError.new error_message\n          else\n            :example\n          end\n        end\n\n        def known_scope?(scope)\n          SCOPES.include?(scope) || SCOPE_ALIASES.keys.include?(scope)\n        end\n\n        def normalized_scope_for(scope)\n          SCOPE_ALIASES[scope] || scope\n        end\n\n        def run_example_hooks_for(example, position, each_method)\n          owner_parent_groups.__send__(each_method) do |group|\n            group.hooks.run_owned_hooks_for(position, :example, example)\n          end\n        end\n\n        def run_around_example_hooks_for(example)\n          hooks = FlatMap.flat_map(owner_parent_groups) do |group|\n            group.hooks.matching_hooks_for(:around, :example, example)\n          end\n\n          return yield if hooks.empty? # exit early to avoid the extra allocation cost of `Example::Procsy`\n\n          initial_procsy = Example::Procsy.new(example) { yield }\n          hooks.inject(initial_procsy) do |procsy, around_hook|\n            procsy.wrap { around_hook.execute_with(example, procsy) }\n          end.call\n        end\n\n        if respond_to?(:singleton_class) && singleton_class.ancestors.include?(singleton_class)\n          def owner_parent_groups\n            @owner.parent_groups\n          end\n        else # Ruby < 2.1 (see https://bugs.ruby-lang.org/issues/8035)\n          # :nocov:\n          def owner_parent_groups\n            @owner_parent_groups ||= [@owner] + @owner.parent_groups\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "extract_scope_from", "signature": "def extract_scope_from(args)", "start_line": 591, "end_line": 603}, "metadata": {"module": "RSpec", "class_name": "HookCollections", "class_signature": "class HookCollections"}, "task_id": 270}
{"function_name": "call", "file_path": "rspec-core/lib/rspec/core/invocations.rb", "focal_code": "def call(options, err, out)\n          RSpec::Support.require_rspec_core \"bisect/coordinator\"\n          runner = Runner.new(options).tap { |r| r.configure(err, out) }\n          formatter = bisect_formatter_klass_for(options.options[:bisect]).new(\n            out, runner.configuration.bisect_runner\n          )\n\n          success = RSpec::Core::Bisect::Coordinator.bisect_with(\n            runner, options.args, formatter\n          )\n\n          runner.exit_code(success)\n        end", "file_content": "module RSpec\n  module Core\n    # @private\n    module Invocations\n      # @private\n      class InitializeProject\n        def call(*_args)\n          RSpec::Support.require_rspec_core \"project_initializer\"\n          ProjectInitializer.new.run\n          0\n        end\n      end\n\n      # @private\n      class DRbWithFallback\n        def call(options, err, out)\n          require 'rspec/core/drb'\n          begin\n            return DRbRunner.new(options).run(err, out)\n          rescue DRb::DRbConnError\n            err.puts \"No DRb server is running. Running in local process instead ...\"\n          end\n          RSpec::Core::Runner.new(options).run(err, out)\n        end\n      end\n\n      # @private\n      class Bisect\n        def call(options, err, out)\n          RSpec::Support.require_rspec_core \"bisect/coordinator\"\n          runner = Runner.new(options).tap { |r| r.configure(err, out) }\n          formatter = bisect_formatter_klass_for(options.options[:bisect]).new(\n            out, runner.configuration.bisect_runner\n          )\n\n          success = RSpec::Core::Bisect::Coordinator.bisect_with(\n            runner, options.args, formatter\n          )\n\n          runner.exit_code(success)\n        end\n\n      private\n\n        def bisect_formatter_klass_for(argument)\n          return Formatters::BisectDebugFormatter if argument == \"verbose\"\n          Formatters::BisectProgressFormatter\n        end\n      end\n\n      # @private\n      class PrintVersion\n        def call(_options, _err, out)\n          overall_version = RSpec::Core::Version::STRING\n          unless overall_version =~ /[a-zA-Z]+/\n            overall_version = overall_version.split('.').first(2).join('.')\n          end\n\n          out.puts \"RSpec #{overall_version}\"\n\n          [:Core, :Expectations, :Mocks, :Rails, :Support].each do |const_name|\n            lib_name = const_name.to_s.downcase\n            begin\n              require \"rspec/#{lib_name}/version\"\n            rescue LoadError\n              # Not worth mentioning libs that are not installed\n              nil\n            else\n              out.puts \"  - rspec-#{lib_name} #{RSpec.const_get(const_name)::Version::STRING}\"\n            end\n          end\n\n          0\n        end\n      end\n\n      # @private\n      PrintHelp = Struct.new(:parser, :hidden_options) do\n        def call(_options, _err, out)\n          # Removing the hidden options from the output.\n          out.puts parser.to_s.gsub(/^\\s+(#{hidden_options.join('|')})\\b.*$\\n/, '')\n          0\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(options, err, out)", "start_line": 29, "end_line": 41}, "metadata": {"module": "RSpec", "class_name": "Bisect", "class_signature": "class Bisect"}, "task_id": 271}
{"function_name": "call", "file_path": "rspec-core/lib/rspec/core/invocations.rb", "focal_code": "def call(_options, _err, out)\n          overall_version = RSpec::Core::Version::STRING\n          unless overall_version =~ /[a-zA-Z]+/\n            overall_version = overall_version.split('.').first(2).join('.')\n          end\n\n          out.puts \"RSpec #{overall_version}\"\n\n          [:Core, :Expectations, :Mocks, :Rails, :Support].each do |const_name|\n            lib_name = const_name.to_s.downcase\n            begin\n              require \"rspec/#{lib_name}/version\"\n            rescue LoadError\n              # Not worth mentioning libs that are not installed\n              nil\n            else\n              out.puts \"  - rspec-#{lib_name} #{RSpec.const_get(const_name)::Version::STRING}\"\n            end\n          end\n\n          0\n        end", "file_content": "module RSpec\n  module Core\n    # @private\n    module Invocations\n      # @private\n      class InitializeProject\n        def call(*_args)\n          RSpec::Support.require_rspec_core \"project_initializer\"\n          ProjectInitializer.new.run\n          0\n        end\n      end\n\n      # @private\n      class DRbWithFallback\n        def call(options, err, out)\n          require 'rspec/core/drb'\n          begin\n            return DRbRunner.new(options).run(err, out)\n          rescue DRb::DRbConnError\n            err.puts \"No DRb server is running. Running in local process instead ...\"\n          end\n          RSpec::Core::Runner.new(options).run(err, out)\n        end\n      end\n\n      # @private\n      class Bisect\n        def call(options, err, out)\n          RSpec::Support.require_rspec_core \"bisect/coordinator\"\n          runner = Runner.new(options).tap { |r| r.configure(err, out) }\n          formatter = bisect_formatter_klass_for(options.options[:bisect]).new(\n            out, runner.configuration.bisect_runner\n          )\n\n          success = RSpec::Core::Bisect::Coordinator.bisect_with(\n            runner, options.args, formatter\n          )\n\n          runner.exit_code(success)\n        end\n\n      private\n\n        def bisect_formatter_klass_for(argument)\n          return Formatters::BisectDebugFormatter if argument == \"verbose\"\n          Formatters::BisectProgressFormatter\n        end\n      end\n\n      # @private\n      class PrintVersion\n        def call(_options, _err, out)\n          overall_version = RSpec::Core::Version::STRING\n          unless overall_version =~ /[a-zA-Z]+/\n            overall_version = overall_version.split('.').first(2).join('.')\n          end\n\n          out.puts \"RSpec #{overall_version}\"\n\n          [:Core, :Expectations, :Mocks, :Rails, :Support].each do |const_name|\n            lib_name = const_name.to_s.downcase\n            begin\n              require \"rspec/#{lib_name}/version\"\n            rescue LoadError\n              # Not worth mentioning libs that are not installed\n              nil\n            else\n              out.puts \"  - rspec-#{lib_name} #{RSpec.const_get(const_name)::Version::STRING}\"\n            end\n          end\n\n          0\n        end\n      end\n\n      # @private\n      PrintHelp = Struct.new(:parser, :hidden_options) do\n        def call(_options, _err, out)\n          # Removing the hidden options from the output.\n          out.puts parser.to_s.gsub(/^\\s+(#{hidden_options.join('|')})\\b.*$\\n/, '')\n          0\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "call", "signature": "def call(_options, _err, out)", "start_line": 53, "end_line": 74}, "metadata": {"module": "RSpec", "class_name": "PrintVersion", "class_signature": "class PrintVersion"}, "task_id": 272}
{"function_name": "enforce_value_expectation", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "enforce_value_expectation", "signature": "def enforce_value_expectation(matcher, method_name)", "start_line": 150, "end_line": 161}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 273}
{"function_name": "isolate_for_context_hook", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "isolate_for_context_hook", "signature": "def self.isolate_for_context_hook(example_group_instance)", "start_line": 201, "end_line": 220}, "metadata": {"module": "RSpec", "class_name": "ContextHookMemoized", "class_signature": "class ContextHookMemoized"}, "task_id": 274}
{"function_name": "fetch_or_store", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "fetch_or_store", "signature": "def self.fetch_or_store(key, &_block)", "start_line": 222, "end_line": 238}, "metadata": {"module": "RSpec", "class_name": "ContextHookMemoized", "class_signature": "class ContextHookMemoized"}, "task_id": 275}
{"function_name": "let", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "let", "signature": "def let(name, &block)", "start_line": 306, "end_line": 345}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 276}
{"function_name": "subject", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "subject", "signature": "def subject(name=nil, &block)", "start_line": 444, "end_line": 455}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 277}
{"function_name": "module_for", "file_path": "rspec-core/lib/rspec/core/memoized_helpers.rb", "focal_code": "def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end", "file_content": "RSpec::Support.require_rspec_support 'reentrant_mutex'\n\nmodule RSpec\n  module Core\n    # This module is included in {ExampleGroup}, making the methods\n    # available to be called from within example blocks.\n    #\n    # @see ClassMethods\n    module MemoizedHelpers\n      # @note `subject` was contributed by Joe Ferris to support the one-liner\n      #   syntax embraced by shoulda matchers:\n      #\n      #       RSpec.describe Widget do\n      #         it { is_expected.to validate_presence_of(:name) }\n      #         # or\n      #         it { should validate_presence_of(:name) }\n      #       end\n      #\n      #   While the examples below demonstrate how to use `subject`\n      #   explicitly in examples, we recommend that you define a method with\n      #   an intention revealing name instead.\n      #\n      # @example\n      #\n      #   # Explicit declaration of subject.\n      #   RSpec.describe Person do\n      #     subject { Person.new(:birthdate => 19.years.ago) }\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # Implicit subject => { Person.new }.\n      #   RSpec.describe Person do\n      #     it \"should be eligible to vote\" do\n      #       subject.should be_eligible_to_vote\n      #       # ^ ^ explicit reference to subject not recommended\n      #     end\n      #   end\n      #\n      #   # One-liner syntax - expectation is set on the subject.\n      #   RSpec.describe Person do\n      #     it { is_expected.to be_eligible_to_vote }\n      #     # or\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @note Because `subject` is designed to create state that is reset\n      #   between each example, and `before(:context)` is designed to setup\n      #   state that is shared across _all_ examples in an example group,\n      #   `subject` is _not_ intended to be used in a `before(:context)` hook.\n      #\n      # @see #should\n      # @see #should_not\n      # @see #is_expected\n      def subject\n        __memoized.fetch_or_store(:subject) do\n          described = described_class || self.class.metadata.fetch(:description_args).first\n          Class === described ? described.new : described\n        end\n      end\n\n      # When `should` is called with no explicit receiver, the call is\n      # delegated to the object returned by `subject`. Combined with an\n      # implicit subject this supports very concise expressions.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to` instead of `should`.\n      def should(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should')\n        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Just like `should`, `should_not` delegates to the subject (implicit or\n      # explicit) of the example group.\n      #\n      # @example\n      #\n      #   RSpec.describe Person do\n      #     it { should_not be_eligible_to_vote }\n      #   end\n      #\n      # @see #subject\n      # @see #is_expected\n      #\n      # @note This only works if you are using rspec-expectations.\n      # @note If you are using RSpec's newer expect-based syntax you may\n      #       want to use `is_expected.to_not` instead of `should_not`.\n      def should_not(matcher=nil, message=nil)\n        enforce_value_expectation(matcher, 'should_not')\n        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)\n      end\n\n      # Wraps the `subject` in `expect` to make it the target of an expectation.\n      # Designed to read nicely for one-liners.\n      #\n      # @example\n      #\n      #   describe [1, 2, 3] do\n      #     it { is_expected.to be_an Array }\n      #     it { is_expected.not_to include 4 }\n      #   end\n      #\n      # @see #subject\n      # @see #should\n      # @see #should_not\n      #\n      # @note This only works if you are using rspec-expectations.\n      def is_expected\n        expect(subject)\n      end\n\n      # @private\n      # should just be placed in private section,\n      # but Ruby issues warnings on private attributes.\n      # and expanding it to the equivalent method upsets Rubocop,\n      # b/c it should obviously be a reader\n      attr_reader :__memoized\n      private :__memoized\n\n    private\n\n      # @private\n      def initialize(*)\n        __init_memoized\n        super\n      end\n\n      # @private\n      def __init_memoized\n        @__memoized = if RSpec.configuration.threadsafe?\n                        ThreadsafeMemoized.new\n                      else\n                        NonThreadSafeMemoized.new\n                      end\n      end\n\n      # @private\n      def enforce_value_expectation(matcher, method_name)\n        return if matcher_supports_value_expectations?(matcher)\n\n        RSpec.deprecate(\n          \"#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}\",\n          :message =>\n            \"The implicit block expectation syntax is deprecated, you should pass \" \\\n            \"a block to `expect` to use the provided block expectation matcher \" \\\n            \"(#{RSpec::Support::ObjectFormatter.format(matcher)}), \" \\\n            \"or the matcher must implement `supports_value_expectations?`.\"\n        )\n      end\n\n      def matcher_supports_value_expectations?(matcher)\n        matcher.supports_value_expectations?\n      rescue\n        true\n      end\n\n      # @private\n      class ThreadsafeMemoized\n        def initialize\n          @memoized = {}\n          @mutex = Support::ReentrantMutex.new\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) do # only first access pays for synchronization\n            @mutex.synchronize do\n              @memoized.fetch(key) { @memoized[key] = yield }\n            end\n          end\n        end\n      end\n\n      # @private\n      class NonThreadSafeMemoized\n        def initialize\n          @memoized = {}\n        end\n\n        def fetch_or_store(key)\n          @memoized.fetch(key) { @memoized[key] = yield }\n        end\n      end\n\n      # Used internally to customize the behavior of the\n      # memoized hash when used in a `before(:context)` hook.\n      #\n      # @private\n      class ContextHookMemoized\n        def self.isolate_for_context_hook(example_group_instance)\n          exploding_memoized = self\n\n          example_group_instance.instance_exec do\n            @__memoized = exploding_memoized\n\n            begin\n              yield\n            ensure\n              # This is doing a reset instead of just isolating for context hook.\n              # Really, this should set the old @__memoized back into place.\n              #\n              # Caller is the before and after context hooks\n              # which are both called from self.run\n              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,\n              # if so, then that probably already works, and its the tests that are wrong.\n              __init_memoized\n            end\n          end\n        end\n\n        def self.fetch_or_store(key, &_block)\n          description = if key == :subject\n                          \"subject\"\n                        else\n                          \"let declaration `#{key}`\"\n                        end\n\n          raise <<-EOS\n#{description} accessed in #{article} #{hook_expression} hook at:\n  #{CallerFilter.first_non_rspec_line}\n\n`let` and `subject` declarations are not intended to be called\nin #{article} #{hook_expression} hook, as they exist to define state that\nis reset between each example, while #{hook_expression} exists to\n#{hook_intention}.\nEOS\n        end\n\n        # @private\n        class Before < self\n          def self.hook_expression\n            \"`before(:context)`\"\n          end\n\n          def self.article\n            \"a\"\n          end\n\n          def self.hook_intention\n            \"define state that is shared across examples in an example group\"\n          end\n        end\n\n        # @private\n        class After < self\n          def self.hook_expression\n            \"`after(:context)`\"\n          end\n\n          def self.article\n            \"an\"\n          end\n\n          def self.hook_intention\n            \"cleanup state that is shared across examples in an example group\"\n          end\n        end\n      end\n\n      # This module is extended onto {ExampleGroup}, making the methods\n      # available to be called from within example group blocks.\n      # You can think of them as being analagous to class macros.\n      module ClassMethods\n        # Generates a method whose return value is memoized after the first\n        # call. Useful for reducing duplication between examples that assign\n        # values to the same local variable.\n        #\n        # @note `let` _can_ enhance readability when used sparingly (1,2, or\n        #   maybe 3 declarations) in any given example group, but that can\n        #   quickly degrade with overuse. YMMV.\n        #\n        # @note `let` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @note Because `let` is designed to create state that is reset between\n        #   each example, and `before(:context)` is designed to setup state that\n        #   is shared across _all_ examples in an example group, `let` is _not_\n        #   intended to be used in a `before(:context)` hook.\n        #\n        # @example\n        #\n        #   RSpec.describe Thing do\n        #     let(:thing) { Thing.new }\n        #\n        #     it \"does something\" do\n        #       # First invocation, executes block, memoizes and returns result.\n        #       thing.do_something\n        #\n        #       # Second invocation, returns the memoized value.\n        #       thing.should be_something\n        #     end\n        #   end\n        def let(name, &block)\n          # We have to pass the block directly to `define_method` to\n          # allow it to use method constructs like `super` and `return`.\n          raise \"#let or #subject called without a block\" if block.nil?\n\n          # A list of reserved words that can't be used as a name for a memoized helper\n          # Matches for both symbols and passed strings\n          if [:initialize, :to_s].include?(name.to_sym)\n            raise ArgumentError, \"#let or #subject called with reserved name `#{name}`\"\n          end\n\n          our_module = MemoizedHelpers.module_for(self)\n\n          # If we have a module clash in our helper module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if our_module.instance_methods(false).include?(name)\n            our_module.__send__(:remove_method, name)\n          end\n          our_module.__send__(:define_method, name, &block)\n\n          # If we have a module clash in the example module\n          # then we need to remove it to prevent a warning.\n          #\n          # Note we do not check ancestor modules (see: `instance_methods(false)`)\n          # as we can override them.\n          if instance_methods(false).include?(name)\n            remove_method(name)\n          end\n\n          # Apply the memoization. The method has been defined in an ancestor\n          # module so we can use `super` here to get the value.\n          if block.arity == 1\n            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }\n          else\n            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }\n          end\n        end\n\n        # Just like `let`, except the block is invoked by an implicit `before`\n        # hook. This serves a dual purpose of setting up state and providing a\n        # memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using let\" do\n        #       let(:thing) { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using let!\" do\n        #       let!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         thing\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def let!(name, &block)\n          let(name, &block)\n          before { __send__(name) }\n        end\n\n        # Declares a `subject` for an example group which can then be wrapped\n        # with `expect` using `is_expected` to make it the target of an\n        # expectation in a concise, one-line example.\n        #\n        # Given a `name`, defines a method with that name which returns the\n        # `subject`. This lets you declare the subject once and access it\n        # implicitly in one-liners and explicitly using an intention revealing\n        # name.\n        #\n        # When given a `name`, calling `super` in the block is not supported.\n        #\n        # @note `subject` can be configured to be threadsafe or not.\n        #   If it is threadsafe, it will take longer to access the value.\n        #   If it is not threadsafe, it may behave in surprising ways in examples\n        #   that spawn separate threads. Specify this on `RSpec.configure`\n        #\n        # @param name [String,Symbol] used to define an accessor with an\n        #   intention revealing name\n        # @param block defines the value to be returned by `subject` in examples\n        #\n        # @example\n        #\n        #   RSpec.describe CheckingAccount, \"with $50\" do\n        #     subject { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #   end\n        #\n        #   RSpec.describe CheckingAccount, \"with a non-zero starting balance\" do\n        #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }\n        #     it { is_expected.not_to be_overdrawn }\n        #     it \"has a balance equal to the starting balance\" do\n        #       account.balance.should eq(Money.new(50, :USD))\n        #     end\n        #   end\n        #\n        # @see MemoizedHelpers#should\n        # @see MemoizedHelpers#should_not\n        # @see MemoizedHelpers#is_expected\n        def subject(name=nil, &block)\n          if name\n            let(name, &block)\n            alias_method :subject, name\n\n            self::NamedSubjectPreventSuper.__send__(:define_method, name) do\n              raise NotImplementedError, \"`super` in named subjects is not supported\"\n            end\n          else\n            let(:subject, &block)\n          end\n        end\n\n        # Just like `subject`, except the block is invoked by an implicit\n        # `before` hook. This serves a dual purpose of setting up state and\n        # providing a memoized reference to that state.\n        #\n        # @example\n        #\n        #   class Thing\n        #     def self.count\n        #       @count ||= 0\n        #     end\n        #\n        #     def self.count=(val)\n        #       @count += val\n        #     end\n        #\n        #     def self.reset_count\n        #       @count = 0\n        #     end\n        #\n        #     def initialize\n        #       self.class.count += 1\n        #     end\n        #   end\n        #\n        #   RSpec.describe Thing do\n        #     after(:example) { Thing.reset_count }\n        #\n        #     context \"using subject\" do\n        #       subject { Thing.new }\n        #\n        #       it \"is not invoked implicitly\" do\n        #         Thing.count.should eq(0)\n        #       end\n        #\n        #       it \"can be invoked explicitly\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #\n        #     context \"using subject!\" do\n        #       subject!(:thing) { Thing.new }\n        #\n        #       it \"is invoked implicitly\" do\n        #         Thing.count.should eq(1)\n        #       end\n        #\n        #       it \"returns memoized version on first invocation\" do\n        #         subject\n        #         Thing.count.should eq(1)\n        #       end\n        #     end\n        #   end\n        def subject!(name=nil, &block)\n          subject(name, &block)\n          before { subject }\n        end\n      end\n\n      # @private\n      #\n      # Gets the LetDefinitions module. The module is mixed into\n      # the example group and is used to hold all let definitions.\n      # This is done so that the block passed to `let` can be\n      # forwarded directly on to `define_method`, so that all method\n      # constructs (including `super` and `return`) can be used in\n      # a `let` block.\n      #\n      # The memoization is provided by a method definition on the\n      # example group that supers to the LetDefinitions definition\n      # in order to get the value to memoize.\n      def self.module_for(example_group)\n        get_constant_or_yield(example_group, :LetDefinitions) do\n          mod = Module.new do\n            include(Module.new {\n              example_group.const_set(:NamedSubjectPreventSuper, self)\n            })\n          end\n\n          example_group.const_set(:LetDefinitions, mod)\n          mod\n        end\n      end\n\n      # @private\n      def self.define_helpers_on(example_group)\n        example_group.__send__(:include, module_for(example_group))\n      end\n\n      if Module.method(:const_defined?).arity == 1 # for 1.8\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.8, const_defined? / const_get do not take into\n        # account the inheritance hierarchy.\n        # :nocov:\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name)\n            example_group.const_get(name)\n          else\n            yield\n          end\n        end\n        # :nocov:\n      else\n        # @private\n        #\n        # Gets the named constant or yields.\n        # On 1.9, const_defined? / const_get take into account the\n        # the inheritance by default, and accept an argument to\n        # disable this behavior. It's important that we don't\n        # consider inheritance here; each example group level that\n        # uses a `let` should get its own `LetDefinitions` module.\n        def self.get_constant_or_yield(example_group, name)\n          if example_group.const_defined?(name, (check_ancestors = false))\n            example_group.const_get(name, check_ancestors)\n          else\n            yield\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "module_for", "signature": "def self.module_for(example_group)", "start_line": 528, "end_line": 539}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 278}
{"function_name": "populate", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "populate", "signature": "def populate ensure_valid_user_keys", "start_line": 128, "end_line": 139}, "metadata": {"module": "RSpec", "class_name": "HashPopulator", "class_signature": "class HashPopulator"}, "task_id": 279}
{"function_name": "populate_location_attributes", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "populate_location_attributes", "signature": "def populate_location_attributes backtrace = user_metadata.delete(:caller)", "start_line": 143, "end_line": 162}, "metadata": {"module": "RSpec", "class_name": "HashPopulator", "class_signature": "class HashPopulator"}, "task_id": 280}
{"function_name": "ensure_valid_user_keys", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "ensure_valid_user_keys", "signature": "def ensure_valid_user_keys RESERVED_KEYS.each do |key|", "start_line": 191, "end_line": 209}, "metadata": {"module": "RSpec", "class_name": "HashPopulator", "class_signature": "class HashPopulator"}, "task_id": 281}
{"function_name": "create", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "create", "signature": "def self.create(group_metadata, user_metadata, index_provider, description, block)", "start_line": 214, "end_line": 230}, "metadata": {"module": "RSpec", "class_name": "ExampleHash", "class_signature": "class ExampleHash < < HashPopulator"}, "task_id": 282}
{"function_name": "create", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "create", "signature": "def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)", "start_line": 248, "end_line": 259}, "metadata": {"module": "RSpec", "class_name": "ExampleGroupHash", "class_signature": "class ExampleGroupHash < < HashPopulator"}, "task_id": 283}
{"function_name": "backwards_compatibility_default_proc", "file_path": "rspec-core/lib/rspec/core/metadata.rb", "focal_code": "def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # Each ExampleGroup class and Example instance owns an instance of\n    # Metadata, which is Hash extended to support lazy evaluation of values\n    # associated with keys that may or may not be used by any example or group.\n    #\n    # In addition to metadata that is used internally, this also stores\n    # user-supplied metadata, e.g.\n    #\n    #     RSpec.describe Something, :type => :ui do\n    #       it \"does something\", :slow => true do\n    #         # ...\n    #       end\n    #     end\n    #\n    # `:type => :ui` is stored in the Metadata owned by the example group, and\n    # `:slow => true` is stored in the Metadata owned by the example. These can\n    # then be used to select which examples are run using the `--tag` option on\n    # the command line, or several methods on `Configuration` used to filter a\n    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).\n    #\n    # @see Example#metadata\n    # @see ExampleGroup.metadata\n    # @see FilterManager\n    # @see Configuration#filter_run_including\n    # @see Configuration#filter_run_excluding\n    module Metadata\n      # Matches strings either at the beginning of the input or prefixed with a\n      # whitespace, containing the current path, either postfixed with the\n      # separator, or at the end of the string. Match groups are the character\n      # before and the character after the string if any.\n      #\n      # http://rubular.com/r/fT0gmX6VJX\n      # http://rubular.com/r/duOrD4i3wb\n      # http://rubular.com/r/sbAMHFrOx1\n      def self.relative_path_regex\n        @relative_path_regex ||= /(\\A|\\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\\s|\\Z)/\n      end\n\n      # @api private\n      #\n      # @param line [String] current code line\n      # @return [String] relative path to line\n      def self.relative_path(line)\n        line = line.sub(relative_path_regex, \"\\\\1.\\\\2\".freeze)\n        line = line.sub(/\\A([^:]+:\\d+)$/, '\\\\1'.freeze)\n        return nil if line == '-e:1'.freeze\n        line\n      rescue SecurityError\n        # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n        nil\n        # :nocov:\n      end\n\n      # @private\n      # Iteratively walks up from the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascending(metadata)\n        yield metadata\n        return unless (group_metadata = metadata.fetch(:example_group) { metadata[:parent_example_group] })\n\n        loop do\n          yield group_metadata\n          break unless (group_metadata = group_metadata[:parent_example_group])\n        end\n      end\n\n      # @private\n      # Returns an enumerator that iteratively walks up the given metadata through all\n      # example group ancestors, yielding each metadata hash along the way.\n      def self.ascend(metadata)\n        enum_for(:ascending, metadata)\n      end\n\n      # @private\n      # Used internally to build a hash from an args array.\n      # Symbols are converted into hash keys with a value of `true`.\n      # This is done to support simple tagging using a symbol, rather\n      # than needing to do `:symbol => true`.\n      def self.build_hash_from(args, warn_about_example_group_filtering=false)\n        hash = args.last.is_a?(Hash) ? args.pop : {}\n\n        hash[args.pop] = true while args.last.is_a?(Symbol)\n\n        if warn_about_example_group_filtering && hash.key?(:example_group)\n          RSpec.deprecate(\"Filtering by an `:example_group` subhash\",\n                          :replacement => \"the subhash to filter directly\")\n        end\n\n        hash\n      end\n\n      # @private\n      def self.deep_hash_dup(object)\n        return object.dup if Array === object\n        return object unless Hash  === object\n\n        object.inject(object.dup) do |duplicate, (key, value)|\n          duplicate[key] = deep_hash_dup(value)\n          duplicate\n        end\n      end\n\n      # @private\n      def self.id_from(metadata)\n        \"#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]\"\n      end\n\n      # @private\n      def self.location_tuple_from(metadata)\n        [metadata[:absolute_file_path], metadata[:line_number]]\n      end\n\n      # @private\n      # Used internally to populate metadata hashes with computed keys\n      # managed by RSpec.\n      class HashPopulator\n        attr_reader :metadata, :user_metadata, :description_args, :block\n\n        def initialize(metadata, user_metadata, index_provider, description_args, block)\n          @metadata         = metadata\n          @user_metadata    = user_metadata\n          @index_provider   = index_provider\n          @description_args = description_args\n          @block            = block\n        end\n\n        def populate\n          ensure_valid_user_keys\n\n          metadata[:block]            = block\n          metadata[:description_args] = description_args\n          metadata[:description]      = build_description_from(*metadata[:description_args])\n          metadata[:full_description] = full_description\n          metadata[:described_class]  = described_class\n\n          populate_location_attributes\n          metadata.update(user_metadata)\n        end\n\n      private\n\n        def populate_location_attributes\n          backtrace = user_metadata.delete(:caller)\n\n          file_path, line_number = if backtrace\n                                     file_path_and_line_number_from(backtrace)\n                                   elsif block.respond_to?(:source_location)\n                                     block.source_location\n                                   else\n                                     file_path_and_line_number_from(caller)\n                                   end\n\n          relative_file_path            = Metadata.relative_path(file_path)\n          absolute_file_path            = File.expand_path(relative_file_path)\n          metadata[:file_path]          = relative_file_path\n          metadata[:line_number]        = line_number.to_i\n          metadata[:location]           = \"#{relative_file_path}:#{line_number}\"\n          metadata[:absolute_file_path] = absolute_file_path\n          metadata[:rerun_file_path]  ||= relative_file_path\n          metadata[:scoped_id]          = build_scoped_id_for(absolute_file_path)\n        end\n\n        def file_path_and_line_number_from(backtrace)\n          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }\n          first_caller_from_outside_rspec ||= backtrace.first\n          /(.+?):(\\d+)(?:|:\\d+)/.match(first_caller_from_outside_rspec).captures\n        end\n\n        def description_separator(parent_part, child_part)\n          if parent_part.is_a?(Module) && /^(?:#|::|\\.)/.match(child_part.to_s)\n            ''.freeze\n          else\n            ' '.freeze\n          end\n        end\n\n        def build_description_from(parent_description=nil, my_description=nil)\n          return parent_description.to_s unless my_description\n          return my_description.to_s if parent_description.to_s == ''\n          separator = description_separator(parent_description, my_description)\n          (parent_description.to_s + separator) << my_description.to_s\n        end\n\n        def build_scoped_id_for(file_path)\n          index = @index_provider.call(file_path).to_s\n          parent_scoped_id = metadata.fetch(:scoped_id) { return index }\n          \"#{parent_scoped_id}:#{index}\"\n        end\n\n        def ensure_valid_user_keys\n          RESERVED_KEYS.each do |key|\n            next unless user_metadata.key?(key)\n            raise <<-EOM.gsub(/^\\s+\\|/, '')\n              |#{\"*\" * 50}\n              |:#{key} is not allowed\n              |\n              |RSpec reserves some hash keys for its own internal use,\n              |including :#{key}, which is used on:\n              |\n              |  #{CallerFilter.first_non_rspec_line}.\n              |\n              |Here are all of RSpec's reserved hash keys:\n              |\n              |  #{RESERVED_KEYS.join(\"\\n  \")}\n              |#{\"*\" * 50}\n            EOM\n          end\n        end\n      end\n\n      # @private\n      class ExampleHash < HashPopulator\n        def self.create(group_metadata, user_metadata, index_provider, description, block)\n          example_metadata = group_metadata.dup\n          group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|\n            hash[:parent_example_group]\n          end)\n          group_metadata.update(example_metadata)\n\n          example_metadata[:execution_result] = Example::ExecutionResult.new\n          example_metadata[:example_group] = group_metadata\n          example_metadata[:shared_group_inclusion_backtrace] = SharedExampleGroupInclusionStackFrame.current_backtrace\n          example_metadata.delete(:parent_example_group)\n\n          description_args = description.nil? ? [] : [description]\n          hash = new(example_metadata, user_metadata, index_provider, description_args, block)\n          hash.populate\n          hash.metadata\n        end\n\n      private\n\n        def described_class\n          metadata[:example_group][:described_class]\n        end\n\n        def full_description\n          build_description_from(\n            metadata[:example_group][:full_description],\n            metadata[:description]\n          )\n        end\n      end\n\n      # @private\n      class ExampleGroupHash < HashPopulator\n        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)\n          group_metadata = hash_with_backwards_compatibility_default_proc\n\n          if parent_group_metadata\n            group_metadata.update(parent_group_metadata)\n            group_metadata[:parent_example_group] = parent_group_metadata\n          end\n\n          hash = new(group_metadata, user_metadata, example_group_index, args, block)\n          hash.populate\n          hash.metadata\n        end\n\n        def self.hash_with_backwards_compatibility_default_proc\n          Hash.new(&backwards_compatibility_default_proc { |hash| hash })\n        end\n\n        def self.backwards_compatibility_default_proc(&example_group_selector)\n          Proc.new do |hash, key|\n            case key\n            when :example_group\n              # We commonly get here when rspec-core is applying a previously\n              # configured filter rule, such as when a gem configures:\n              #\n              #   RSpec.configure do |c|\n              #     c.include MyGemHelpers, :example_group => { :file_path => /spec\\/my_gem_specs/ }\n              #   end\n              #\n              # It's confusing for a user to get a deprecation at this point in\n              # the code, so instead we issue a deprecation from the config APIs\n              # that take a metadata hash, and MetadataFilter sets this thread\n              # local to silence the warning here since it would be so\n              # confusing.\n              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]\n                RSpec.deprecate(\"The `:example_group` key in an example group's metadata hash\",\n                                :replacement => \"the example group's hash directly for the \" \\\n                                \"computed keys and `:parent_example_group` to access the parent \" \\\n                                \"example group metadata\")\n              end\n\n              group_hash = example_group_selector.call(hash)\n              LegacyExampleGroupHash.new(group_hash) if group_hash\n            when :example_group_block\n              RSpec.deprecate(\"`metadata[:example_group_block]`\",\n                              :replacement => \"`metadata[:block]`\")\n              hash[:block]\n            when :describes\n              RSpec.deprecate(\"`metadata[:describes]`\",\n                              :replacement => \"`metadata[:described_class]`\")\n              hash[:described_class]\n            end\n          end\n        end\n\n      private\n\n        def described_class\n          candidate = metadata[:description_args].first\n          return candidate unless NilClass === candidate || String === candidate\n          parent_group = metadata[:parent_example_group]\n          parent_group && parent_group[:described_class]\n        end\n\n        def full_description\n          description          = metadata[:description]\n          parent_example_group = metadata[:parent_example_group]\n          return description unless parent_example_group\n\n          parent_description   = parent_example_group[:full_description]\n          separator = description_separator(parent_example_group[:description_args].last,\n                                            metadata[:description_args].first)\n\n          parent_description + separator + description\n        end\n      end\n\n      # @private\n      RESERVED_KEYS = [\n        :description,\n        :description_args,\n        :described_class,\n        :example_group,\n        :parent_example_group,\n        :execution_result,\n        :last_run_status,\n        :file_path,\n        :absolute_file_path,\n        :rerun_file_path,\n        :full_description,\n        :line_number,\n        :location,\n        :scoped_id,\n        :block,\n        :shared_group_inclusion_backtrace\n      ]\n    end\n\n    # Mixin that makes the including class imitate a hash for backwards\n    # compatibility. The including class should use `attr_accessor` to\n    # declare attributes.\n    # @private\n    module HashImitatable\n      def self.included(klass)\n        klass.extend ClassMethods\n      end\n\n      def to_h\n        hash = extra_hash_attributes.dup\n\n        self.class.hash_attribute_names.each do |name|\n          hash[name] = __send__(name)\n        end\n\n        hash\n      end\n\n      (Hash.public_instance_methods - Object.public_instance_methods).each do |method_name|\n        next if [:[], :[]=, :to_h].include?(method_name.to_sym)\n\n        define_method(method_name) do |*args, &block|\n          issue_deprecation(method_name, *args)\n\n          hash = hash_for_delegation\n          self.class.hash_attribute_names.each do |name|\n            hash.delete(name) unless instance_variable_defined?(:\"@#{name}\")\n          end\n\n          hash.__send__(method_name, *args, &block).tap do\n            # apply mutations back to the object\n            hash.each do |name, value|\n              if directly_supports_attribute?(name)\n                set_value(name, value)\n              else\n                extra_hash_attributes[name] = value\n              end\n            end\n          end\n        end\n      end\n\n      def [](key)\n        issue_deprecation(:[], key)\n\n        if directly_supports_attribute?(key)\n          get_value(key)\n        else\n          extra_hash_attributes[key]\n        end\n      end\n\n      def []=(key, value)\n        issue_deprecation(:[]=, key, value)\n\n        if directly_supports_attribute?(key)\n          set_value(key, value)\n        else\n          extra_hash_attributes[key] = value\n        end\n      end\n\n    private\n\n      def extra_hash_attributes\n        @extra_hash_attributes ||= {}\n      end\n\n      def directly_supports_attribute?(name)\n        self.class.hash_attribute_names.include?(name)\n      end\n\n      def get_value(name)\n        __send__(name)\n      end\n\n      def set_value(name, value)\n        __send__(:\"#{name}=\", value)\n      end\n\n      def hash_for_delegation\n        to_h\n      end\n\n      def issue_deprecation(_method_name, *_args)\n        # no-op by default: subclasses can override\n      end\n\n      # @private\n      module ClassMethods\n        def hash_attribute_names\n          @hash_attribute_names ||= []\n        end\n\n        def attr_accessor(*names)\n          hash_attribute_names.concat(names)\n          super\n        end\n      end\n    end\n\n    # @private\n    # Together with the example group metadata hash default block,\n    # provides backwards compatibility for the old `:example_group`\n    # key. In RSpec 2.x, the computed keys of a group's metadata\n    # were exposed from a nested subhash keyed by `[:example_group]`, and\n    # then the parent group's metadata was exposed by sub-subhash\n    # keyed by `[:example_group][:example_group]`.\n    #\n    # In RSpec 3, we reorganized this to that the computed keys are\n    # exposed directly of the group metadata hash (no nesting), and\n    # `:parent_example_group` returns the parent group's metadata.\n    #\n    # Maintaining backwards compatibility was difficult: we wanted\n    # `:example_group` to return an object that:\n    #\n    #   * Exposes the top-level metadata keys that used to be nested\n    #     under `:example_group`.\n    #   * Supports mutation (rspec-rails, for example, assigns\n    #     `metadata[:example_group][:described_class]` when you use\n    #     anonymous controller specs) such that changes are written\n    #     back to the top-level metadata hash.\n    #   * Exposes the parent group metadata as\n    #     `[:example_group][:example_group]`.\n    class LegacyExampleGroupHash\n      include HashImitatable\n\n      def initialize(metadata)\n        @metadata = metadata\n        parent_group_metadata = metadata.fetch(:parent_example_group) { {} }[:example_group]\n        self[:example_group] = parent_group_metadata if parent_group_metadata\n      end\n\n      def to_h\n        super.merge(@metadata)\n      end\n\n    private\n\n      def directly_supports_attribute?(name)\n        name != :example_group\n      end\n\n      def get_value(name)\n        @metadata[name]\n      end\n\n      def set_value(name, value)\n        @metadata[name] = value\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "backwards_compatibility_default_proc", "signature": "def self.backwards_compatibility_default_proc(&example_group_selector)", "start_line": 265, "end_line": 300}, "metadata": {"module": "RSpec", "class_name": "ExampleGroupHash", "class_signature": "class ExampleGroupHash < < HashPopulator"}, "task_id": 284}
{"function_name": "filter_applies?", "file_path": "rspec-core/lib/rspec/core/metadata_filter.rb", "focal_code": "def filter_applies?(key, filter_value, metadata)\n          silence_metadata_example_group_deprecations do\n            return location_filter_applies?(filter_value, metadata) if key == :locations\n            return id_filter_applies?(filter_value, metadata)       if key == :ids\n            return filters_apply?(key, filter_value, metadata)      if Hash === filter_value\n\n            meta_value = metadata.fetch(key) { return false }\n\n            return true if TrueClass === filter_value && meta_value\n            return proc_filter_applies?(key, filter_value, metadata) if Proc === filter_value\n            return filter_applies_to_any_value?(key, filter_value, metadata) if Array === meta_value\n\n            filter_value === meta_value || filter_value.to_s == meta_value.to_s\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # Contains metadata filtering logic. This has been extracted from\n    # the metadata classes because it operates ON a metadata hash but\n    # does not manage any of the state in the hash. We're moving towards\n    # having metadata be a raw hash (not a custom subclass), so externalizing\n    # this filtering logic helps us move in that direction.\n    module MetadataFilter\n      class << self\n        # @private\n        def apply?(predicate, filters, metadata)\n          filters.__send__(predicate) { |k, v| filter_applies?(k, v, metadata) }\n        end\n\n        # @private\n        def filter_applies?(key, filter_value, metadata)\n          silence_metadata_example_group_deprecations do\n            return location_filter_applies?(filter_value, metadata) if key == :locations\n            return id_filter_applies?(filter_value, metadata)       if key == :ids\n            return filters_apply?(key, filter_value, metadata)      if Hash === filter_value\n\n            meta_value = metadata.fetch(key) { return false }\n\n            return true if TrueClass === filter_value && meta_value\n            return proc_filter_applies?(key, filter_value, metadata) if Proc === filter_value\n            return filter_applies_to_any_value?(key, filter_value, metadata) if Array === meta_value\n\n            filter_value === meta_value || filter_value.to_s == meta_value.to_s\n          end\n        end\n\n        # @private\n        def silence_metadata_example_group_deprecations\n          RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations] = true\n          yield\n        ensure\n          RSpec::Support.thread_local_data.delete(:silence_metadata_example_group_deprecations)\n        end\n\n      private\n\n        def filter_applies_to_any_value?(key, value, metadata)\n          metadata[key].any? { |v| filter_applies?(key, v,  key => value) }\n        end\n\n        def id_filter_applies?(rerun_paths_to_scoped_ids, metadata)\n          scoped_ids = rerun_paths_to_scoped_ids.fetch(metadata[:rerun_file_path]) { return false }\n\n          Metadata.ascend(metadata).any? do |meta|\n            scoped_ids.include?(meta[:scoped_id])\n          end\n        end\n\n        def location_filter_applies?(locations, metadata)\n          Metadata.ascend(metadata).any? do |meta|\n            file_path = meta[:absolute_file_path]\n            line_num  = meta[:line_number]\n\n            locations[file_path].any? do |filter_line_num|\n              line_num == RSpec.world.preceding_declaration_line(file_path, filter_line_num)\n            end\n          end\n        end\n\n        def proc_filter_applies?(key, proc, metadata)\n          case proc.arity\n          when 0 then proc.call\n          when 2 then proc.call(metadata[key], metadata)\n          else proc.call(metadata[key])\n          end\n        end\n\n        def filters_apply?(key, value, metadata)\n          subhash = metadata[key]\n          return false unless Hash === subhash || HashImitatable === subhash\n          value.all? { |k, v| filter_applies?(k, v, subhash) }\n        end\n      end\n    end\n\n    # Tracks a collection of filterable items (e.g. modules, hooks, etc)\n    # and provides an optimized API to get the applicable items for the\n    # metadata of an example or example group.\n    #\n    # There are two implementations, optimized for different uses.\n    # @private\n    module FilterableItemRepository\n      # This implementation is simple, and is optimized for frequent\n      # updates but rare queries. `append` and `prepend` do no extra\n      # processing, and no internal memoization is done, since this\n      # is not optimized for queries.\n      #\n      # This is ideal for use by a example or example group, which may\n      # be updated multiple times with globally configured hooks, etc,\n      # but will not be queried frequently by other examples or example\n      # groups.\n      # @private\n      class UpdateOptimized\n        attr_reader :items_and_filters\n\n        def initialize(applies_predicate)\n          @applies_predicate = applies_predicate\n          @items_and_filters = []\n        end\n\n        def append(item, metadata)\n          @items_and_filters << [item, metadata]\n        end\n\n        def prepend(item, metadata)\n          @items_and_filters.unshift [item, metadata]\n        end\n\n        def delete(item, metadata)\n          @items_and_filters.delete [item, metadata]\n        end\n\n        def items_for(request_meta)\n          @items_and_filters.each_with_object([]) do |(item, item_meta), to_return|\n            to_return << item if item_meta.empty? ||\n                                 MetadataFilter.apply?(@applies_predicate, item_meta, request_meta)\n          end\n        end\n\n        unless [].respond_to?(:each_with_object) # For 1.8.7\n          # :nocov:\n          undef items_for\n          def items_for(request_meta)\n            @items_and_filters.inject([]) do |to_return, (item, item_meta)|\n              to_return << item if item_meta.empty? ||\n                                   MetadataFilter.apply?(@applies_predicate, item_meta, request_meta)\n              to_return\n            end\n          end\n          # :nocov:\n        end\n      end\n\n      # This implementation is much more complex, and is optimized for\n      # rare (or hopefully no) updates once the queries start. Updates\n      # incur a cost as it has to clear the memoization and keep track\n      # of applicable keys. Queries will be O(N) the first time an item\n      # is provided with a given set of applicable metadata; subsequent\n      # queries with items with the same set of applicable metadata will\n      # be O(1) due to internal memoization.\n      #\n      # This is ideal for use by config, where filterable items (e.g. hooks)\n      # are typically added at the start of the process (e.g. in `spec_helper`)\n      # and then repeatedly queried as example groups and examples are defined.\n      # @private\n      class QueryOptimized < UpdateOptimized\n        alias find_items_for items_for\n        private :find_items_for\n\n        def initialize(applies_predicate)\n          super\n          @applicable_keys   = Set.new\n          @proc_keys         = Set.new\n          @memoized_lookups  = Hash.new do |hash, applicable_metadata|\n            hash[applicable_metadata] = find_items_for(applicable_metadata)\n          end\n        end\n\n        def append(item, metadata)\n          super\n          handle_mutation(metadata)\n        end\n\n        def prepend(item, metadata)\n          super\n          handle_mutation(metadata)\n        end\n\n        def delete(item, metadata)\n          super\n          reconstruct_caches\n        end\n\n        def items_for(metadata)\n          # The filtering of `metadata` to `applicable_metadata` is the key thing\n          # that makes the memoization actually useful in practice, since each\n          # example and example group have different metadata (e.g. location and\n          # description). By filtering to the metadata keys our items care about,\n          # we can ignore extra metadata keys that differ for each example/group.\n          # For example, given `config.include DBHelpers, :db`, example groups\n          # can be split into these two sets: those that are tagged with `:db` and those\n          # that are not. For each set, this method for the first group in the set is\n          # still an `O(N)` calculation, but all subsequent groups in the set will be\n          # constant time lookups when they call this method.\n          applicable_metadata = applicable_metadata_from(metadata)\n\n          if applicable_metadata.any? { |k, _| @proc_keys.include?(k) }\n            # It's unsafe to memoize lookups involving procs (since they can\n            # be non-deterministic), so we skip the memoization in this case.\n            find_items_for(applicable_metadata)\n          else\n            @memoized_lookups[applicable_metadata]\n          end\n        end\n\n      private\n\n        def reconstruct_caches\n          @applicable_keys.clear\n          @proc_keys.clear\n          @items_and_filters.each do |_item, metadata|\n            handle_mutation(metadata)\n          end\n        end\n\n        def handle_mutation(metadata)\n          @applicable_keys.merge(metadata.keys)\n          @proc_keys.merge(proc_keys_from metadata)\n          @memoized_lookups.clear\n        end\n\n        def applicable_metadata_from(metadata)\n          MetadataFilter.silence_metadata_example_group_deprecations do\n            @applicable_keys.inject({}) do |hash, key|\n              # :example_group is treated special here because...\n              # - In RSpec 2, example groups had an `:example_group` key\n              # - In RSpec 3, that key is deprecated (it was confusing!).\n              # - The key is not technically present in an example group metadata hash\n              #   (and thus would fail the `metadata.key?(key)` check) but a value\n              #   is provided when accessed via the hash's `default_proc`\n              # - Thus, for backwards compatibility, we have to explicitly check\n              #   for `:example_group` here if it is one of the keys being used to\n              #   filter.\n              hash[key] = metadata[key] if metadata.key?(key) || key == :example_group\n              hash\n            end\n          end\n        end\n\n        def proc_keys_from(metadata)\n          metadata.each_with_object([]) do |(key, value), to_return|\n            to_return << key if Proc === value\n          end\n        end\n\n        unless [].respond_to?(:each_with_object) # For 1.8.7\n          # :nocov:\n          undef proc_keys_from\n          def proc_keys_from(metadata)\n            metadata.inject([]) do |to_return, (key, value)|\n              to_return << key if Proc === value\n              to_return\n            end\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "filter_applies?", "signature": "def filter_applies?(key, filter_value, metadata)", "start_line": 16, "end_line": 30}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 285}
{"function_name": "for", "file_path": "rspec-core/lib/rspec/core/notifications.rb", "focal_code": "def self.for(example)\n        execution_result = example.execution_result\n\n        return SkippedExampleNotification.new(example) if execution_result.example_skipped?\n        return new(example) unless execution_result.status == :pending || execution_result.status == :failed\n\n        klass = if execution_result.pending_fixed?\n                  PendingExampleFixedNotification\n                elsif execution_result.status == :pending\n                  PendingExampleFailedAsExpectedNotification\n                else\n                  FailedExampleNotification\n                end\n\n        klass.new(example)\n      end", "file_content": "RSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/exception_presenter\"\nRSpec::Support.require_rspec_core \"formatters/helpers\"\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec::Core\n  # Notifications are value objects passed to formatters to provide them\n  # with information about a particular event of interest.\n  module Notifications\n    # @private\n    module NullColorizer\n      module_function\n\n      def wrap(line, _code_or_symbol)\n        line\n      end\n    end\n\n    # The `StartNotification` represents a notification sent by the reporter\n    # when the suite is started. It contains the expected amount of examples\n    # to be executed, and the load time of RSpec.\n    #\n    # @attr count [Fixnum] the number counted\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    StartNotification = Struct.new(:count, :load_time)\n\n    # The `ExampleNotification` represents notifications sent by the reporter\n    # which contain information about the current (or soon to be) example.\n    # It is used by formatters to access information about that example.\n    #\n    # @example\n    #   def example_started(notification)\n    #     puts \"Hey I started #{notification.example.description}\"\n    #   end\n    #\n    # @attr example [RSpec::Core::Example] the current example\n    ExampleNotification = Struct.new(:example)\n    class ExampleNotification\n      # @private\n      def self.for(example)\n        execution_result = example.execution_result\n\n        return SkippedExampleNotification.new(example) if execution_result.example_skipped?\n        return new(example) unless execution_result.status == :pending || execution_result.status == :failed\n\n        klass = if execution_result.pending_fixed?\n                  PendingExampleFixedNotification\n                elsif execution_result.status == :pending\n                  PendingExampleFailedAsExpectedNotification\n                else\n                  FailedExampleNotification\n                end\n\n        klass.new(example)\n      end\n\n      private_class_method :new\n    end\n\n    # The `ExamplesNotification` represents notifications sent by the reporter\n    # which contain information about the suites examples.\n    #\n    # @example\n    #   def stop(notification)\n    #     puts \"Hey I ran #{notification.examples.size}\"\n    #   end\n    #\n    class ExamplesNotification\n      def initialize(reporter)\n        @reporter = reporter\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of examples\n      def examples\n        @reporter.examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of failed examples\n      def failed_examples\n        @reporter.failed_examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of pending examples\n      def pending_examples\n        @reporter.pending_examples\n      end\n\n      # @return [Array<RSpec::Core::Notifications::ExampleNotification>]\n      #         returns examples as notifications\n      def notifications\n        @notifications ||= format_examples(examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::FailedExampleNotification>]\n      #         returns failed examples as notifications\n      def failure_notifications\n        @failed_notifications ||= format_examples(failed_examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::SkippedExampleNotification,\n      #                 RSpec::Core::Notifications::PendingExampleFailedAsExpectedNotification>]\n      #         returns pending examples as notifications\n      def pending_notifications\n        @pending_notifications ||= format_examples(pending_examples)\n      end\n\n      # @return [String] The list of failed examples, fully formatted in the way\n      #   that RSpec's built-in formatters emit.\n      def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFailures:\\n\"\n\n        failure_notifications.each_with_index do |failure, index|\n          formatted += failure.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n      # @return [String] The list of pending examples, fully formatted in the\n      #   way that RSpec's built-in formatters emit.\n      def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        return if RSpec.configuration.pending_failure_output == :skip\n\n        formatted = \"\\nPending: (Failures listed here are expected and do not affect your suite's status)\\n\".dup\n\n        pending_notifications.each_with_index do |notification, index|\n          formatted << notification.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n    private\n\n      def format_examples(examples)\n        examples.map do |example|\n          ExampleNotification.for(example)\n        end\n      end\n    end\n\n    # The `FailedExampleNotification` extends `ExampleNotification` with\n    # things useful for examples that have failure info -- typically a\n    # failed or pending spec.\n    #\n    # @example\n    #   def example_failed(notification)\n    #     puts \"Hey I failed :(\"\n    #     puts \"Here's my stack trace\"\n    #     puts notification.exception.backtrace.join(\"\\n\")\n    #   end\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class FailedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [Exception] The example failure\n      def exception\n        @exception_presenter.exception\n      end\n\n      # @return [String] The example description\n      def description\n        @exception_presenter.description\n      end\n\n      # Returns the message generated for this failure line by line.\n      #\n      # @return [Array<String>] The example failure message\n      def message_lines\n        @exception_presenter.message_lines\n      end\n\n      # Returns the message generated for this failure colorized line by line.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] The example failure message colorized\n      def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_message_lines(colorizer)\n      end\n\n      # Returns the failures formatted backtrace.\n      #\n      # @return [Array<String>] the examples backtrace lines\n      def formatted_backtrace\n        @exception_presenter.formatted_backtrace\n      end\n\n      # Returns the failures colorized formatted backtrace.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] the examples colorized backtrace lines\n      def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_formatted_backtrace(colorizer)\n      end\n\n      # @return [String] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted(failure_number, colorizer)\n      end\n\n      # @return [Array<string>] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit, split by line.\n      def fully_formatted_lines(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted_lines(failure_number, colorizer)\n      end\n\n    private\n\n      def initialize(example, exception_presenter=Formatters::ExceptionPresenter::Factory.new(example).build)\n        @exception_presenter = exception_presenter\n        super(example)\n      end\n    end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFixedNotification < FailedExampleNotification; end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification; end\n\n    # The `SkippedExampleNotification` extends `ExampleNotification` with\n    # things useful for specs that are skipped.\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class SkippedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [String] The pending detail fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)\n\n        [\n          colorizer.wrap(\"\\n  #{pending_number}) #{example.full_description}\", :pending),\n          \"\\n     \",\n          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer),\n          \"\\n\",\n          colorizer.wrap(\"     # #{formatted_caller}\\n\", :detail)\n        ].join(\"\")\n      end\n    end\n\n    # The `GroupNotification` represents notifications sent by the reporter\n    # which contain information about the currently running (or soon to be)\n    # example group. It is used by formatters to access information about that\n    # group.\n    #\n    # @example\n    #   def example_group_started(notification)\n    #     puts \"Hey I started #{notification.group.description}\"\n    #   end\n    # @attr group [RSpec::Core::ExampleGroup] the current group\n    GroupNotification = Struct.new(:group)\n\n    # The `MessageNotification` encapsulates generic messages that the reporter\n    # sends to formatters.\n    #\n    # @attr message [String] the message\n    MessageNotification = Struct.new(:message)\n\n    # The `SeedNotification` holds the seed used to randomize examples and\n    # whether that seed has been used or not.\n    #\n    # @attr seed [Fixnum] the seed used to randomize ordering\n    # @attr used [Boolean] whether the seed has been used or not\n    SeedNotification = Struct.new(:seed, :used)\n    class SeedNotification\n      # @api\n      # @return [Boolean] has the seed been used?\n      def seed_used?\n        !!used\n      end\n      private :used\n\n      # @return [String] The seed information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted\n        \"\\nRandomized with seed #{seed}\\n\"\n      end\n    end\n\n    # The `SummaryNotification` holds information about the results of running\n    # a test suite. It is used by formatters to provide information at the end\n    # of the test run.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr failed_examples [Array<RSpec::Core::Example>] the failed examples\n    # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    # @attr errors_outside_of_examples_count [Integer] the number of errors that\n    #                                                  have occurred processing\n    #                                                  the spec suite\n    SummaryNotification = Struct.new(:duration, :examples, :failed_examples,\n                                     :pending_examples, :load_time,\n                                     :errors_outside_of_examples_count)\n    class SummaryNotification\n      # @api\n      # @return [Fixnum] the number of examples run\n      def example_count\n        @example_count ||= examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of failed examples\n      def failure_count\n        @failure_count ||= failed_examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of pending examples\n      def pending_count\n        @pending_count ||= pending_examples.size\n      end\n\n      # @api\n      # @return [String] A line summarising the result totals of the spec run.\n      def totals_line\n        summary = Formatters::Helpers.pluralize(example_count, \"example\") +\n          \", \" + Formatters::Helpers.pluralize(failure_count, \"failure\")\n        summary += \", #{pending_count} pending\" if pending_count > 0\n        if errors_outside_of_examples_count > 0\n          summary += (\n            \", \" +\n            Formatters::Helpers.pluralize(errors_outside_of_examples_count, \"error\") +\n            \" occurred outside of examples\"\n          )\n        end\n        summary\n      end\n\n      # @api public\n      #\n      # Wraps the results line with colors based on the configured\n      # colors for failure, pending, and success. Defaults to red,\n      # yellow, green accordingly.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized results line.\n      def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        if failure_count > 0 || errors_outside_of_examples_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.failure_color)\n        elsif pending_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.pending_color)\n        else\n          colorizer.wrap(totals_line, RSpec.configuration.success_color)\n        end\n      end\n\n      # @api public\n      #\n      # Formats failures into a rerunable command format.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized summary line.\n      def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        \"\\nFailed examples:\\n\\n\" +\n        failed_examples.map do |example|\n          colorizer.wrap(\"rspec #{rerun_argument_for(example)}\", RSpec.configuration.failure_color) + \" \" +\n          colorizer.wrap(\"# #{example.full_description}\",   RSpec.configuration.detail_color)\n        end.join(\"\\n\")\n      end\n\n      # @return [String] a formatted version of the time it took to run the\n      #   suite\n      def formatted_duration\n        Formatters::Helpers.format_duration(duration)\n      end\n\n      # @return [String] a formatted version of the time it took to boot RSpec\n      #   and load the spec files\n      def formatted_load_time\n        Formatters::Helpers.format_duration(load_time)\n      end\n\n      # @return [String] The summary information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFinished in #{formatted_duration} \" \\\n                    \"(files took #{formatted_load_time} to load)\\n\" \\\n                    \"#{colorized_totals_line(colorizer)}\\n\"\n\n        unless failed_examples.empty?\n          formatted += (colorized_rerun_commands(colorizer) + \"\\n\")\n        end\n\n        formatted\n      end\n\n    private\n\n      include RSpec::Core::ShellEscape\n\n      def rerun_argument_for(example)\n        location = example.location_rerun_argument\n\n        return location unless duplicate_rerun_locations.include?(location)\n        return location if RSpec.configuration.force_line_number_for_spec_rerun\n        conditionally_quote(example.id)\n      end\n\n      def duplicate_rerun_locations\n        @duplicate_rerun_locations ||= begin\n          locations = RSpec.world.all_examples.map(&:location_rerun_argument)\n\n          Set.new.tap do |s|\n            locations.group_by { |l| l }.each do |l, ls|\n              s << l if ls.count > 1\n            end\n          end\n        end\n      end\n    end\n\n    # The `ProfileNotification` holds information about the results of running a\n    # test suite when profiling is enabled. It is used by formatters to provide\n    # information at the end of the test run for profiling information.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr number_of_examples [Fixnum] the number of examples to profile\n    # @attr example_groups [Array<RSpec::Core::Profiler>] example groups run\n    class ProfileNotification\n      def initialize(duration, examples, number_of_examples, example_groups)\n        @duration = duration\n        @examples = examples\n        @number_of_examples = number_of_examples\n        @example_groups = example_groups\n      end\n      attr_reader :duration, :examples, :number_of_examples\n\n      # @return [Array<RSpec::Core::Example>] the slowest examples\n      def slowest_examples\n        @slowest_examples ||=\n          examples.sort_by do |example|\n            -example.execution_result.run_time\n          end.first(number_of_examples)\n      end\n\n      # @return [Float] the time taken (in seconds) to run the slowest examples\n      def slow_duration\n        @slow_duration ||=\n          slowest_examples.inject(0.0) do |i, e|\n            i + e.execution_result.run_time\n          end\n      end\n\n      # @return [String] the percentage of total time taken\n      def percentage\n        @percentage ||=\n          begin\n            time_taken = slow_duration / duration\n            '%.1f' % ((time_taken.nan? ? 0.0 : time_taken) * 100)\n          end\n      end\n\n      # @return [Array<RSpec::Core::Example>] the slowest example groups\n      def slowest_groups\n        @slowest_groups ||= calculate_slowest_groups\n      end\n\n    private\n\n      def calculate_slowest_groups\n        # stop if we've only one example group\n        return {} if @example_groups.keys.length <= 1\n\n        @example_groups.each_value do |hash|\n          hash[:average] = hash[:total_time].to_f / hash[:count]\n        end\n\n        groups = @example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)\n        groups.map { |group, data| [group.location, data] }\n      end\n    end\n\n    # The `DeprecationNotification` is issued by the reporter when a deprecated\n    # part of RSpec is encountered. It represents information about the\n    # deprecated call site.\n    #\n    # @attr message [String] A custom message about the deprecation\n    # @attr deprecated [String] A custom message about the deprecation (alias of\n    #   message)\n    # @attr replacement [String] An optional replacement for the deprecation\n    # @attr call_site [String] An optional call site from which the deprecation\n    #   was issued\n    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site)\n    class DeprecationNotification\n      private_class_method :new\n\n      # @api\n      # Convenience way to initialize the notification\n      def self.from_hash(data)\n        new data[:deprecated], data[:message], data[:replacement], data[:call_site]\n      end\n    end\n\n    # `NullNotification` represents a placeholder value for notifications that\n    # currently require no information, but we may wish to extend in future.\n    class NullNotification\n    end\n\n    # `CustomNotification` is used when sending custom events to formatters /\n    # other registered listeners, it creates attributes based on supplied hash\n    # of options.\n    class CustomNotification < Struct\n      # @param options [Hash] A hash of method / value pairs to create on this notification\n      # @return [CustomNotification]\n      #\n      # Build a custom notification based on the supplied option key / values.\n      def self.for(options={})\n        return NullNotification if options.keys.empty?\n        new(*options.keys).new(*options.values)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "for", "signature": "def self.for(example)", "start_line": 41, "end_line": 56}, "metadata": {"module": "RSpec", "class_name": "ExampleNotification", "class_signature": "class ExampleNotification"}, "task_id": 286}
{"function_name": "fully_formatted", "file_path": "rspec-core/lib/rspec/core/notifications.rb", "focal_code": "def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)\n\n        [\n          colorizer.wrap(\"\\n  #{pending_number}) #{example.full_description}\", :pending),\n          \"\\n     \",\n          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer),\n          \"\\n\",\n          colorizer.wrap(\"     # #{formatted_caller}\\n\", :detail)\n        ].join(\"\")\n      end", "file_content": "RSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/exception_presenter\"\nRSpec::Support.require_rspec_core \"formatters/helpers\"\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec::Core\n  # Notifications are value objects passed to formatters to provide them\n  # with information about a particular event of interest.\n  module Notifications\n    # @private\n    module NullColorizer\n      module_function\n\n      def wrap(line, _code_or_symbol)\n        line\n      end\n    end\n\n    # The `StartNotification` represents a notification sent by the reporter\n    # when the suite is started. It contains the expected amount of examples\n    # to be executed, and the load time of RSpec.\n    #\n    # @attr count [Fixnum] the number counted\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    StartNotification = Struct.new(:count, :load_time)\n\n    # The `ExampleNotification` represents notifications sent by the reporter\n    # which contain information about the current (or soon to be) example.\n    # It is used by formatters to access information about that example.\n    #\n    # @example\n    #   def example_started(notification)\n    #     puts \"Hey I started #{notification.example.description}\"\n    #   end\n    #\n    # @attr example [RSpec::Core::Example] the current example\n    ExampleNotification = Struct.new(:example)\n    class ExampleNotification\n      # @private\n      def self.for(example)\n        execution_result = example.execution_result\n\n        return SkippedExampleNotification.new(example) if execution_result.example_skipped?\n        return new(example) unless execution_result.status == :pending || execution_result.status == :failed\n\n        klass = if execution_result.pending_fixed?\n                  PendingExampleFixedNotification\n                elsif execution_result.status == :pending\n                  PendingExampleFailedAsExpectedNotification\n                else\n                  FailedExampleNotification\n                end\n\n        klass.new(example)\n      end\n\n      private_class_method :new\n    end\n\n    # The `ExamplesNotification` represents notifications sent by the reporter\n    # which contain information about the suites examples.\n    #\n    # @example\n    #   def stop(notification)\n    #     puts \"Hey I ran #{notification.examples.size}\"\n    #   end\n    #\n    class ExamplesNotification\n      def initialize(reporter)\n        @reporter = reporter\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of examples\n      def examples\n        @reporter.examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of failed examples\n      def failed_examples\n        @reporter.failed_examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of pending examples\n      def pending_examples\n        @reporter.pending_examples\n      end\n\n      # @return [Array<RSpec::Core::Notifications::ExampleNotification>]\n      #         returns examples as notifications\n      def notifications\n        @notifications ||= format_examples(examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::FailedExampleNotification>]\n      #         returns failed examples as notifications\n      def failure_notifications\n        @failed_notifications ||= format_examples(failed_examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::SkippedExampleNotification,\n      #                 RSpec::Core::Notifications::PendingExampleFailedAsExpectedNotification>]\n      #         returns pending examples as notifications\n      def pending_notifications\n        @pending_notifications ||= format_examples(pending_examples)\n      end\n\n      # @return [String] The list of failed examples, fully formatted in the way\n      #   that RSpec's built-in formatters emit.\n      def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFailures:\\n\"\n\n        failure_notifications.each_with_index do |failure, index|\n          formatted += failure.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n      # @return [String] The list of pending examples, fully formatted in the\n      #   way that RSpec's built-in formatters emit.\n      def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        return if RSpec.configuration.pending_failure_output == :skip\n\n        formatted = \"\\nPending: (Failures listed here are expected and do not affect your suite's status)\\n\".dup\n\n        pending_notifications.each_with_index do |notification, index|\n          formatted << notification.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n    private\n\n      def format_examples(examples)\n        examples.map do |example|\n          ExampleNotification.for(example)\n        end\n      end\n    end\n\n    # The `FailedExampleNotification` extends `ExampleNotification` with\n    # things useful for examples that have failure info -- typically a\n    # failed or pending spec.\n    #\n    # @example\n    #   def example_failed(notification)\n    #     puts \"Hey I failed :(\"\n    #     puts \"Here's my stack trace\"\n    #     puts notification.exception.backtrace.join(\"\\n\")\n    #   end\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class FailedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [Exception] The example failure\n      def exception\n        @exception_presenter.exception\n      end\n\n      # @return [String] The example description\n      def description\n        @exception_presenter.description\n      end\n\n      # Returns the message generated for this failure line by line.\n      #\n      # @return [Array<String>] The example failure message\n      def message_lines\n        @exception_presenter.message_lines\n      end\n\n      # Returns the message generated for this failure colorized line by line.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] The example failure message colorized\n      def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_message_lines(colorizer)\n      end\n\n      # Returns the failures formatted backtrace.\n      #\n      # @return [Array<String>] the examples backtrace lines\n      def formatted_backtrace\n        @exception_presenter.formatted_backtrace\n      end\n\n      # Returns the failures colorized formatted backtrace.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] the examples colorized backtrace lines\n      def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_formatted_backtrace(colorizer)\n      end\n\n      # @return [String] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted(failure_number, colorizer)\n      end\n\n      # @return [Array<string>] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit, split by line.\n      def fully_formatted_lines(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted_lines(failure_number, colorizer)\n      end\n\n    private\n\n      def initialize(example, exception_presenter=Formatters::ExceptionPresenter::Factory.new(example).build)\n        @exception_presenter = exception_presenter\n        super(example)\n      end\n    end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFixedNotification < FailedExampleNotification; end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification; end\n\n    # The `SkippedExampleNotification` extends `ExampleNotification` with\n    # things useful for specs that are skipped.\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class SkippedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [String] The pending detail fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)\n\n        [\n          colorizer.wrap(\"\\n  #{pending_number}) #{example.full_description}\", :pending),\n          \"\\n     \",\n          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer),\n          \"\\n\",\n          colorizer.wrap(\"     # #{formatted_caller}\\n\", :detail)\n        ].join(\"\")\n      end\n    end\n\n    # The `GroupNotification` represents notifications sent by the reporter\n    # which contain information about the currently running (or soon to be)\n    # example group. It is used by formatters to access information about that\n    # group.\n    #\n    # @example\n    #   def example_group_started(notification)\n    #     puts \"Hey I started #{notification.group.description}\"\n    #   end\n    # @attr group [RSpec::Core::ExampleGroup] the current group\n    GroupNotification = Struct.new(:group)\n\n    # The `MessageNotification` encapsulates generic messages that the reporter\n    # sends to formatters.\n    #\n    # @attr message [String] the message\n    MessageNotification = Struct.new(:message)\n\n    # The `SeedNotification` holds the seed used to randomize examples and\n    # whether that seed has been used or not.\n    #\n    # @attr seed [Fixnum] the seed used to randomize ordering\n    # @attr used [Boolean] whether the seed has been used or not\n    SeedNotification = Struct.new(:seed, :used)\n    class SeedNotification\n      # @api\n      # @return [Boolean] has the seed been used?\n      def seed_used?\n        !!used\n      end\n      private :used\n\n      # @return [String] The seed information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted\n        \"\\nRandomized with seed #{seed}\\n\"\n      end\n    end\n\n    # The `SummaryNotification` holds information about the results of running\n    # a test suite. It is used by formatters to provide information at the end\n    # of the test run.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr failed_examples [Array<RSpec::Core::Example>] the failed examples\n    # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    # @attr errors_outside_of_examples_count [Integer] the number of errors that\n    #                                                  have occurred processing\n    #                                                  the spec suite\n    SummaryNotification = Struct.new(:duration, :examples, :failed_examples,\n                                     :pending_examples, :load_time,\n                                     :errors_outside_of_examples_count)\n    class SummaryNotification\n      # @api\n      # @return [Fixnum] the number of examples run\n      def example_count\n        @example_count ||= examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of failed examples\n      def failure_count\n        @failure_count ||= failed_examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of pending examples\n      def pending_count\n        @pending_count ||= pending_examples.size\n      end\n\n      # @api\n      # @return [String] A line summarising the result totals of the spec run.\n      def totals_line\n        summary = Formatters::Helpers.pluralize(example_count, \"example\") +\n          \", \" + Formatters::Helpers.pluralize(failure_count, \"failure\")\n        summary += \", #{pending_count} pending\" if pending_count > 0\n        if errors_outside_of_examples_count > 0\n          summary += (\n            \", \" +\n            Formatters::Helpers.pluralize(errors_outside_of_examples_count, \"error\") +\n            \" occurred outside of examples\"\n          )\n        end\n        summary\n      end\n\n      # @api public\n      #\n      # Wraps the results line with colors based on the configured\n      # colors for failure, pending, and success. Defaults to red,\n      # yellow, green accordingly.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized results line.\n      def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        if failure_count > 0 || errors_outside_of_examples_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.failure_color)\n        elsif pending_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.pending_color)\n        else\n          colorizer.wrap(totals_line, RSpec.configuration.success_color)\n        end\n      end\n\n      # @api public\n      #\n      # Formats failures into a rerunable command format.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized summary line.\n      def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        \"\\nFailed examples:\\n\\n\" +\n        failed_examples.map do |example|\n          colorizer.wrap(\"rspec #{rerun_argument_for(example)}\", RSpec.configuration.failure_color) + \" \" +\n          colorizer.wrap(\"# #{example.full_description}\",   RSpec.configuration.detail_color)\n        end.join(\"\\n\")\n      end\n\n      # @return [String] a formatted version of the time it took to run the\n      #   suite\n      def formatted_duration\n        Formatters::Helpers.format_duration(duration)\n      end\n\n      # @return [String] a formatted version of the time it took to boot RSpec\n      #   and load the spec files\n      def formatted_load_time\n        Formatters::Helpers.format_duration(load_time)\n      end\n\n      # @return [String] The summary information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFinished in #{formatted_duration} \" \\\n                    \"(files took #{formatted_load_time} to load)\\n\" \\\n                    \"#{colorized_totals_line(colorizer)}\\n\"\n\n        unless failed_examples.empty?\n          formatted += (colorized_rerun_commands(colorizer) + \"\\n\")\n        end\n\n        formatted\n      end\n\n    private\n\n      include RSpec::Core::ShellEscape\n\n      def rerun_argument_for(example)\n        location = example.location_rerun_argument\n\n        return location unless duplicate_rerun_locations.include?(location)\n        return location if RSpec.configuration.force_line_number_for_spec_rerun\n        conditionally_quote(example.id)\n      end\n\n      def duplicate_rerun_locations\n        @duplicate_rerun_locations ||= begin\n          locations = RSpec.world.all_examples.map(&:location_rerun_argument)\n\n          Set.new.tap do |s|\n            locations.group_by { |l| l }.each do |l, ls|\n              s << l if ls.count > 1\n            end\n          end\n        end\n      end\n    end\n\n    # The `ProfileNotification` holds information about the results of running a\n    # test suite when profiling is enabled. It is used by formatters to provide\n    # information at the end of the test run for profiling information.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr number_of_examples [Fixnum] the number of examples to profile\n    # @attr example_groups [Array<RSpec::Core::Profiler>] example groups run\n    class ProfileNotification\n      def initialize(duration, examples, number_of_examples, example_groups)\n        @duration = duration\n        @examples = examples\n        @number_of_examples = number_of_examples\n        @example_groups = example_groups\n      end\n      attr_reader :duration, :examples, :number_of_examples\n\n      # @return [Array<RSpec::Core::Example>] the slowest examples\n      def slowest_examples\n        @slowest_examples ||=\n          examples.sort_by do |example|\n            -example.execution_result.run_time\n          end.first(number_of_examples)\n      end\n\n      # @return [Float] the time taken (in seconds) to run the slowest examples\n      def slow_duration\n        @slow_duration ||=\n          slowest_examples.inject(0.0) do |i, e|\n            i + e.execution_result.run_time\n          end\n      end\n\n      # @return [String] the percentage of total time taken\n      def percentage\n        @percentage ||=\n          begin\n            time_taken = slow_duration / duration\n            '%.1f' % ((time_taken.nan? ? 0.0 : time_taken) * 100)\n          end\n      end\n\n      # @return [Array<RSpec::Core::Example>] the slowest example groups\n      def slowest_groups\n        @slowest_groups ||= calculate_slowest_groups\n      end\n\n    private\n\n      def calculate_slowest_groups\n        # stop if we've only one example group\n        return {} if @example_groups.keys.length <= 1\n\n        @example_groups.each_value do |hash|\n          hash[:average] = hash[:total_time].to_f / hash[:count]\n        end\n\n        groups = @example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)\n        groups.map { |group, data| [group.location, data] }\n      end\n    end\n\n    # The `DeprecationNotification` is issued by the reporter when a deprecated\n    # part of RSpec is encountered. It represents information about the\n    # deprecated call site.\n    #\n    # @attr message [String] A custom message about the deprecation\n    # @attr deprecated [String] A custom message about the deprecation (alias of\n    #   message)\n    # @attr replacement [String] An optional replacement for the deprecation\n    # @attr call_site [String] An optional call site from which the deprecation\n    #   was issued\n    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site)\n    class DeprecationNotification\n      private_class_method :new\n\n      # @api\n      # Convenience way to initialize the notification\n      def self.from_hash(data)\n        new data[:deprecated], data[:message], data[:replacement], data[:call_site]\n      end\n    end\n\n    # `NullNotification` represents a placeholder value for notifications that\n    # currently require no information, but we may wish to extend in future.\n    class NullNotification\n    end\n\n    # `CustomNotification` is used when sending custom events to formatters /\n    # other registered listeners, it creates attributes based on supplied hash\n    # of options.\n    class CustomNotification < Struct\n      # @param options [Hash] A hash of method / value pairs to create on this notification\n      # @return [CustomNotification]\n      #\n      # Build a custom notification based on the supplied option key / values.\n      def self.for(options={})\n        return NullNotification if options.keys.empty?\n        new(*options.keys).new(*options.values)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "fully_formatted", "signature": "def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)", "start_line": 235, "end_line": 245}, "metadata": {"module": "RSpec", "class_name": "SkippedExampleNotification", "class_signature": "class SkippedExampleNotification < < ExampleNotification"}, "task_id": 287}
{"function_name": "totals_line", "file_path": "rspec-core/lib/rspec/core/notifications.rb", "focal_code": "def totals_line\n        summary = Formatters::Helpers.pluralize(example_count, \"example\") +\n          \", \" + Formatters::Helpers.pluralize(failure_count, \"failure\")\n        summary += \", #{pending_count} pending\" if pending_count > 0\n        if errors_outside_of_examples_count > 0\n          summary += (\n            \", \" +\n            Formatters::Helpers.pluralize(errors_outside_of_examples_count, \"error\") +\n            \" occurred outside of examples\"\n          )\n        end\n        summary\n      end", "file_content": "RSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/exception_presenter\"\nRSpec::Support.require_rspec_core \"formatters/helpers\"\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec::Core\n  # Notifications are value objects passed to formatters to provide them\n  # with information about a particular event of interest.\n  module Notifications\n    # @private\n    module NullColorizer\n      module_function\n\n      def wrap(line, _code_or_symbol)\n        line\n      end\n    end\n\n    # The `StartNotification` represents a notification sent by the reporter\n    # when the suite is started. It contains the expected amount of examples\n    # to be executed, and the load time of RSpec.\n    #\n    # @attr count [Fixnum] the number counted\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    StartNotification = Struct.new(:count, :load_time)\n\n    # The `ExampleNotification` represents notifications sent by the reporter\n    # which contain information about the current (or soon to be) example.\n    # It is used by formatters to access information about that example.\n    #\n    # @example\n    #   def example_started(notification)\n    #     puts \"Hey I started #{notification.example.description}\"\n    #   end\n    #\n    # @attr example [RSpec::Core::Example] the current example\n    ExampleNotification = Struct.new(:example)\n    class ExampleNotification\n      # @private\n      def self.for(example)\n        execution_result = example.execution_result\n\n        return SkippedExampleNotification.new(example) if execution_result.example_skipped?\n        return new(example) unless execution_result.status == :pending || execution_result.status == :failed\n\n        klass = if execution_result.pending_fixed?\n                  PendingExampleFixedNotification\n                elsif execution_result.status == :pending\n                  PendingExampleFailedAsExpectedNotification\n                else\n                  FailedExampleNotification\n                end\n\n        klass.new(example)\n      end\n\n      private_class_method :new\n    end\n\n    # The `ExamplesNotification` represents notifications sent by the reporter\n    # which contain information about the suites examples.\n    #\n    # @example\n    #   def stop(notification)\n    #     puts \"Hey I ran #{notification.examples.size}\"\n    #   end\n    #\n    class ExamplesNotification\n      def initialize(reporter)\n        @reporter = reporter\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of examples\n      def examples\n        @reporter.examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of failed examples\n      def failed_examples\n        @reporter.failed_examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of pending examples\n      def pending_examples\n        @reporter.pending_examples\n      end\n\n      # @return [Array<RSpec::Core::Notifications::ExampleNotification>]\n      #         returns examples as notifications\n      def notifications\n        @notifications ||= format_examples(examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::FailedExampleNotification>]\n      #         returns failed examples as notifications\n      def failure_notifications\n        @failed_notifications ||= format_examples(failed_examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::SkippedExampleNotification,\n      #                 RSpec::Core::Notifications::PendingExampleFailedAsExpectedNotification>]\n      #         returns pending examples as notifications\n      def pending_notifications\n        @pending_notifications ||= format_examples(pending_examples)\n      end\n\n      # @return [String] The list of failed examples, fully formatted in the way\n      #   that RSpec's built-in formatters emit.\n      def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFailures:\\n\"\n\n        failure_notifications.each_with_index do |failure, index|\n          formatted += failure.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n      # @return [String] The list of pending examples, fully formatted in the\n      #   way that RSpec's built-in formatters emit.\n      def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        return if RSpec.configuration.pending_failure_output == :skip\n\n        formatted = \"\\nPending: (Failures listed here are expected and do not affect your suite's status)\\n\".dup\n\n        pending_notifications.each_with_index do |notification, index|\n          formatted << notification.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n    private\n\n      def format_examples(examples)\n        examples.map do |example|\n          ExampleNotification.for(example)\n        end\n      end\n    end\n\n    # The `FailedExampleNotification` extends `ExampleNotification` with\n    # things useful for examples that have failure info -- typically a\n    # failed or pending spec.\n    #\n    # @example\n    #   def example_failed(notification)\n    #     puts \"Hey I failed :(\"\n    #     puts \"Here's my stack trace\"\n    #     puts notification.exception.backtrace.join(\"\\n\")\n    #   end\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class FailedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [Exception] The example failure\n      def exception\n        @exception_presenter.exception\n      end\n\n      # @return [String] The example description\n      def description\n        @exception_presenter.description\n      end\n\n      # Returns the message generated for this failure line by line.\n      #\n      # @return [Array<String>] The example failure message\n      def message_lines\n        @exception_presenter.message_lines\n      end\n\n      # Returns the message generated for this failure colorized line by line.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] The example failure message colorized\n      def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_message_lines(colorizer)\n      end\n\n      # Returns the failures formatted backtrace.\n      #\n      # @return [Array<String>] the examples backtrace lines\n      def formatted_backtrace\n        @exception_presenter.formatted_backtrace\n      end\n\n      # Returns the failures colorized formatted backtrace.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] the examples colorized backtrace lines\n      def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_formatted_backtrace(colorizer)\n      end\n\n      # @return [String] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted(failure_number, colorizer)\n      end\n\n      # @return [Array<string>] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit, split by line.\n      def fully_formatted_lines(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted_lines(failure_number, colorizer)\n      end\n\n    private\n\n      def initialize(example, exception_presenter=Formatters::ExceptionPresenter::Factory.new(example).build)\n        @exception_presenter = exception_presenter\n        super(example)\n      end\n    end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFixedNotification < FailedExampleNotification; end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification; end\n\n    # The `SkippedExampleNotification` extends `ExampleNotification` with\n    # things useful for specs that are skipped.\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class SkippedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [String] The pending detail fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)\n\n        [\n          colorizer.wrap(\"\\n  #{pending_number}) #{example.full_description}\", :pending),\n          \"\\n     \",\n          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer),\n          \"\\n\",\n          colorizer.wrap(\"     # #{formatted_caller}\\n\", :detail)\n        ].join(\"\")\n      end\n    end\n\n    # The `GroupNotification` represents notifications sent by the reporter\n    # which contain information about the currently running (or soon to be)\n    # example group. It is used by formatters to access information about that\n    # group.\n    #\n    # @example\n    #   def example_group_started(notification)\n    #     puts \"Hey I started #{notification.group.description}\"\n    #   end\n    # @attr group [RSpec::Core::ExampleGroup] the current group\n    GroupNotification = Struct.new(:group)\n\n    # The `MessageNotification` encapsulates generic messages that the reporter\n    # sends to formatters.\n    #\n    # @attr message [String] the message\n    MessageNotification = Struct.new(:message)\n\n    # The `SeedNotification` holds the seed used to randomize examples and\n    # whether that seed has been used or not.\n    #\n    # @attr seed [Fixnum] the seed used to randomize ordering\n    # @attr used [Boolean] whether the seed has been used or not\n    SeedNotification = Struct.new(:seed, :used)\n    class SeedNotification\n      # @api\n      # @return [Boolean] has the seed been used?\n      def seed_used?\n        !!used\n      end\n      private :used\n\n      # @return [String] The seed information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted\n        \"\\nRandomized with seed #{seed}\\n\"\n      end\n    end\n\n    # The `SummaryNotification` holds information about the results of running\n    # a test suite. It is used by formatters to provide information at the end\n    # of the test run.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr failed_examples [Array<RSpec::Core::Example>] the failed examples\n    # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    # @attr errors_outside_of_examples_count [Integer] the number of errors that\n    #                                                  have occurred processing\n    #                                                  the spec suite\n    SummaryNotification = Struct.new(:duration, :examples, :failed_examples,\n                                     :pending_examples, :load_time,\n                                     :errors_outside_of_examples_count)\n    class SummaryNotification\n      # @api\n      # @return [Fixnum] the number of examples run\n      def example_count\n        @example_count ||= examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of failed examples\n      def failure_count\n        @failure_count ||= failed_examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of pending examples\n      def pending_count\n        @pending_count ||= pending_examples.size\n      end\n\n      # @api\n      # @return [String] A line summarising the result totals of the spec run.\n      def totals_line\n        summary = Formatters::Helpers.pluralize(example_count, \"example\") +\n          \", \" + Formatters::Helpers.pluralize(failure_count, \"failure\")\n        summary += \", #{pending_count} pending\" if pending_count > 0\n        if errors_outside_of_examples_count > 0\n          summary += (\n            \", \" +\n            Formatters::Helpers.pluralize(errors_outside_of_examples_count, \"error\") +\n            \" occurred outside of examples\"\n          )\n        end\n        summary\n      end\n\n      # @api public\n      #\n      # Wraps the results line with colors based on the configured\n      # colors for failure, pending, and success. Defaults to red,\n      # yellow, green accordingly.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized results line.\n      def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        if failure_count > 0 || errors_outside_of_examples_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.failure_color)\n        elsif pending_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.pending_color)\n        else\n          colorizer.wrap(totals_line, RSpec.configuration.success_color)\n        end\n      end\n\n      # @api public\n      #\n      # Formats failures into a rerunable command format.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized summary line.\n      def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        \"\\nFailed examples:\\n\\n\" +\n        failed_examples.map do |example|\n          colorizer.wrap(\"rspec #{rerun_argument_for(example)}\", RSpec.configuration.failure_color) + \" \" +\n          colorizer.wrap(\"# #{example.full_description}\",   RSpec.configuration.detail_color)\n        end.join(\"\\n\")\n      end\n\n      # @return [String] a formatted version of the time it took to run the\n      #   suite\n      def formatted_duration\n        Formatters::Helpers.format_duration(duration)\n      end\n\n      # @return [String] a formatted version of the time it took to boot RSpec\n      #   and load the spec files\n      def formatted_load_time\n        Formatters::Helpers.format_duration(load_time)\n      end\n\n      # @return [String] The summary information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFinished in #{formatted_duration} \" \\\n                    \"(files took #{formatted_load_time} to load)\\n\" \\\n                    \"#{colorized_totals_line(colorizer)}\\n\"\n\n        unless failed_examples.empty?\n          formatted += (colorized_rerun_commands(colorizer) + \"\\n\")\n        end\n\n        formatted\n      end\n\n    private\n\n      include RSpec::Core::ShellEscape\n\n      def rerun_argument_for(example)\n        location = example.location_rerun_argument\n\n        return location unless duplicate_rerun_locations.include?(location)\n        return location if RSpec.configuration.force_line_number_for_spec_rerun\n        conditionally_quote(example.id)\n      end\n\n      def duplicate_rerun_locations\n        @duplicate_rerun_locations ||= begin\n          locations = RSpec.world.all_examples.map(&:location_rerun_argument)\n\n          Set.new.tap do |s|\n            locations.group_by { |l| l }.each do |l, ls|\n              s << l if ls.count > 1\n            end\n          end\n        end\n      end\n    end\n\n    # The `ProfileNotification` holds information about the results of running a\n    # test suite when profiling is enabled. It is used by formatters to provide\n    # information at the end of the test run for profiling information.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr number_of_examples [Fixnum] the number of examples to profile\n    # @attr example_groups [Array<RSpec::Core::Profiler>] example groups run\n    class ProfileNotification\n      def initialize(duration, examples, number_of_examples, example_groups)\n        @duration = duration\n        @examples = examples\n        @number_of_examples = number_of_examples\n        @example_groups = example_groups\n      end\n      attr_reader :duration, :examples, :number_of_examples\n\n      # @return [Array<RSpec::Core::Example>] the slowest examples\n      def slowest_examples\n        @slowest_examples ||=\n          examples.sort_by do |example|\n            -example.execution_result.run_time\n          end.first(number_of_examples)\n      end\n\n      # @return [Float] the time taken (in seconds) to run the slowest examples\n      def slow_duration\n        @slow_duration ||=\n          slowest_examples.inject(0.0) do |i, e|\n            i + e.execution_result.run_time\n          end\n      end\n\n      # @return [String] the percentage of total time taken\n      def percentage\n        @percentage ||=\n          begin\n            time_taken = slow_duration / duration\n            '%.1f' % ((time_taken.nan? ? 0.0 : time_taken) * 100)\n          end\n      end\n\n      # @return [Array<RSpec::Core::Example>] the slowest example groups\n      def slowest_groups\n        @slowest_groups ||= calculate_slowest_groups\n      end\n\n    private\n\n      def calculate_slowest_groups\n        # stop if we've only one example group\n        return {} if @example_groups.keys.length <= 1\n\n        @example_groups.each_value do |hash|\n          hash[:average] = hash[:total_time].to_f / hash[:count]\n        end\n\n        groups = @example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)\n        groups.map { |group, data| [group.location, data] }\n      end\n    end\n\n    # The `DeprecationNotification` is issued by the reporter when a deprecated\n    # part of RSpec is encountered. It represents information about the\n    # deprecated call site.\n    #\n    # @attr message [String] A custom message about the deprecation\n    # @attr deprecated [String] A custom message about the deprecation (alias of\n    #   message)\n    # @attr replacement [String] An optional replacement for the deprecation\n    # @attr call_site [String] An optional call site from which the deprecation\n    #   was issued\n    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site)\n    class DeprecationNotification\n      private_class_method :new\n\n      # @api\n      # Convenience way to initialize the notification\n      def self.from_hash(data)\n        new data[:deprecated], data[:message], data[:replacement], data[:call_site]\n      end\n    end\n\n    # `NullNotification` represents a placeholder value for notifications that\n    # currently require no information, but we may wish to extend in future.\n    class NullNotification\n    end\n\n    # `CustomNotification` is used when sending custom events to formatters /\n    # other registered listeners, it creates attributes based on supplied hash\n    # of options.\n    class CustomNotification < Struct\n      # @param options [Hash] A hash of method / value pairs to create on this notification\n      # @return [CustomNotification]\n      #\n      # Build a custom notification based on the supplied option key / values.\n      def self.for(options={})\n        return NullNotification if options.keys.empty?\n        new(*options.keys).new(*options.values)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "totals_line", "signature": "def totals_line summary = Formatters::Helpers.pluralize(example_count, \"example\") +", "start_line": 324, "end_line": 336}, "metadata": {"module": "RSpec", "class_name": "SummaryNotification", "class_signature": "class SummaryNotification"}, "task_id": 288}
{"function_name": "duplicate_rerun_locations", "file_path": "rspec-core/lib/rspec/core/notifications.rb", "focal_code": "def duplicate_rerun_locations\n        @duplicate_rerun_locations ||= begin\n          locations = RSpec.world.all_examples.map(&:location_rerun_argument)\n\n          Set.new.tap do |s|\n            locations.group_by { |l| l }.each do |l, ls|\n              s << l if ls.count > 1\n            end\n          end\n        end\n      end", "file_content": "RSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/exception_presenter\"\nRSpec::Support.require_rspec_core \"formatters/helpers\"\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec::Core\n  # Notifications are value objects passed to formatters to provide them\n  # with information about a particular event of interest.\n  module Notifications\n    # @private\n    module NullColorizer\n      module_function\n\n      def wrap(line, _code_or_symbol)\n        line\n      end\n    end\n\n    # The `StartNotification` represents a notification sent by the reporter\n    # when the suite is started. It contains the expected amount of examples\n    # to be executed, and the load time of RSpec.\n    #\n    # @attr count [Fixnum] the number counted\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    StartNotification = Struct.new(:count, :load_time)\n\n    # The `ExampleNotification` represents notifications sent by the reporter\n    # which contain information about the current (or soon to be) example.\n    # It is used by formatters to access information about that example.\n    #\n    # @example\n    #   def example_started(notification)\n    #     puts \"Hey I started #{notification.example.description}\"\n    #   end\n    #\n    # @attr example [RSpec::Core::Example] the current example\n    ExampleNotification = Struct.new(:example)\n    class ExampleNotification\n      # @private\n      def self.for(example)\n        execution_result = example.execution_result\n\n        return SkippedExampleNotification.new(example) if execution_result.example_skipped?\n        return new(example) unless execution_result.status == :pending || execution_result.status == :failed\n\n        klass = if execution_result.pending_fixed?\n                  PendingExampleFixedNotification\n                elsif execution_result.status == :pending\n                  PendingExampleFailedAsExpectedNotification\n                else\n                  FailedExampleNotification\n                end\n\n        klass.new(example)\n      end\n\n      private_class_method :new\n    end\n\n    # The `ExamplesNotification` represents notifications sent by the reporter\n    # which contain information about the suites examples.\n    #\n    # @example\n    #   def stop(notification)\n    #     puts \"Hey I ran #{notification.examples.size}\"\n    #   end\n    #\n    class ExamplesNotification\n      def initialize(reporter)\n        @reporter = reporter\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of examples\n      def examples\n        @reporter.examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of failed examples\n      def failed_examples\n        @reporter.failed_examples\n      end\n\n      # @return [Array<RSpec::Core::Example>] list of pending examples\n      def pending_examples\n        @reporter.pending_examples\n      end\n\n      # @return [Array<RSpec::Core::Notifications::ExampleNotification>]\n      #         returns examples as notifications\n      def notifications\n        @notifications ||= format_examples(examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::FailedExampleNotification>]\n      #         returns failed examples as notifications\n      def failure_notifications\n        @failed_notifications ||= format_examples(failed_examples)\n      end\n\n      # @return [Array<RSpec::Core::Notifications::SkippedExampleNotification,\n      #                 RSpec::Core::Notifications::PendingExampleFailedAsExpectedNotification>]\n      #         returns pending examples as notifications\n      def pending_notifications\n        @pending_notifications ||= format_examples(pending_examples)\n      end\n\n      # @return [String] The list of failed examples, fully formatted in the way\n      #   that RSpec's built-in formatters emit.\n      def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFailures:\\n\"\n\n        failure_notifications.each_with_index do |failure, index|\n          formatted += failure.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n      # @return [String] The list of pending examples, fully formatted in the\n      #   way that RSpec's built-in formatters emit.\n      def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        return if RSpec.configuration.pending_failure_output == :skip\n\n        formatted = \"\\nPending: (Failures listed here are expected and do not affect your suite's status)\\n\".dup\n\n        pending_notifications.each_with_index do |notification, index|\n          formatted << notification.fully_formatted(index.next, colorizer)\n        end\n\n        formatted\n      end\n\n    private\n\n      def format_examples(examples)\n        examples.map do |example|\n          ExampleNotification.for(example)\n        end\n      end\n    end\n\n    # The `FailedExampleNotification` extends `ExampleNotification` with\n    # things useful for examples that have failure info -- typically a\n    # failed or pending spec.\n    #\n    # @example\n    #   def example_failed(notification)\n    #     puts \"Hey I failed :(\"\n    #     puts \"Here's my stack trace\"\n    #     puts notification.exception.backtrace.join(\"\\n\")\n    #   end\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class FailedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [Exception] The example failure\n      def exception\n        @exception_presenter.exception\n      end\n\n      # @return [String] The example description\n      def description\n        @exception_presenter.description\n      end\n\n      # Returns the message generated for this failure line by line.\n      #\n      # @return [Array<String>] The example failure message\n      def message_lines\n        @exception_presenter.message_lines\n      end\n\n      # Returns the message generated for this failure colorized line by line.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] The example failure message colorized\n      def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_message_lines(colorizer)\n      end\n\n      # Returns the failures formatted backtrace.\n      #\n      # @return [Array<String>] the examples backtrace lines\n      def formatted_backtrace\n        @exception_presenter.formatted_backtrace\n      end\n\n      # Returns the failures colorized formatted backtrace.\n      #\n      # @param colorizer [#wrap] An object to colorize the message_lines by\n      # @return [Array<String>] the examples colorized backtrace lines\n      def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.colorized_formatted_backtrace(colorizer)\n      end\n\n      # @return [String] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted(failure_number, colorizer)\n      end\n\n      # @return [Array<string>] The failure information fully formatted in the way that\n      #   RSpec's built-in formatters emit, split by line.\n      def fully_formatted_lines(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        @exception_presenter.fully_formatted_lines(failure_number, colorizer)\n      end\n\n    private\n\n      def initialize(example, exception_presenter=Formatters::ExceptionPresenter::Factory.new(example).build)\n        @exception_presenter = exception_presenter\n        super(example)\n      end\n    end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFixedNotification < FailedExampleNotification; end\n\n    # @deprecated Use {FailedExampleNotification} instead.\n    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification; end\n\n    # The `SkippedExampleNotification` extends `ExampleNotification` with\n    # things useful for specs that are skipped.\n    #\n    # @attr [RSpec::Core::Example] example the current example\n    # @see ExampleNotification\n    class SkippedExampleNotification < ExampleNotification\n      public_class_method :new\n\n      # @return [String] The pending detail fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)\n\n        [\n          colorizer.wrap(\"\\n  #{pending_number}) #{example.full_description}\", :pending),\n          \"\\n     \",\n          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer),\n          \"\\n\",\n          colorizer.wrap(\"     # #{formatted_caller}\\n\", :detail)\n        ].join(\"\")\n      end\n    end\n\n    # The `GroupNotification` represents notifications sent by the reporter\n    # which contain information about the currently running (or soon to be)\n    # example group. It is used by formatters to access information about that\n    # group.\n    #\n    # @example\n    #   def example_group_started(notification)\n    #     puts \"Hey I started #{notification.group.description}\"\n    #   end\n    # @attr group [RSpec::Core::ExampleGroup] the current group\n    GroupNotification = Struct.new(:group)\n\n    # The `MessageNotification` encapsulates generic messages that the reporter\n    # sends to formatters.\n    #\n    # @attr message [String] the message\n    MessageNotification = Struct.new(:message)\n\n    # The `SeedNotification` holds the seed used to randomize examples and\n    # whether that seed has been used or not.\n    #\n    # @attr seed [Fixnum] the seed used to randomize ordering\n    # @attr used [Boolean] whether the seed has been used or not\n    SeedNotification = Struct.new(:seed, :used)\n    class SeedNotification\n      # @api\n      # @return [Boolean] has the seed been used?\n      def seed_used?\n        !!used\n      end\n      private :used\n\n      # @return [String] The seed information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted\n        \"\\nRandomized with seed #{seed}\\n\"\n      end\n    end\n\n    # The `SummaryNotification` holds information about the results of running\n    # a test suite. It is used by formatters to provide information at the end\n    # of the test run.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr failed_examples [Array<RSpec::Core::Example>] the failed examples\n    # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples\n    # @attr load_time [Float] the number of seconds taken to boot RSpec\n    #                         and load the spec files\n    # @attr errors_outside_of_examples_count [Integer] the number of errors that\n    #                                                  have occurred processing\n    #                                                  the spec suite\n    SummaryNotification = Struct.new(:duration, :examples, :failed_examples,\n                                     :pending_examples, :load_time,\n                                     :errors_outside_of_examples_count)\n    class SummaryNotification\n      # @api\n      # @return [Fixnum] the number of examples run\n      def example_count\n        @example_count ||= examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of failed examples\n      def failure_count\n        @failure_count ||= failed_examples.size\n      end\n\n      # @api\n      # @return [Fixnum] the number of pending examples\n      def pending_count\n        @pending_count ||= pending_examples.size\n      end\n\n      # @api\n      # @return [String] A line summarising the result totals of the spec run.\n      def totals_line\n        summary = Formatters::Helpers.pluralize(example_count, \"example\") +\n          \", \" + Formatters::Helpers.pluralize(failure_count, \"failure\")\n        summary += \", #{pending_count} pending\" if pending_count > 0\n        if errors_outside_of_examples_count > 0\n          summary += (\n            \", \" +\n            Formatters::Helpers.pluralize(errors_outside_of_examples_count, \"error\") +\n            \" occurred outside of examples\"\n          )\n        end\n        summary\n      end\n\n      # @api public\n      #\n      # Wraps the results line with colors based on the configured\n      # colors for failure, pending, and success. Defaults to red,\n      # yellow, green accordingly.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized results line.\n      def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        if failure_count > 0 || errors_outside_of_examples_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.failure_color)\n        elsif pending_count > 0\n          colorizer.wrap(totals_line, RSpec.configuration.pending_color)\n        else\n          colorizer.wrap(totals_line, RSpec.configuration.success_color)\n        end\n      end\n\n      # @api public\n      #\n      # Formats failures into a rerunable command format.\n      #\n      # @param colorizer [#wrap] An object which supports wrapping text with\n      #                          specific colors.\n      # @return [String] A colorized summary line.\n      def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        \"\\nFailed examples:\\n\\n\" +\n        failed_examples.map do |example|\n          colorizer.wrap(\"rspec #{rerun_argument_for(example)}\", RSpec.configuration.failure_color) + \" \" +\n          colorizer.wrap(\"# #{example.full_description}\",   RSpec.configuration.detail_color)\n        end.join(\"\\n\")\n      end\n\n      # @return [String] a formatted version of the time it took to run the\n      #   suite\n      def formatted_duration\n        Formatters::Helpers.format_duration(duration)\n      end\n\n      # @return [String] a formatted version of the time it took to boot RSpec\n      #   and load the spec files\n      def formatted_load_time\n        Formatters::Helpers.format_duration(load_time)\n      end\n\n      # @return [String] The summary information fully formatted in the way that\n      #   RSpec's built-in formatters emit.\n      def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n        formatted = \"\\nFinished in #{formatted_duration} \" \\\n                    \"(files took #{formatted_load_time} to load)\\n\" \\\n                    \"#{colorized_totals_line(colorizer)}\\n\"\n\n        unless failed_examples.empty?\n          formatted += (colorized_rerun_commands(colorizer) + \"\\n\")\n        end\n\n        formatted\n      end\n\n    private\n\n      include RSpec::Core::ShellEscape\n\n      def rerun_argument_for(example)\n        location = example.location_rerun_argument\n\n        return location unless duplicate_rerun_locations.include?(location)\n        return location if RSpec.configuration.force_line_number_for_spec_rerun\n        conditionally_quote(example.id)\n      end\n\n      def duplicate_rerun_locations\n        @duplicate_rerun_locations ||= begin\n          locations = RSpec.world.all_examples.map(&:location_rerun_argument)\n\n          Set.new.tap do |s|\n            locations.group_by { |l| l }.each do |l, ls|\n              s << l if ls.count > 1\n            end\n          end\n        end\n      end\n    end\n\n    # The `ProfileNotification` holds information about the results of running a\n    # test suite when profiling is enabled. It is used by formatters to provide\n    # information at the end of the test run for profiling information.\n    #\n    # @attr duration [Float] the time taken (in seconds) to run the suite\n    # @attr examples [Array<RSpec::Core::Example>] the examples run\n    # @attr number_of_examples [Fixnum] the number of examples to profile\n    # @attr example_groups [Array<RSpec::Core::Profiler>] example groups run\n    class ProfileNotification\n      def initialize(duration, examples, number_of_examples, example_groups)\n        @duration = duration\n        @examples = examples\n        @number_of_examples = number_of_examples\n        @example_groups = example_groups\n      end\n      attr_reader :duration, :examples, :number_of_examples\n\n      # @return [Array<RSpec::Core::Example>] the slowest examples\n      def slowest_examples\n        @slowest_examples ||=\n          examples.sort_by do |example|\n            -example.execution_result.run_time\n          end.first(number_of_examples)\n      end\n\n      # @return [Float] the time taken (in seconds) to run the slowest examples\n      def slow_duration\n        @slow_duration ||=\n          slowest_examples.inject(0.0) do |i, e|\n            i + e.execution_result.run_time\n          end\n      end\n\n      # @return [String] the percentage of total time taken\n      def percentage\n        @percentage ||=\n          begin\n            time_taken = slow_duration / duration\n            '%.1f' % ((time_taken.nan? ? 0.0 : time_taken) * 100)\n          end\n      end\n\n      # @return [Array<RSpec::Core::Example>] the slowest example groups\n      def slowest_groups\n        @slowest_groups ||= calculate_slowest_groups\n      end\n\n    private\n\n      def calculate_slowest_groups\n        # stop if we've only one example group\n        return {} if @example_groups.keys.length <= 1\n\n        @example_groups.each_value do |hash|\n          hash[:average] = hash[:total_time].to_f / hash[:count]\n        end\n\n        groups = @example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)\n        groups.map { |group, data| [group.location, data] }\n      end\n    end\n\n    # The `DeprecationNotification` is issued by the reporter when a deprecated\n    # part of RSpec is encountered. It represents information about the\n    # deprecated call site.\n    #\n    # @attr message [String] A custom message about the deprecation\n    # @attr deprecated [String] A custom message about the deprecation (alias of\n    #   message)\n    # @attr replacement [String] An optional replacement for the deprecation\n    # @attr call_site [String] An optional call site from which the deprecation\n    #   was issued\n    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site)\n    class DeprecationNotification\n      private_class_method :new\n\n      # @api\n      # Convenience way to initialize the notification\n      def self.from_hash(data)\n        new data[:deprecated], data[:message], data[:replacement], data[:call_site]\n      end\n    end\n\n    # `NullNotification` represents a placeholder value for notifications that\n    # currently require no information, but we may wish to extend in future.\n    class NullNotification\n    end\n\n    # `CustomNotification` is used when sending custom events to formatters /\n    # other registered listeners, it creates attributes based on supplied hash\n    # of options.\n    class CustomNotification < Struct\n      # @param options [Hash] A hash of method / value pairs to create on this notification\n      # @return [CustomNotification]\n      #\n      # Build a custom notification based on the supplied option key / values.\n      def self.for(options={})\n        return NullNotification if options.keys.empty?\n        new(*options.keys).new(*options.values)\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "duplicate_rerun_locations", "signature": "def duplicate_rerun_locations @duplicate_rerun_locations ||= begin", "start_line": 410, "end_line": 420}, "metadata": {"module": "RSpec", "class_name": "SummaryNotification", "class_signature": "class SummaryNotification"}, "task_id": 289}
{"function_name": "parse", "file_path": "rspec-core/lib/rspec/core/option_parser.rb", "focal_code": "def parse(source=nil)\n      return { :files_or_directories_to_run => [] } if original_args.empty?\n      args = original_args.dup\n\n      options = args.delete('--tty') ? { :tty => true } : {}\n      begin\n        parser(options).parse!(args)\n      rescue OptionParser::InvalidOption => e\n        abort \"#{e.message}#{\" (defined in #{source})\" if source}\\n\\n\" \\\n              \"Please use --help for a listing of valid options\"\n      end\n\n      options[:files_or_directories_to_run] = args\n      options\n    end", "file_content": "# http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html\nrequire 'optparse'\n\nmodule RSpec::Core\n  # @private\n  class Parser\n    def self.parse(args, source=nil)\n      new(args).parse(source)\n    end\n\n    attr_reader :original_args\n\n    def initialize(original_args)\n      @original_args = original_args\n    end\n\n    def parse(source=nil)\n      return { :files_or_directories_to_run => [] } if original_args.empty?\n      args = original_args.dup\n\n      options = args.delete('--tty') ? { :tty => true } : {}\n      begin\n        parser(options).parse!(args)\n      rescue OptionParser::InvalidOption => e\n        abort \"#{e.message}#{\" (defined in #{source})\" if source}\\n\\n\" \\\n              \"Please use --help for a listing of valid options\"\n      end\n\n      options[:files_or_directories_to_run] = args\n      options\n    end\n\n  private\n\n    # rubocop:disable Metrics/AbcSize\n    # rubocop:disable Metrics/MethodLength\n    # rubocop:disable Metrics/CyclomaticComplexity\n    # rubocop:disable Metrics/PerceivedComplexity\n    def parser(options)\n      OptionParser.new do |parser|\n        parser.summary_width = 34\n\n        parser.banner = \"Usage: rspec [options] [files or directories]\\n\\n\"\n\n        parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dirs|\n          options[:libs] ||= []\n          options[:libs].concat(dirs.split(File::PATH_SEPARATOR))\n        end\n\n        parser.on('-r', '--require PATH', 'Require a file.') do |path|\n          options[:requires] ||= []\n          options[:requires] << path\n        end\n\n        parser.on('-O', '--options PATH', 'Specify the path to a custom options file.') do |path|\n          options[:custom_options_file] = path\n        end\n\n        parser.on('--order TYPE[:SEED]', 'Run examples by the specified order type.',\n                  '  [defined]           examples and groups are run in the order they are defined',\n                  '  [rand]              randomize the order of groups and examples',\n                  '  [random]            alias for rand',\n                  '  [random:SEED]       e.g. --order random:123',\n                  '  [recently-modified] run the most recently modified files first') do |o|\n          options[:order] = o\n        end\n\n        parser.on('--seed SEED', Integer, 'Equivalent of --order rand:SEED.') do |seed|\n          options[:order] = \"rand:#{seed}\"\n        end\n\n        parser.on('--bisect[=verbose]', 'Repeatedly runs the suite in order to isolate the failures to the ',\n                  '  smallest reproducible case.') do |argument|\n          options[:bisect] = argument || true\n          options[:runner] = RSpec::Core::Invocations::Bisect.new\n        end\n\n        parser.on('--[no-]fail-fast[=COUNT]', 'Abort the run after a certain number of failures (1 by default).') do |argument|\n          if argument == true\n            value = 1\n          elsif argument == false || argument == 0\n            value = false\n          else\n            begin\n              value = Integer(argument)\n            rescue ArgumentError\n              RSpec.warning \"Expected an integer value for `--fail-fast`, got: #{argument.inspect}\", :call_site => nil\n            end\n          end\n          set_fail_fast(options, value)\n        end\n\n        parser.on('--failure-exit-code CODE', Integer,\n                  'Override the exit code used when there are failing specs.') do |code|\n          options[:failure_exit_code] = code\n        end\n\n        parser.on('--error-exit-code CODE', Integer,\n                  'Override the exit code used when there are errors loading or running specs outside of examples.') do |code|\n          options[:error_exit_code] = code\n        end\n\n        parser.on('-X', '--[no-]drb', 'Run examples via DRb.') do |use_drb|\n          options[:drb] = use_drb\n          options[:runner] = RSpec::Core::Invocations::DRbWithFallback.new if use_drb\n        end\n\n        parser.on('--drb-port PORT', 'Port to connect to the DRb server.') do |o|\n          options[:drb_port] = o.to_i\n        end\n\n        parser.separator(\"\\n  **** Output ****\\n\\n\")\n\n        parser.on('-f', '--format FORMATTER', 'Choose a formatter.',\n                  '  [p]rogress (default - dots)',\n                  '  [d]ocumentation (group and example names)',\n                  '  [h]tml',\n                  '  [j]son',\n                  '  [f]ailures (\"file:line:reason\", suitable for editors integration)',\n                  '  custom formatter class name') do |o|\n          options[:formatters] ||= []\n          options[:formatters] << [o]\n        end\n\n        parser.on('-o', '--out FILE',\n                  'Write output to a file instead of $stdout. This option applies',\n                  '  to the previously specified --format, or the default format',\n                  '  if no format is specified.'\n                 ) do |o|\n          options[:formatters] ||= [['progress']]\n          options[:formatters].last << o\n        end\n\n        parser.on('--deprecation-out FILE', 'Write deprecation warnings to a file instead of $stderr.') do |file|\n          options[:deprecation_stream] = file\n        end\n\n        parser.on('-b', '--backtrace', 'Enable full backtrace.') do |_o|\n          options[:full_backtrace] = true\n        end\n\n        parser.on('-c', '--color', '--colour', '') do |_o|\n          # flag will be excluded from `--help` output because it is deprecated\n          options[:color] = true\n          options[:color_mode] = :automatic\n        end\n\n        parser.on('--force-color', '--force-colour', 'Force the output to be in color, even if the output is not a TTY') do |_o|\n          if options[:color_mode] == :off\n            abort \"Please only use one of `--force-color` and `--no-color`\"\n          end\n          options[:color_mode] = :on\n        end\n\n        parser.on('--no-color', '--no-colour', 'Force the output to not be in color, even if the output is a TTY') do |_o|\n          if options[:color_mode] == :on\n            abort \"Please only use one of --force-color and --no-color\"\n          end\n          options[:color_mode] = :off\n        end\n\n        parser.on('-p', '--[no-]profile [COUNT]',\n                  'Enable profiling of examples and list the slowest examples (default: 10).') do |argument|\n          options[:profile_examples] = if argument.nil?\n                                         true\n                                       elsif argument == false\n                                         false\n                                       else\n                                         begin\n                                           Integer(argument)\n                                         rescue ArgumentError\n                                           RSpec.warning \"Non integer specified as profile count, separate \" \\\n                                                       \"your path from options with -- e.g. \" \\\n                                                       \"`rspec --profile -- #{argument}`\",\n                                                         :call_site => nil\n                                           true\n                                         end\n                                       end\n        end\n\n        parser.on('--dry-run', 'Print the formatter output of your suite without',\n                  '  running any examples or hooks') do |_o|\n          options[:dry_run] = true\n        end\n\n        parser.on('-w', '--warnings', 'Enable ruby warnings') do\n          if Object.const_defined?(:Warning) && Warning.respond_to?(:[]=)\n            # :nocov: on older Ruby without Warning\n            Warning[:deprecated] = true\n            # :nocov:\n          end\n          $VERBOSE = true\n        end\n\n        parser.separator <<-FILTERING\n\n  **** Filtering/tags ****\n\n    In addition to the following options for selecting specific files, groups, or\n    examples, you can select individual examples by appending the line number(s) to\n    the filename:\n\n      rspec path/to/a_spec.rb:37:87\n\n    You can also pass example ids enclosed in square brackets:\n\n      rspec path/to/a_spec.rb[1:5,1:6] # run the 5th and 6th examples/groups defined in the 1st group\n\nFILTERING\n\n        parser.on('--only-failures', \"Filter to just the examples that failed the last time they ran.\") do\n          configure_only_failures(options)\n        end\n\n        parser.on(\"-n\", \"--next-failure\", \"Apply `--only-failures` and abort after one failure.\",\n                  \"  (Equivalent to `--only-failures --fail-fast --order defined`)\") do\n          configure_only_failures(options)\n          set_fail_fast(options, 1)\n          options[:order] ||= 'defined'\n        end\n\n        parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: \"spec/**/*_spec.rb\").') do |o|\n          if options[:pattern]\n            options[:pattern] += ',' + o\n          else\n            options[:pattern] = o\n          end\n        end\n\n        parser.on('--exclude-pattern PATTERN',\n                  'Load files except those matching pattern. Opposite effect of --pattern.') do |o|\n          options[:exclude_pattern] = o\n        end\n\n        parser.on('-e', '--example STRING', \"Run examples whose full nested names include STRING (may be\",\n                  \"  used more than once)\") do |o|\n          (options[:full_description] ||= []) << Regexp.compile(Regexp.escape(o))\n        end\n\n        parser.on('-E', '--example-matches REGEX', \"Run examples whose full nested names match REGEX (may be\",\n                  \"  used more than once)\") do |o|\n          (options[:full_description] ||= []) << Regexp.compile(o)\n        end\n\n        parser.on('-t', '--tag TAG[:VALUE]',\n                  'Run examples with the specified tag, or exclude examples',\n                  'by adding ~ before the tag.',\n                  '  - e.g. ~slow',\n                  '  - TAG is always converted to a symbol') do |tag|\n          filter_type = tag =~ /^~/ ? :exclusion_filter : :inclusion_filter\n\n          name, value = tag.gsub(/^(~@|~|@)/, '').split(':', 2)\n          name = name.to_sym\n\n          parsed_value = case value\n                         when  nil        then true # The default value for tags is true\n                         when 'true'      then true\n                         when 'false'     then false\n                         when 'nil'       then nil\n                         when /^:/        then value[1..-1].to_sym\n                         when /^\\d+$/     then Integer(value)\n                         when /^\\d+.\\d+$/ then Float(value)\n                         else\n                           value\n                         end\n\n          add_tag_filter(options, filter_type, name, parsed_value)\n        end\n\n        parser.on('--default-path PATH', 'Set the default path where RSpec looks for examples (can',\n                  '  be a path to a file or a directory).') do |path|\n          options[:default_path] = path\n        end\n\n        parser.separator(\"\\n  **** Utility ****\\n\\n\")\n\n        parser.on('--init', 'Initialize your project with RSpec.') do |_cmd|\n          options[:runner] = RSpec::Core::Invocations::InitializeProject.new\n        end\n\n        parser.on('-v', '--version', 'Display the version.') do\n          options[:runner] = RSpec::Core::Invocations::PrintVersion.new\n        end\n\n        # These options would otherwise be confusing to users, so we forcibly\n        # prevent them from executing.\n        #\n        #   * --I is too similar to -I.\n        #   * -d was a shorthand for --debugger, which is removed, but now would\n        #     trigger --default-path.\n        invalid_options = %w[-d --I]\n\n        hidden_options = invalid_options + %w[-c]\n\n        parser.on_tail('-h', '--help', \"You're looking at it.\") do\n          options[:runner] = RSpec::Core::Invocations::PrintHelp.new(parser, hidden_options)\n        end\n\n        # This prevents usage of the invalid_options.\n        invalid_options.each do |option|\n          parser.on(option) do\n            raise OptionParser::InvalidOption.new\n          end\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize\n    # rubocop:enable Metrics/MethodLength\n    # rubocop:enable Metrics/CyclomaticComplexity\n    # rubocop:enable Metrics/PerceivedComplexity\n\n    def add_tag_filter(options, filter_type, tag_name, value=true)\n      (options[filter_type] ||= {})[tag_name] = value\n    end\n\n    def set_fail_fast(options, value)\n      options[:fail_fast] = value\n    end\n\n    def configure_only_failures(options)\n      options[:only_failures] = true\n      add_tag_filter(options, :inclusion_filter, :last_run_status, 'failed')\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "parse", "signature": "def parse(source=nil)", "start_line": 17, "end_line": 31}, "metadata": {"module": "RSpec", "class_name": "Parser", "class_signature": "class Parser"}, "task_id": 290}
{"function_name": "jenkins_hash_digest", "file_path": "rspec-core/lib/rspec/core/ordering.rb", "focal_code": "def jenkins_hash_digest(string)\n          hash = 0\n\n          string.each_byte do |byte|\n            hash += byte\n            hash &= MAX_32_BIT\n            hash += ((hash << 10) & MAX_32_BIT)\n            hash &= MAX_32_BIT\n            hash ^= hash >> 6\n          end\n\n          hash += ((hash << 3) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash ^= hash >> 11\n          hash += ((hash << 15) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash\n        end", "file_content": "module RSpec\n  module Core\n    # @private\n    module Ordering\n      # @private\n      # The default global ordering (defined order).\n      class Identity\n        def order(items)\n          items\n        end\n      end\n\n      # @private\n      # Orders items randomly.\n      class Random\n        def initialize(configuration)\n          @configuration = configuration\n          @used = false\n        end\n\n        def used?\n          @used\n        end\n\n        def order(items)\n          @used = true\n\n          seed = @configuration.seed.to_s\n          items.sort_by { |item| jenkins_hash_digest(seed + item.id) }\n        end\n\n      private\n\n        # http://en.wikipedia.org/wiki/Jenkins_hash_function\n        # Jenkins provides a good distribution and is simpler than MD5.\n        # It's a bit slower than MD5 (primarily because `Digest::MD5` is\n        # implemented in C) but has the advantage of not requiring us\n        # to load another part of stdlib, which we try to minimize.\n        def jenkins_hash_digest(string)\n          hash = 0\n\n          string.each_byte do |byte|\n            hash += byte\n            hash &= MAX_32_BIT\n            hash += ((hash << 10) & MAX_32_BIT)\n            hash &= MAX_32_BIT\n            hash ^= hash >> 6\n          end\n\n          hash += ((hash << 3) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash ^= hash >> 11\n          hash += ((hash << 15) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash\n        end\n\n        MAX_32_BIT = 4_294_967_295\n      end\n\n      # @private\n      # Orders items by modification time (most recent modified first).\n      class RecentlyModified\n        def order(list)\n          list.sort_by { |item| -File.mtime(item.metadata[:absolute_file_path]).to_i }\n        end\n      end\n\n      # @private\n      # Orders items based on a custom block.\n      class Custom\n        def initialize(callable)\n          @callable = callable\n        end\n\n        def order(list)\n          @callable.call(list)\n        end\n      end\n\n      # @private\n      # A strategy which delays looking up the ordering until needed\n      class Delayed\n        def initialize(registry, name)\n          @registry = registry\n          @name = name\n        end\n\n        def order(list)\n          strategy.order(list)\n        end\n\n        private\n\n        def strategy\n          @strategy ||= lookup_strategy\n        end\n\n        def lookup_strategy\n          raise \"Undefined ordering strategy #{@name.inspect}\" unless @registry.has_strategy?(@name)\n          @registry.fetch(@name)\n        end\n      end\n\n      # @private\n      # Stores the different ordering strategies.\n      class Registry\n        def initialize(configuration)\n          @configuration = configuration\n          @strategies    = {}\n\n          register(:random, Random.new(configuration))\n          register(:recently_modified, RecentlyModified.new)\n\n          identity = Identity.new\n          register(:defined, identity)\n\n          # The default global ordering is --defined.\n          register(:global, identity)\n        end\n\n        def fetch(name, &fallback)\n          @strategies.fetch(name, &fallback)\n        end\n\n        def has_strategy?(name)\n          @strategies.key?(name)\n        end\n\n        def register(sym, strategy)\n          @strategies[sym] = strategy\n        end\n\n        def used_random_seed?\n          @strategies[:random].used?\n        end\n      end\n\n      # @private\n      # Manages ordering configuration.\n      #\n      # @note This is not intended to be used externally. Use\n      #       the APIs provided by `RSpec::Core::Configuration` instead.\n      class ConfigurationManager\n        attr_reader :seed, :ordering_registry\n\n        def initialize\n          @ordering_registry = Registry.new(self)\n          @seed = rand(0xFFFF)\n          @seed_forced = false\n          @order_forced = false\n        end\n\n        def seed_used?\n          ordering_registry.used_random_seed?\n        end\n\n        def seed=(seed)\n          return if @seed_forced\n          register_ordering(:global, ordering_registry.fetch(:random))\n          @seed = seed.to_i\n        end\n\n        def order=(type)\n          order, seed = type.to_s.split(':')\n          @seed = seed.to_i if seed\n\n          ordering_name = if order.include?('rand')\n                            :random\n                          elsif order == 'defined'\n                            :defined\n                          elsif order == 'recently-modified'\n                            :recently_modified\n                          else\n                            order.to_sym\n                          end\n\n          if ordering_name\n            strategy =\n              if ordering_registry.has_strategy?(ordering_name)\n                ordering_registry.fetch(ordering_name)\n              else\n                Delayed.new(ordering_registry, ordering_name)\n              end\n\n            register_ordering(:global, strategy)\n          end\n        end\n\n        def force(hash)\n          if hash.key?(:seed)\n            self.seed = hash[:seed]\n            @seed_forced  = true\n            @order_forced = true\n          elsif hash.key?(:order)\n            self.order = hash[:order]\n            @order_forced = true\n          end\n        end\n\n        def register_ordering(name, strategy=Custom.new(Proc.new { |l| yield l }))\n          return if @order_forced && name == :global\n          ordering_registry.register(name, strategy)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "jenkins_hash_digest", "signature": "def jenkins_hash_digest(string)", "start_line": 39, "end_line": 56}, "metadata": {"module": "RSpec", "class_name": "Random", "class_signature": "class Random"}, "task_id": 291}
{"function_name": "order=", "file_path": "rspec-core/lib/rspec/core/ordering.rb", "focal_code": "def order=(type)\n          order, seed = type.to_s.split(':')\n          @seed = seed.to_i if seed\n\n          ordering_name = if order.include?('rand')\n                            :random\n                          elsif order == 'defined'\n                            :defined\n                          elsif order == 'recently-modified'\n                            :recently_modified\n                          else\n                            order.to_sym\n                          end\n\n          if ordering_name\n            strategy =\n              if ordering_registry.has_strategy?(ordering_name)\n                ordering_registry.fetch(ordering_name)\n              else\n                Delayed.new(ordering_registry, ordering_name)\n              end\n\n            register_ordering(:global, strategy)\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # @private\n    module Ordering\n      # @private\n      # The default global ordering (defined order).\n      class Identity\n        def order(items)\n          items\n        end\n      end\n\n      # @private\n      # Orders items randomly.\n      class Random\n        def initialize(configuration)\n          @configuration = configuration\n          @used = false\n        end\n\n        def used?\n          @used\n        end\n\n        def order(items)\n          @used = true\n\n          seed = @configuration.seed.to_s\n          items.sort_by { |item| jenkins_hash_digest(seed + item.id) }\n        end\n\n      private\n\n        # http://en.wikipedia.org/wiki/Jenkins_hash_function\n        # Jenkins provides a good distribution and is simpler than MD5.\n        # It's a bit slower than MD5 (primarily because `Digest::MD5` is\n        # implemented in C) but has the advantage of not requiring us\n        # to load another part of stdlib, which we try to minimize.\n        def jenkins_hash_digest(string)\n          hash = 0\n\n          string.each_byte do |byte|\n            hash += byte\n            hash &= MAX_32_BIT\n            hash += ((hash << 10) & MAX_32_BIT)\n            hash &= MAX_32_BIT\n            hash ^= hash >> 6\n          end\n\n          hash += ((hash << 3) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash ^= hash >> 11\n          hash += ((hash << 15) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash\n        end\n\n        MAX_32_BIT = 4_294_967_295\n      end\n\n      # @private\n      # Orders items by modification time (most recent modified first).\n      class RecentlyModified\n        def order(list)\n          list.sort_by { |item| -File.mtime(item.metadata[:absolute_file_path]).to_i }\n        end\n      end\n\n      # @private\n      # Orders items based on a custom block.\n      class Custom\n        def initialize(callable)\n          @callable = callable\n        end\n\n        def order(list)\n          @callable.call(list)\n        end\n      end\n\n      # @private\n      # A strategy which delays looking up the ordering until needed\n      class Delayed\n        def initialize(registry, name)\n          @registry = registry\n          @name = name\n        end\n\n        def order(list)\n          strategy.order(list)\n        end\n\n        private\n\n        def strategy\n          @strategy ||= lookup_strategy\n        end\n\n        def lookup_strategy\n          raise \"Undefined ordering strategy #{@name.inspect}\" unless @registry.has_strategy?(@name)\n          @registry.fetch(@name)\n        end\n      end\n\n      # @private\n      # Stores the different ordering strategies.\n      class Registry\n        def initialize(configuration)\n          @configuration = configuration\n          @strategies    = {}\n\n          register(:random, Random.new(configuration))\n          register(:recently_modified, RecentlyModified.new)\n\n          identity = Identity.new\n          register(:defined, identity)\n\n          # The default global ordering is --defined.\n          register(:global, identity)\n        end\n\n        def fetch(name, &fallback)\n          @strategies.fetch(name, &fallback)\n        end\n\n        def has_strategy?(name)\n          @strategies.key?(name)\n        end\n\n        def register(sym, strategy)\n          @strategies[sym] = strategy\n        end\n\n        def used_random_seed?\n          @strategies[:random].used?\n        end\n      end\n\n      # @private\n      # Manages ordering configuration.\n      #\n      # @note This is not intended to be used externally. Use\n      #       the APIs provided by `RSpec::Core::Configuration` instead.\n      class ConfigurationManager\n        attr_reader :seed, :ordering_registry\n\n        def initialize\n          @ordering_registry = Registry.new(self)\n          @seed = rand(0xFFFF)\n          @seed_forced = false\n          @order_forced = false\n        end\n\n        def seed_used?\n          ordering_registry.used_random_seed?\n        end\n\n        def seed=(seed)\n          return if @seed_forced\n          register_ordering(:global, ordering_registry.fetch(:random))\n          @seed = seed.to_i\n        end\n\n        def order=(type)\n          order, seed = type.to_s.split(':')\n          @seed = seed.to_i if seed\n\n          ordering_name = if order.include?('rand')\n                            :random\n                          elsif order == 'defined'\n                            :defined\n                          elsif order == 'recently-modified'\n                            :recently_modified\n                          else\n                            order.to_sym\n                          end\n\n          if ordering_name\n            strategy =\n              if ordering_registry.has_strategy?(ordering_name)\n                ordering_registry.fetch(ordering_name)\n              else\n                Delayed.new(ordering_registry, ordering_name)\n              end\n\n            register_ordering(:global, strategy)\n          end\n        end\n\n        def force(hash)\n          if hash.key?(:seed)\n            self.seed = hash[:seed]\n            @seed_forced  = true\n            @order_forced = true\n          elsif hash.key?(:order)\n            self.order = hash[:order]\n            @order_forced = true\n          end\n        end\n\n        def register_ordering(name, strategy=Custom.new(Proc.new { |l| yield l }))\n          return if @order_forced && name == :global\n          ordering_registry.register(name, strategy)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "order=", "signature": "def order", "start_line": 164, "end_line": 188}, "metadata": {"module": "RSpec", "class_name": "ConfigurationManager", "class_signature": "class ConfigurationManager"}, "task_id": 292}
{"function_name": "force", "file_path": "rspec-core/lib/rspec/core/ordering.rb", "focal_code": "def force(hash)\n          if hash.key?(:seed)\n            self.seed = hash[:seed]\n            @seed_forced  = true\n            @order_forced = true\n          elsif hash.key?(:order)\n            self.order = hash[:order]\n            @order_forced = true\n          end\n        end", "file_content": "module RSpec\n  module Core\n    # @private\n    module Ordering\n      # @private\n      # The default global ordering (defined order).\n      class Identity\n        def order(items)\n          items\n        end\n      end\n\n      # @private\n      # Orders items randomly.\n      class Random\n        def initialize(configuration)\n          @configuration = configuration\n          @used = false\n        end\n\n        def used?\n          @used\n        end\n\n        def order(items)\n          @used = true\n\n          seed = @configuration.seed.to_s\n          items.sort_by { |item| jenkins_hash_digest(seed + item.id) }\n        end\n\n      private\n\n        # http://en.wikipedia.org/wiki/Jenkins_hash_function\n        # Jenkins provides a good distribution and is simpler than MD5.\n        # It's a bit slower than MD5 (primarily because `Digest::MD5` is\n        # implemented in C) but has the advantage of not requiring us\n        # to load another part of stdlib, which we try to minimize.\n        def jenkins_hash_digest(string)\n          hash = 0\n\n          string.each_byte do |byte|\n            hash += byte\n            hash &= MAX_32_BIT\n            hash += ((hash << 10) & MAX_32_BIT)\n            hash &= MAX_32_BIT\n            hash ^= hash >> 6\n          end\n\n          hash += ((hash << 3) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash ^= hash >> 11\n          hash += ((hash << 15) & MAX_32_BIT)\n          hash &= MAX_32_BIT\n          hash\n        end\n\n        MAX_32_BIT = 4_294_967_295\n      end\n\n      # @private\n      # Orders items by modification time (most recent modified first).\n      class RecentlyModified\n        def order(list)\n          list.sort_by { |item| -File.mtime(item.metadata[:absolute_file_path]).to_i }\n        end\n      end\n\n      # @private\n      # Orders items based on a custom block.\n      class Custom\n        def initialize(callable)\n          @callable = callable\n        end\n\n        def order(list)\n          @callable.call(list)\n        end\n      end\n\n      # @private\n      # A strategy which delays looking up the ordering until needed\n      class Delayed\n        def initialize(registry, name)\n          @registry = registry\n          @name = name\n        end\n\n        def order(list)\n          strategy.order(list)\n        end\n\n        private\n\n        def strategy\n          @strategy ||= lookup_strategy\n        end\n\n        def lookup_strategy\n          raise \"Undefined ordering strategy #{@name.inspect}\" unless @registry.has_strategy?(@name)\n          @registry.fetch(@name)\n        end\n      end\n\n      # @private\n      # Stores the different ordering strategies.\n      class Registry\n        def initialize(configuration)\n          @configuration = configuration\n          @strategies    = {}\n\n          register(:random, Random.new(configuration))\n          register(:recently_modified, RecentlyModified.new)\n\n          identity = Identity.new\n          register(:defined, identity)\n\n          # The default global ordering is --defined.\n          register(:global, identity)\n        end\n\n        def fetch(name, &fallback)\n          @strategies.fetch(name, &fallback)\n        end\n\n        def has_strategy?(name)\n          @strategies.key?(name)\n        end\n\n        def register(sym, strategy)\n          @strategies[sym] = strategy\n        end\n\n        def used_random_seed?\n          @strategies[:random].used?\n        end\n      end\n\n      # @private\n      # Manages ordering configuration.\n      #\n      # @note This is not intended to be used externally. Use\n      #       the APIs provided by `RSpec::Core::Configuration` instead.\n      class ConfigurationManager\n        attr_reader :seed, :ordering_registry\n\n        def initialize\n          @ordering_registry = Registry.new(self)\n          @seed = rand(0xFFFF)\n          @seed_forced = false\n          @order_forced = false\n        end\n\n        def seed_used?\n          ordering_registry.used_random_seed?\n        end\n\n        def seed=(seed)\n          return if @seed_forced\n          register_ordering(:global, ordering_registry.fetch(:random))\n          @seed = seed.to_i\n        end\n\n        def order=(type)\n          order, seed = type.to_s.split(':')\n          @seed = seed.to_i if seed\n\n          ordering_name = if order.include?('rand')\n                            :random\n                          elsif order == 'defined'\n                            :defined\n                          elsif order == 'recently-modified'\n                            :recently_modified\n                          else\n                            order.to_sym\n                          end\n\n          if ordering_name\n            strategy =\n              if ordering_registry.has_strategy?(ordering_name)\n                ordering_registry.fetch(ordering_name)\n              else\n                Delayed.new(ordering_registry, ordering_name)\n              end\n\n            register_ordering(:global, strategy)\n          end\n        end\n\n        def force(hash)\n          if hash.key?(:seed)\n            self.seed = hash[:seed]\n            @seed_forced  = true\n            @order_forced = true\n          elsif hash.key?(:order)\n            self.order = hash[:order]\n            @order_forced = true\n          end\n        end\n\n        def register_ordering(name, strategy=Custom.new(Proc.new { |l| yield l }))\n          return if @order_forced && name == :global\n          ordering_registry.register(name, strategy)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "force", "signature": "def force(hash)", "start_line": 190, "end_line": 199}, "metadata": {"module": "RSpec", "class_name": "ConfigurationManager", "class_signature": "class ConfigurationManager"}, "task_id": 293}
{"function_name": "pending", "file_path": "rspec-core/lib/rspec/core/pending.rb", "focal_code": "def pending(message=nil, &_block)\n        current_example = RSpec.current_example\n\n        if block_given?\n          raise ArgumentError, <<-EOS.gsub(/^\\s+\\|/, '')\n            |The semantics of `RSpec::Core::Pending#pending` have changed in\n            |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In\n            |RSpec 3, the rest of the example is still run but is expected to\n            |fail, and will be marked as a failure (rather than as pending) if\n            |the example passes.\n            |\n            |Passing a block within an example is now deprecated. Marking the\n            |example as pending provides the same behavior in RSpec 3 which was\n            |provided only by the block in RSpec 2.x.\n            |\n            |Move the code in the block provided to `pending` into the rest of\n            |the example body.\n            |\n            |Called from #{CallerFilter.first_non_rspec_line}.\n            |\n          EOS\n        elsif current_example\n          Pending.mark_pending! current_example, message\n        else\n          raise \"`pending` may not be used outside of examples, such as in \" \\\n                \"before(:context). Maybe you want `skip`?\"\n        end\n      end", "file_content": "module RSpec\n  module Core\n    # Provides methods to mark examples as pending. These methods are available\n    # to be called from within any example or hook.\n    module Pending\n      # Raised in the middle of an example to indicate that it should be marked\n      # as skipped.\n      class SkipDeclaredInExample < StandardError\n        attr_reader :argument\n\n        def initialize(argument)\n          @argument = argument\n        end\n      end\n\n      # If Test::Unit is loaded, we'll use its error as baseclass, so that\n      # Test::Unit will report unmet RSpec expectations as failures rather than\n      # errors.\n      begin\n        class PendingExampleFixedError < Test::Unit::AssertionFailedError; end\n      rescue\n        class PendingExampleFixedError < StandardError; end\n      end\n\n      # @private\n      NO_REASON_GIVEN = 'No reason given'\n\n      # @private\n      NOT_YET_IMPLEMENTED = 'Not yet implemented'\n\n      # @overload pending()\n      # @overload pending(message)\n      #\n      # Marks an example as pending. The rest of the example will still be\n      # executed, and if it passes the example will fail to indicate that the\n      # pending can be removed.\n      #\n      # @param message [String] optional message to add to the summary report.\n      #\n      # @example\n      #     describe \"some behaviour\" do\n      #       # reported as \"Pending: no reason given\"\n      #       it \"is pending with no message\" do\n      #         pending\n      #         raise \"broken\"\n      #       end\n      #\n      #       # reported as \"Pending: something else getting finished\"\n      #       it \"is pending with a custom message\" do\n      #         pending(\"something else getting finished\")\n      #         raise \"broken\"\n      #       end\n      #     end\n      #\n      # @note When using `pending` inside an example body using this method\n      #   hooks, such as `before(:example)`, have already be run. This means that\n      #   a failure from the code in the `before` hook will prevent the example\n      #   from being considered pending, as the example body would not be\n      #   executed. If you need to consider hooks as pending as well you can use\n      #   the pending metadata as an alternative, e.g.\n      #   `it \"does something\", pending: \"message\"`.\n      def pending(message=nil, &_block)\n        current_example = RSpec.current_example\n\n        if block_given?\n          raise ArgumentError, <<-EOS.gsub(/^\\s+\\|/, '')\n            |The semantics of `RSpec::Core::Pending#pending` have changed in\n            |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In\n            |RSpec 3, the rest of the example is still run but is expected to\n            |fail, and will be marked as a failure (rather than as pending) if\n            |the example passes.\n            |\n            |Passing a block within an example is now deprecated. Marking the\n            |example as pending provides the same behavior in RSpec 3 which was\n            |provided only by the block in RSpec 2.x.\n            |\n            |Move the code in the block provided to `pending` into the rest of\n            |the example body.\n            |\n            |Called from #{CallerFilter.first_non_rspec_line}.\n            |\n          EOS\n        elsif current_example\n          Pending.mark_pending! current_example, message\n        else\n          raise \"`pending` may not be used outside of examples, such as in \" \\\n                \"before(:context). Maybe you want `skip`?\"\n        end\n      end\n\n      # @overload skip()\n      # @overload skip(message)\n      #\n      # Marks an example as pending and skips execution.\n      #\n      # @param message [String] optional message to add to the summary report.\n      #\n      # @example\n      #     describe \"an example\" do\n      #       # reported as \"Pending: no reason given\"\n      #       it \"is skipped with no message\" do\n      #         skip\n      #       end\n      #\n      #       # reported as \"Pending: something else getting finished\"\n      #       it \"is skipped with a custom message\" do\n      #         skip \"something else getting finished\"\n      #       end\n      #     end\n      def skip(message=nil)\n        current_example = RSpec.current_example\n\n        Pending.mark_skipped!(current_example, message) if current_example\n\n        raise SkipDeclaredInExample.new(message)\n      end\n\n      # @private\n      #\n      # Mark example as skipped.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as skipped\n      # @param message_or_bool [Boolean, String] the message to use, or true\n      def self.mark_skipped!(example, message_or_bool)\n        Pending.mark_pending! example, message_or_bool\n        example.metadata[:skip] = true\n      end\n\n      # @private\n      #\n      # Mark example as pending.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as pending\n      # @param message_or_bool [Boolean, String] the message to use, or true\n      def self.mark_pending!(example, message_or_bool)\n        message = if !message_or_bool || !(String === message_or_bool)\n                    NO_REASON_GIVEN\n                  else\n                    message_or_bool\n                  end\n\n        example.metadata[:pending] = true\n        example.execution_result.pending_message = message\n        example.execution_result.pending_fixed = false\n      end\n\n      # @private\n      #\n      # Mark example as fixed.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as fixed\n      def self.mark_fixed!(example)\n        example.execution_result.pending_fixed = true\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "pending", "signature": "def pending(message=nil, &_block)", "start_line": 62, "end_line": 89}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 294}
{"function_name": "mark_pending!", "file_path": "rspec-core/lib/rspec/core/pending.rb", "focal_code": "def self.mark_pending!(example, message_or_bool)\n        message = if !message_or_bool || !(String === message_or_bool)\n                    NO_REASON_GIVEN\n                  else\n                    message_or_bool\n                  end\n\n        example.metadata[:pending] = true\n        example.execution_result.pending_message = message\n        example.execution_result.pending_fixed = false\n      end", "file_content": "module RSpec\n  module Core\n    # Provides methods to mark examples as pending. These methods are available\n    # to be called from within any example or hook.\n    module Pending\n      # Raised in the middle of an example to indicate that it should be marked\n      # as skipped.\n      class SkipDeclaredInExample < StandardError\n        attr_reader :argument\n\n        def initialize(argument)\n          @argument = argument\n        end\n      end\n\n      # If Test::Unit is loaded, we'll use its error as baseclass, so that\n      # Test::Unit will report unmet RSpec expectations as failures rather than\n      # errors.\n      begin\n        class PendingExampleFixedError < Test::Unit::AssertionFailedError; end\n      rescue\n        class PendingExampleFixedError < StandardError; end\n      end\n\n      # @private\n      NO_REASON_GIVEN = 'No reason given'\n\n      # @private\n      NOT_YET_IMPLEMENTED = 'Not yet implemented'\n\n      # @overload pending()\n      # @overload pending(message)\n      #\n      # Marks an example as pending. The rest of the example will still be\n      # executed, and if it passes the example will fail to indicate that the\n      # pending can be removed.\n      #\n      # @param message [String] optional message to add to the summary report.\n      #\n      # @example\n      #     describe \"some behaviour\" do\n      #       # reported as \"Pending: no reason given\"\n      #       it \"is pending with no message\" do\n      #         pending\n      #         raise \"broken\"\n      #       end\n      #\n      #       # reported as \"Pending: something else getting finished\"\n      #       it \"is pending with a custom message\" do\n      #         pending(\"something else getting finished\")\n      #         raise \"broken\"\n      #       end\n      #     end\n      #\n      # @note When using `pending` inside an example body using this method\n      #   hooks, such as `before(:example)`, have already be run. This means that\n      #   a failure from the code in the `before` hook will prevent the example\n      #   from being considered pending, as the example body would not be\n      #   executed. If you need to consider hooks as pending as well you can use\n      #   the pending metadata as an alternative, e.g.\n      #   `it \"does something\", pending: \"message\"`.\n      def pending(message=nil, &_block)\n        current_example = RSpec.current_example\n\n        if block_given?\n          raise ArgumentError, <<-EOS.gsub(/^\\s+\\|/, '')\n            |The semantics of `RSpec::Core::Pending#pending` have changed in\n            |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In\n            |RSpec 3, the rest of the example is still run but is expected to\n            |fail, and will be marked as a failure (rather than as pending) if\n            |the example passes.\n            |\n            |Passing a block within an example is now deprecated. Marking the\n            |example as pending provides the same behavior in RSpec 3 which was\n            |provided only by the block in RSpec 2.x.\n            |\n            |Move the code in the block provided to `pending` into the rest of\n            |the example body.\n            |\n            |Called from #{CallerFilter.first_non_rspec_line}.\n            |\n          EOS\n        elsif current_example\n          Pending.mark_pending! current_example, message\n        else\n          raise \"`pending` may not be used outside of examples, such as in \" \\\n                \"before(:context). Maybe you want `skip`?\"\n        end\n      end\n\n      # @overload skip()\n      # @overload skip(message)\n      #\n      # Marks an example as pending and skips execution.\n      #\n      # @param message [String] optional message to add to the summary report.\n      #\n      # @example\n      #     describe \"an example\" do\n      #       # reported as \"Pending: no reason given\"\n      #       it \"is skipped with no message\" do\n      #         skip\n      #       end\n      #\n      #       # reported as \"Pending: something else getting finished\"\n      #       it \"is skipped with a custom message\" do\n      #         skip \"something else getting finished\"\n      #       end\n      #     end\n      def skip(message=nil)\n        current_example = RSpec.current_example\n\n        Pending.mark_skipped!(current_example, message) if current_example\n\n        raise SkipDeclaredInExample.new(message)\n      end\n\n      # @private\n      #\n      # Mark example as skipped.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as skipped\n      # @param message_or_bool [Boolean, String] the message to use, or true\n      def self.mark_skipped!(example, message_or_bool)\n        Pending.mark_pending! example, message_or_bool\n        example.metadata[:skip] = true\n      end\n\n      # @private\n      #\n      # Mark example as pending.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as pending\n      # @param message_or_bool [Boolean, String] the message to use, or true\n      def self.mark_pending!(example, message_or_bool)\n        message = if !message_or_bool || !(String === message_or_bool)\n                    NO_REASON_GIVEN\n                  else\n                    message_or_bool\n                  end\n\n        example.metadata[:pending] = true\n        example.execution_result.pending_message = message\n        example.execution_result.pending_fixed = false\n      end\n\n      # @private\n      #\n      # Mark example as fixed.\n      #\n      # @param example [RSpec::Core::Example] the example to mark as fixed\n      def self.mark_fixed!(example)\n        example.execution_result.pending_fixed = true\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "mark_pending!", "signature": "def self.mark_pending!(example, message_or_bool)", "start_line": 135, "end_line": 145}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 295}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/rake_task.rb", "focal_code": "def initialize(*args, &task_block)\n        @name          = args.shift || :spec\n        @ruby_opts     = nil\n        @rspec_opts    = nil\n        @verbose       = true\n        @fail_on_error = true\n        @rspec_path    = DEFAULT_RSPEC_PATH\n        @pattern       = DEFAULT_PATTERN\n\n        define(args, &task_block)\n      end", "file_content": "require 'rake'\nrequire 'rake/tasklib'\nrequire 'rspec/support'\n\nRSpec::Support.require_rspec_support \"ruby_features\"\n\n# :nocov:\nunless RSpec::Support.respond_to?(:require_rspec_core)\n  RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative \"../#{f}\" }\nend\n# :nocov:\n\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec\n  module Core\n    # RSpec rake task\n    #\n    # @see Rakefile\n    class RakeTask < ::Rake::TaskLib\n      include ::Rake::DSL if defined?(::Rake::DSL)\n      include RSpec::Core::ShellEscape\n\n      # Default path to the RSpec executable.\n      DEFAULT_RSPEC_PATH = File.expand_path('../../../../exe/rspec', __FILE__)\n\n      # Default pattern for spec files.\n      DEFAULT_PATTERN = 'spec/**{,/*/**}/*_spec.rb'\n\n      # Name of task. Defaults to `:spec`.\n      attr_accessor :name\n\n      # Files matching this pattern will be loaded.\n      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.\n      attr_accessor :pattern\n\n      # Files matching this pattern will be excluded.\n      # Defaults to `nil`.\n      attr_accessor :exclude_pattern\n\n      # Whether or not to fail Rake when an error occurs (typically when\n      # examples fail). Defaults to `true`.\n      attr_accessor :fail_on_error\n\n      # A message to print to stderr when there are failures.\n      attr_accessor :failure_message\n\n      if RUBY_VERSION < \"1.9.0\" || Support::Ruby.jruby?\n        # Run RSpec with a clean (empty) environment is not supported\n        # :nocov:\n        def with_clean_environment=(_value)\n          raise ArgumentError, \"Running in a clean environment is not supported on Ruby versions before 1.9.0\"\n        end\n\n        # Run RSpec with a clean (empty) environment is not supported\n        def with_clean_environment\n          false\n        end\n        # :nocov:\n      else\n        # Run RSpec with a clean (empty) environment.\n        attr_accessor :with_clean_environment\n      end\n\n      # Use verbose output. If this is set to true, the task will print the\n      # executed spec command to stdout. Defaults to `true`.\n      attr_accessor :verbose\n\n      # Command line options to pass to ruby. Defaults to `nil`.\n      attr_accessor :ruby_opts\n\n      # Path to RSpec. Defaults to the absolute path to the\n      # rspec binary from the loaded rspec-core gem.\n      attr_accessor :rspec_path\n\n      # Command line options to pass to RSpec. Defaults to `nil`.\n      attr_accessor :rspec_opts\n\n      def initialize(*args, &task_block)\n        @name          = args.shift || :spec\n        @ruby_opts     = nil\n        @rspec_opts    = nil\n        @verbose       = true\n        @fail_on_error = true\n        @rspec_path    = DEFAULT_RSPEC_PATH\n        @pattern       = DEFAULT_PATTERN\n\n        define(args, &task_block)\n      end\n\n      # @private\n      def run_task(verbose)\n        command = spec_command\n        puts command if verbose\n\n        if with_clean_environment\n          return if system({}, command, :unsetenv_others => true)\n        else\n          return if system(command)\n        end\n\n        puts failure_message if failure_message\n\n        return unless fail_on_error\n        $stderr.puts \"#{command} failed\" if verbose\n        exit $?.exitstatus || 1\n      end\n\n    private\n\n      # @private\n      def define(args, &task_block)\n        desc \"Run RSpec code examples\" unless ::Rake.application.last_description\n\n        task name, *args do |_, task_args|\n          RakeFileUtils.__send__(:verbose, verbose) do\n            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block\n            run_task verbose\n          end\n        end\n      end\n\n      def file_inclusion_specification\n        if ENV['SPEC']\n          FileList[ENV['SPEC']].sort\n        elsif String === pattern && !File.exist?(pattern)\n          return if [*rspec_opts].any? { |opt| opt =~ /--pattern/ }\n          \"--pattern #{escape pattern}\"\n        else\n          # Before RSpec 3.1, we used `FileList` to get the list of matched\n          # files, and then pass that along to the `rspec` command. Starting\n          # with 3.1, we prefer to pass along the pattern as-is to the `rspec`\n          # command, for 3 reasons:\n          #\n          #   * It's *much* less verbose to pass one `--pattern` option than a\n          #     long list of files.\n          #   * It ensures `task.pattern` and `--pattern` have the same\n          #     behavior.\n          #   * It fixes a bug, where\n          #     `task.pattern = pattern_that_matches_no_files` would run *all*\n          #     files because it would cause no pattern or file args to get\n          #     passed to `rspec`, which causes all files to get run.\n          #\n          # However, `FileList` is *far* more flexible than the `--pattern`\n          # option. Specifically, it supports individual files and directories,\n          # as well as arrays of files, directories and globs, as well as other\n          # `FileList` objects.\n          #\n          # For backwards compatibility, we have to fall back to using FileList\n          # if the user has passed a `pattern` option that will not work with\n          # `--pattern`.\n          #\n          # TODO: consider deprecating support for this and removing it in\n          #   RSpec 4.\n          FileList[pattern].sort.map { |file| escape file }\n        end\n      end\n\n      def file_exclusion_specification\n        \" --exclude-pattern #{escape exclude_pattern}\" if exclude_pattern\n      end\n\n      def spec_command\n        cmd_parts = []\n        cmd_parts << RUBY\n        cmd_parts << ruby_opts\n        cmd_parts << rspec_load_path\n        cmd_parts << escape(rspec_path)\n        cmd_parts << file_inclusion_specification\n        cmd_parts << file_exclusion_specification\n        cmd_parts << rspec_opts\n        cmd_parts.flatten.reject(&blank).join(\" \")\n      end\n\n      def blank\n        lambda { |s| s.nil? || s == \"\" }\n      end\n\n      def rspec_load_path\n        @rspec_load_path ||= begin\n          core_and_support = $LOAD_PATH.grep(\n            /#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib/\n          ).uniq\n\n          \"-I#{core_and_support.map { |file| escape file }.join(File::PATH_SEPARATOR)}\"\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(*args, &task_block)", "start_line": 79, "end_line": 89}, "metadata": {"module": "RSpec", "class_name": "RakeTask", "class_signature": "class RakeTask < < ::Rake::TaskLib"}, "task_id": 296}
{"function_name": "run_task", "file_path": "rspec-core/lib/rspec/core/rake_task.rb", "focal_code": "def run_task(verbose)\n        command = spec_command\n        puts command if verbose\n\n        if with_clean_environment\n          return if system({}, command, :unsetenv_others => true)\n        else\n          return if system(command)\n        end\n\n        puts failure_message if failure_message\n\n        return unless fail_on_error\n        $stderr.puts \"#{command} failed\" if verbose\n        exit $?.exitstatus || 1\n      end", "file_content": "require 'rake'\nrequire 'rake/tasklib'\nrequire 'rspec/support'\n\nRSpec::Support.require_rspec_support \"ruby_features\"\n\n# :nocov:\nunless RSpec::Support.respond_to?(:require_rspec_core)\n  RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative \"../#{f}\" }\nend\n# :nocov:\n\nRSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec\n  module Core\n    # RSpec rake task\n    #\n    # @see Rakefile\n    class RakeTask < ::Rake::TaskLib\n      include ::Rake::DSL if defined?(::Rake::DSL)\n      include RSpec::Core::ShellEscape\n\n      # Default path to the RSpec executable.\n      DEFAULT_RSPEC_PATH = File.expand_path('../../../../exe/rspec', __FILE__)\n\n      # Default pattern for spec files.\n      DEFAULT_PATTERN = 'spec/**{,/*/**}/*_spec.rb'\n\n      # Name of task. Defaults to `:spec`.\n      attr_accessor :name\n\n      # Files matching this pattern will be loaded.\n      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.\n      attr_accessor :pattern\n\n      # Files matching this pattern will be excluded.\n      # Defaults to `nil`.\n      attr_accessor :exclude_pattern\n\n      # Whether or not to fail Rake when an error occurs (typically when\n      # examples fail). Defaults to `true`.\n      attr_accessor :fail_on_error\n\n      # A message to print to stderr when there are failures.\n      attr_accessor :failure_message\n\n      if RUBY_VERSION < \"1.9.0\" || Support::Ruby.jruby?\n        # Run RSpec with a clean (empty) environment is not supported\n        # :nocov:\n        def with_clean_environment=(_value)\n          raise ArgumentError, \"Running in a clean environment is not supported on Ruby versions before 1.9.0\"\n        end\n\n        # Run RSpec with a clean (empty) environment is not supported\n        def with_clean_environment\n          false\n        end\n        # :nocov:\n      else\n        # Run RSpec with a clean (empty) environment.\n        attr_accessor :with_clean_environment\n      end\n\n      # Use verbose output. If this is set to true, the task will print the\n      # executed spec command to stdout. Defaults to `true`.\n      attr_accessor :verbose\n\n      # Command line options to pass to ruby. Defaults to `nil`.\n      attr_accessor :ruby_opts\n\n      # Path to RSpec. Defaults to the absolute path to the\n      # rspec binary from the loaded rspec-core gem.\n      attr_accessor :rspec_path\n\n      # Command line options to pass to RSpec. Defaults to `nil`.\n      attr_accessor :rspec_opts\n\n      def initialize(*args, &task_block)\n        @name          = args.shift || :spec\n        @ruby_opts     = nil\n        @rspec_opts    = nil\n        @verbose       = true\n        @fail_on_error = true\n        @rspec_path    = DEFAULT_RSPEC_PATH\n        @pattern       = DEFAULT_PATTERN\n\n        define(args, &task_block)\n      end\n\n      # @private\n      def run_task(verbose)\n        command = spec_command\n        puts command if verbose\n\n        if with_clean_environment\n          return if system({}, command, :unsetenv_others => true)\n        else\n          return if system(command)\n        end\n\n        puts failure_message if failure_message\n\n        return unless fail_on_error\n        $stderr.puts \"#{command} failed\" if verbose\n        exit $?.exitstatus || 1\n      end\n\n    private\n\n      # @private\n      def define(args, &task_block)\n        desc \"Run RSpec code examples\" unless ::Rake.application.last_description\n\n        task name, *args do |_, task_args|\n          RakeFileUtils.__send__(:verbose, verbose) do\n            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block\n            run_task verbose\n          end\n        end\n      end\n\n      def file_inclusion_specification\n        if ENV['SPEC']\n          FileList[ENV['SPEC']].sort\n        elsif String === pattern && !File.exist?(pattern)\n          return if [*rspec_opts].any? { |opt| opt =~ /--pattern/ }\n          \"--pattern #{escape pattern}\"\n        else\n          # Before RSpec 3.1, we used `FileList` to get the list of matched\n          # files, and then pass that along to the `rspec` command. Starting\n          # with 3.1, we prefer to pass along the pattern as-is to the `rspec`\n          # command, for 3 reasons:\n          #\n          #   * It's *much* less verbose to pass one `--pattern` option than a\n          #     long list of files.\n          #   * It ensures `task.pattern` and `--pattern` have the same\n          #     behavior.\n          #   * It fixes a bug, where\n          #     `task.pattern = pattern_that_matches_no_files` would run *all*\n          #     files because it would cause no pattern or file args to get\n          #     passed to `rspec`, which causes all files to get run.\n          #\n          # However, `FileList` is *far* more flexible than the `--pattern`\n          # option. Specifically, it supports individual files and directories,\n          # as well as arrays of files, directories and globs, as well as other\n          # `FileList` objects.\n          #\n          # For backwards compatibility, we have to fall back to using FileList\n          # if the user has passed a `pattern` option that will not work with\n          # `--pattern`.\n          #\n          # TODO: consider deprecating support for this and removing it in\n          #   RSpec 4.\n          FileList[pattern].sort.map { |file| escape file }\n        end\n      end\n\n      def file_exclusion_specification\n        \" --exclude-pattern #{escape exclude_pattern}\" if exclude_pattern\n      end\n\n      def spec_command\n        cmd_parts = []\n        cmd_parts << RUBY\n        cmd_parts << ruby_opts\n        cmd_parts << rspec_load_path\n        cmd_parts << escape(rspec_path)\n        cmd_parts << file_inclusion_specification\n        cmd_parts << file_exclusion_specification\n        cmd_parts << rspec_opts\n        cmd_parts.flatten.reject(&blank).join(\" \")\n      end\n\n      def blank\n        lambda { |s| s.nil? || s == \"\" }\n      end\n\n      def rspec_load_path\n        @rspec_load_path ||= begin\n          core_and_support = $LOAD_PATH.grep(\n            /#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib/\n          ).uniq\n\n          \"-I#{core_and_support.map { |file| escape file }.join(File::PATH_SEPARATOR)}\"\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "run_task", "signature": "def run_task(verbose)", "start_line": 92, "end_line": 107}, "metadata": {"module": "RSpec", "class_name": "RakeTask", "class_signature": "class RakeTask < < ::Rake::TaskLib"}, "task_id": 297}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/reporter.rb", "focal_code": "def initialize(configuration)\n      @configuration = configuration\n      @listeners = Hash.new { |h, k| h[k] = Set.new }\n      @examples = []\n      @failed_examples = []\n      @pending_examples = []\n      @duration = @start = @load_time = nil\n      @non_example_exception_count = 0\n      @setup_default = lambda {}\n      @setup = false\n      @profiler = nil\n    end", "file_content": "module RSpec::Core\n  # A reporter will send notifications to listeners, usually formatters for the\n  # spec suite run.\n  class Reporter\n    # @private\n    RSPEC_NOTIFICATIONS = Set.new(\n      [\n        :close, :deprecation, :deprecation_summary, :dump_failures, :dump_pending,\n        :dump_profile, :dump_summary, :example_failed, :example_group_finished,\n        :example_group_started, :example_passed, :example_pending, :example_started,\n        :message, :seed, :start, :start_dump, :stop, :example_finished\n      ])\n\n    def initialize(configuration)\n      @configuration = configuration\n      @listeners = Hash.new { |h, k| h[k] = Set.new }\n      @examples = []\n      @failed_examples = []\n      @pending_examples = []\n      @duration = @start = @load_time = nil\n      @non_example_exception_count = 0\n      @setup_default = lambda {}\n      @setup = false\n      @profiler = nil\n    end\n\n    # @private\n    attr_reader :examples, :failed_examples, :pending_examples\n\n    # Registers a listener to a list of notifications. The reporter will send\n    # notification of events to all registered listeners.\n    #\n    # @param listener [Object] An object that wishes to be notified of reporter\n    #   events\n    # @param notifications [Array] Array of symbols represents the events a\n    #   listener wishes to subscribe too\n    def register_listener(listener, *notifications)\n      notifications.each do |notification|\n        @listeners[notification.to_sym] << listener\n      end\n      true\n    end\n\n    # @private\n    def prepare_default(loader, output_stream, deprecation_stream)\n      @setup_default = lambda do\n        loader.setup_default output_stream, deprecation_stream\n      end\n    end\n\n    # @private\n    def registered_listeners(notification)\n      @listeners[notification].to_a\n    end\n\n    # @overload report(count, &block)\n    # @overload report(count, &block)\n    # @param expected_example_count [Integer] the number of examples being run\n    # @yield [Block] block yields itself for further reporting.\n    #\n    # Initializes the report run and yields itself for further reporting. The\n    # block is required, so that the reporter can manage cleaning up after the\n    # run.\n    #\n    # @example\n    #\n    #     reporter.report(group.examples.size) do |r|\n    #       example_groups.map {|g| g.run(r) }\n    #     end\n    #\n    def report(expected_example_count)\n      start(expected_example_count)\n      begin\n        yield self\n      ensure\n        finish\n      end\n    end\n\n    # @param exit_code [Integer] the exit_code to be return by the reporter\n    #\n    # Reports a run that exited early without having run any examples.\n    #\n    def exit_early(exit_code)\n      report(0) { exit_code }\n    end\n\n    # @private\n    def start(expected_example_count, time=RSpec::Core::Time.now)\n      @start = time\n      @load_time = (@start - @configuration.start_time).to_f\n      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)\n      notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)\n    end\n\n    # @param message [#to_s] A message object to send to formatters\n    #\n    # Send a custom message to supporting formatters.\n    def message(message)\n      notify :message, Notifications::MessageNotification.new(message)\n    end\n\n    # @param event [Symbol] Name of the custom event to trigger on formatters\n    # @param options [Hash] Hash of arguments to provide via `CustomNotification`\n    #\n    # Publish a custom event to supporting registered formatters.\n    # @see RSpec::Core::Notifications::CustomNotification\n    def publish(event, options={})\n      if RSPEC_NOTIFICATIONS.include? event\n        raise \"RSpec::Core::Reporter#publish is intended for sending custom \" \\\n              \"events not internal RSpec ones, please rename your custom event.\"\n      end\n      notify event, Notifications::CustomNotification.for(options)\n    end\n\n    # @private\n    def example_group_started(group)\n      notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?\n    end\n\n    # @private\n    def example_group_finished(group)\n      notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?\n    end\n\n    # @private\n    def example_started(example)\n      @examples << example\n      notify :example_started, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_finished(example)\n      notify :example_finished, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_passed(example)\n      notify :example_passed, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_failed(example)\n      @failed_examples << example\n      notify :example_failed, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_pending(example)\n      @pending_examples << example\n      notify :example_pending, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def deprecation(hash)\n      notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)\n    end\n\n    # @private\n    # Provides a way to notify of an exception that is not tied to any\n    # particular example (such as an exception encountered in a :suite hook).\n    # Exceptions will be formatted the same way they normally are.\n    def notify_non_example_exception(exception, context_description)\n      @configuration.world.non_example_failure = true\n      @non_example_exception_count += 1\n\n      example = Example.new(AnonymousExampleGroup, context_description, {})\n      presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)\n      message presenter.fully_formatted(nil)\n    end\n\n    # @private\n    def finish\n      close_after do\n        stop\n        notify :start_dump,    Notifications::NullNotification\n        notify :dump_pending,  Notifications::ExamplesNotification.new(self)\n        notify :dump_failures, Notifications::ExamplesNotification.new(self)\n        notify :deprecation_summary, Notifications::NullNotification\n        unless mute_profile_output?\n          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,\n                                                                       @configuration.profile_examples,\n                                                                       @profiler.example_groups)\n        end\n        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,\n                                                                     @pending_examples, @load_time,\n                                                                     @non_example_exception_count)\n        notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)\n      end\n    end\n\n    # @private\n    def close_after\n      yield\n    ensure\n      close\n    end\n\n    # @private\n    def stop\n      @duration = (RSpec::Core::Time.now - @start).to_f if @start\n      notify :stop, Notifications::ExamplesNotification.new(self)\n    end\n\n    # @private\n    def notify(event, notification)\n      ensure_listeners_ready\n      registered_listeners(event).each do |formatter|\n        formatter.__send__(event, notification)\n      end\n    end\n\n    # @private\n    def abort_with(msg, exit_status)\n      message(msg)\n      close\n      exit!(exit_status)\n    end\n\n    # @private\n    def fail_fast_limit_met?\n      return false unless (fail_fast = @configuration.fail_fast)\n\n      if fail_fast == true\n        @failed_examples.any?\n      else\n        fail_fast <= @failed_examples.size\n      end\n    end\n\n  private\n\n    def ensure_listeners_ready\n      return if @setup\n\n      @setup_default.call\n      @profiler = Profiler.new\n      register_listener @profiler, *Profiler::NOTIFICATIONS\n      @setup = true\n    end\n\n    def close\n      notify :close, Notifications::NullNotification\n    end\n\n    def mute_profile_output?\n      # Don't print out profiled info if there are failures and `--fail-fast` is\n      # used, it just clutters the output.\n      !@configuration.profile_examples? || fail_fast_limit_met?\n    end\n\n    def seed_used?\n      @configuration.seed && @configuration.seed_used?\n    end\n  end\n\n  # @private\n  # # Used in place of a {Reporter} for situations where we don't want reporting output.\n  class NullReporter\n    def self.method_missing(*)\n      # ignore\n    end\n    private_class_method :method_missing\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(configuration)", "start_line": 14, "end_line": 25}, "metadata": {"module": "RSpec", "class_name": "Reporter", "class_signature": "class Reporter"}, "task_id": 298}
{"function_name": "finish", "file_path": "rspec-core/lib/rspec/core/reporter.rb", "focal_code": "def finish\n      close_after do\n        stop\n        notify :start_dump,    Notifications::NullNotification\n        notify :dump_pending,  Notifications::ExamplesNotification.new(self)\n        notify :dump_failures, Notifications::ExamplesNotification.new(self)\n        notify :deprecation_summary, Notifications::NullNotification\n        unless mute_profile_output?\n          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,\n                                                                       @configuration.profile_examples,\n                                                                       @profiler.example_groups)\n        end\n        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,\n                                                                     @pending_examples, @load_time,\n                                                                     @non_example_exception_count)\n        notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)\n      end\n    end", "file_content": "module RSpec::Core\n  # A reporter will send notifications to listeners, usually formatters for the\n  # spec suite run.\n  class Reporter\n    # @private\n    RSPEC_NOTIFICATIONS = Set.new(\n      [\n        :close, :deprecation, :deprecation_summary, :dump_failures, :dump_pending,\n        :dump_profile, :dump_summary, :example_failed, :example_group_finished,\n        :example_group_started, :example_passed, :example_pending, :example_started,\n        :message, :seed, :start, :start_dump, :stop, :example_finished\n      ])\n\n    def initialize(configuration)\n      @configuration = configuration\n      @listeners = Hash.new { |h, k| h[k] = Set.new }\n      @examples = []\n      @failed_examples = []\n      @pending_examples = []\n      @duration = @start = @load_time = nil\n      @non_example_exception_count = 0\n      @setup_default = lambda {}\n      @setup = false\n      @profiler = nil\n    end\n\n    # @private\n    attr_reader :examples, :failed_examples, :pending_examples\n\n    # Registers a listener to a list of notifications. The reporter will send\n    # notification of events to all registered listeners.\n    #\n    # @param listener [Object] An object that wishes to be notified of reporter\n    #   events\n    # @param notifications [Array] Array of symbols represents the events a\n    #   listener wishes to subscribe too\n    def register_listener(listener, *notifications)\n      notifications.each do |notification|\n        @listeners[notification.to_sym] << listener\n      end\n      true\n    end\n\n    # @private\n    def prepare_default(loader, output_stream, deprecation_stream)\n      @setup_default = lambda do\n        loader.setup_default output_stream, deprecation_stream\n      end\n    end\n\n    # @private\n    def registered_listeners(notification)\n      @listeners[notification].to_a\n    end\n\n    # @overload report(count, &block)\n    # @overload report(count, &block)\n    # @param expected_example_count [Integer] the number of examples being run\n    # @yield [Block] block yields itself for further reporting.\n    #\n    # Initializes the report run and yields itself for further reporting. The\n    # block is required, so that the reporter can manage cleaning up after the\n    # run.\n    #\n    # @example\n    #\n    #     reporter.report(group.examples.size) do |r|\n    #       example_groups.map {|g| g.run(r) }\n    #     end\n    #\n    def report(expected_example_count)\n      start(expected_example_count)\n      begin\n        yield self\n      ensure\n        finish\n      end\n    end\n\n    # @param exit_code [Integer] the exit_code to be return by the reporter\n    #\n    # Reports a run that exited early without having run any examples.\n    #\n    def exit_early(exit_code)\n      report(0) { exit_code }\n    end\n\n    # @private\n    def start(expected_example_count, time=RSpec::Core::Time.now)\n      @start = time\n      @load_time = (@start - @configuration.start_time).to_f\n      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)\n      notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)\n    end\n\n    # @param message [#to_s] A message object to send to formatters\n    #\n    # Send a custom message to supporting formatters.\n    def message(message)\n      notify :message, Notifications::MessageNotification.new(message)\n    end\n\n    # @param event [Symbol] Name of the custom event to trigger on formatters\n    # @param options [Hash] Hash of arguments to provide via `CustomNotification`\n    #\n    # Publish a custom event to supporting registered formatters.\n    # @see RSpec::Core::Notifications::CustomNotification\n    def publish(event, options={})\n      if RSPEC_NOTIFICATIONS.include? event\n        raise \"RSpec::Core::Reporter#publish is intended for sending custom \" \\\n              \"events not internal RSpec ones, please rename your custom event.\"\n      end\n      notify event, Notifications::CustomNotification.for(options)\n    end\n\n    # @private\n    def example_group_started(group)\n      notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?\n    end\n\n    # @private\n    def example_group_finished(group)\n      notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?\n    end\n\n    # @private\n    def example_started(example)\n      @examples << example\n      notify :example_started, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_finished(example)\n      notify :example_finished, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_passed(example)\n      notify :example_passed, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_failed(example)\n      @failed_examples << example\n      notify :example_failed, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def example_pending(example)\n      @pending_examples << example\n      notify :example_pending, Notifications::ExampleNotification.for(example)\n    end\n\n    # @private\n    def deprecation(hash)\n      notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)\n    end\n\n    # @private\n    # Provides a way to notify of an exception that is not tied to any\n    # particular example (such as an exception encountered in a :suite hook).\n    # Exceptions will be formatted the same way they normally are.\n    def notify_non_example_exception(exception, context_description)\n      @configuration.world.non_example_failure = true\n      @non_example_exception_count += 1\n\n      example = Example.new(AnonymousExampleGroup, context_description, {})\n      presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)\n      message presenter.fully_formatted(nil)\n    end\n\n    # @private\n    def finish\n      close_after do\n        stop\n        notify :start_dump,    Notifications::NullNotification\n        notify :dump_pending,  Notifications::ExamplesNotification.new(self)\n        notify :dump_failures, Notifications::ExamplesNotification.new(self)\n        notify :deprecation_summary, Notifications::NullNotification\n        unless mute_profile_output?\n          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,\n                                                                       @configuration.profile_examples,\n                                                                       @profiler.example_groups)\n        end\n        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,\n                                                                     @pending_examples, @load_time,\n                                                                     @non_example_exception_count)\n        notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)\n      end\n    end\n\n    # @private\n    def close_after\n      yield\n    ensure\n      close\n    end\n\n    # @private\n    def stop\n      @duration = (RSpec::Core::Time.now - @start).to_f if @start\n      notify :stop, Notifications::ExamplesNotification.new(self)\n    end\n\n    # @private\n    def notify(event, notification)\n      ensure_listeners_ready\n      registered_listeners(event).each do |formatter|\n        formatter.__send__(event, notification)\n      end\n    end\n\n    # @private\n    def abort_with(msg, exit_status)\n      message(msg)\n      close\n      exit!(exit_status)\n    end\n\n    # @private\n    def fail_fast_limit_met?\n      return false unless (fail_fast = @configuration.fail_fast)\n\n      if fail_fast == true\n        @failed_examples.any?\n      else\n        fail_fast <= @failed_examples.size\n      end\n    end\n\n  private\n\n    def ensure_listeners_ready\n      return if @setup\n\n      @setup_default.call\n      @profiler = Profiler.new\n      register_listener @profiler, *Profiler::NOTIFICATIONS\n      @setup = true\n    end\n\n    def close\n      notify :close, Notifications::NullNotification\n    end\n\n    def mute_profile_output?\n      # Don't print out profiled info if there are failures and `--fail-fast` is\n      # used, it just clutters the output.\n      !@configuration.profile_examples? || fail_fast_limit_met?\n    end\n\n    def seed_used?\n      @configuration.seed && @configuration.seed_used?\n    end\n  end\n\n  # @private\n  # # Used in place of a {Reporter} for situations where we don't want reporting output.\n  class NullReporter\n    def self.method_missing(*)\n      # ignore\n    end\n    private_class_method :method_missing\n  end\nend\n", "language": "Ruby", "function_component": {"name": "finish", "signature": "def finish close_after do", "start_line": 173, "end_line": 190}, "metadata": {"module": "RSpec", "class_name": "Reporter", "class_signature": "class Reporter"}, "task_id": 299}
{"function_name": "ascend_until", "file_path": "rspec-core/lib/rspec/core/ruby_project.rb", "focal_code": "def ascend_until\n        fs = File::SEPARATOR\n        escaped_slash = \"\\\\#{fs}\"\n        special = \"_RSPEC_ESCAPED_SLASH_\"\n        project_path = File.expand_path(\".\")\n        parts = project_path.gsub(escaped_slash, special).squeeze(fs).split(fs).map do |x|\n          x.gsub(special, escaped_slash)\n        end\n\n        until parts.empty?\n          path = parts.join(fs)\n          path = fs if path == \"\"\n          return path if yield(path)\n          parts.pop\n        end\n      end", "file_content": "# This is borrowed (slightly modified) from Scott Taylor's\n# project_path project:\n#   http://github.com/smtlaissezfaire/project_path\nmodule RSpec\n  module Core\n    # @private\n    module RubyProject\n      def add_to_load_path(*dirs)\n        dirs.each { |dir| add_dir_to_load_path(File.join(root, dir)) }\n      end\n\n      def add_dir_to_load_path(dir)\n        $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)\n      end\n\n      def root\n        @project_root ||= determine_root\n      end\n\n      def determine_root\n        find_first_parent_containing('spec') || '.'\n      end\n\n      def find_first_parent_containing(dir)\n        ascend_until { |path| File.exist?(File.join(path, dir)) }\n      end\n\n      def ascend_until\n        fs = File::SEPARATOR\n        escaped_slash = \"\\\\#{fs}\"\n        special = \"_RSPEC_ESCAPED_SLASH_\"\n        project_path = File.expand_path(\".\")\n        parts = project_path.gsub(escaped_slash, special).squeeze(fs).split(fs).map do |x|\n          x.gsub(special, escaped_slash)\n        end\n\n        until parts.empty?\n          path = parts.join(fs)\n          path = fs if path == \"\"\n          return path if yield(path)\n          parts.pop\n        end\n      end\n\n      module_function :add_to_load_path\n      module_function :add_dir_to_load_path\n      module_function :root\n      module_function :determine_root\n      module_function :find_first_parent_containing\n      module_function :ascend_until\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "ascend_until", "signature": "def ascend_until fs = File::SEPARATOR", "start_line": 28, "end_line": 43}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 300}
{"function_name": "autorun", "file_path": "rspec-core/lib/rspec/core/runner.rb", "focal_code": "def self.autorun\n        if autorun_disabled?\n          RSpec.deprecate(\"Requiring `rspec/autorun` when running RSpec via the `rspec` command\")\n          return\n        elsif installed_at_exit? || running_in_drb?\n          return\n        end\n\n        at_exit { perform_at_exit }\n        @installed_at_exit = true\n      end", "file_content": "module RSpec\n  module Core\n    # Provides the main entry point to run a suite of RSpec examples.\n    class Runner\n      # @attr_reader\n      # @private\n      attr_reader :options, :configuration, :world\n\n      # Register an `at_exit` hook that runs the suite when the process exits.\n      #\n      # @note This is not generally needed. The `rspec` command takes care\n      #       of running examples for you without involving an `at_exit`\n      #       hook. This is only needed if you are running specs using\n      #       the `ruby` command, and even then, the normal way to invoke\n      #       this is by requiring `rspec/autorun`.\n      def self.autorun\n        if autorun_disabled?\n          RSpec.deprecate(\"Requiring `rspec/autorun` when running RSpec via the `rspec` command\")\n          return\n        elsif installed_at_exit? || running_in_drb?\n          return\n        end\n\n        at_exit { perform_at_exit }\n        @installed_at_exit = true\n      end\n\n      # @private\n      def self.perform_at_exit\n        # Don't bother running any specs and just let the program terminate\n        # if we got here due to an unrescued exception (anything other than\n        # SystemExit, which is raised when somebody calls Kernel#exit).\n        return unless $!.nil? || $!.is_a?(SystemExit)\n\n        # We got here because either the end of the program was reached or\n        # somebody called Kernel#exit. Run the specs and then override any\n        # existing exit status with RSpec's exit status if any specs failed.\n        invoke\n      end\n\n      # Runs the suite of specs and exits the process with an appropriate exit\n      # code.\n      def self.invoke\n        disable_autorun!\n        status = run(ARGV, $stderr, $stdout).to_i\n        exit(status) if status != 0\n      end\n\n      # Run a suite of RSpec examples. Does not exit.\n      #\n      # This is used internally by RSpec to run a suite, but is available\n      # for use by any other automation tool.\n      #\n      # If you want to run this multiple times in the same process, and you\n      # want files like `spec_helper.rb` to be reloaded, be sure to load `load`\n      # instead of `require`.\n      #\n      # @param args [Array] command-line-supported arguments\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def self.run(args, err=$stderr, out=$stdout)\n        trap_interrupt\n        options = ConfigurationOptions.new(args)\n\n        if options.options[:runner]\n          options.options[:runner].call(options, err, out)\n        else\n          new(options).run(err, out)\n        end\n      end\n\n      def initialize(options, configuration=RSpec.configuration, world=RSpec.world)\n        @options       = options\n        @configuration = configuration\n        @world         = world\n      end\n\n      # Configures and runs a spec suite.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def run(err, out)\n        setup(err, out)\n        return @configuration.reporter.exit_early(exit_code) if RSpec.world.wants_to_quit\n\n        run_specs(@world.ordered_example_groups).tap do\n          persist_example_statuses\n        end\n      end\n\n      # Wires together the various configuration objects and state holders.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def setup(err, out)\n        configure(err, out)\n        return if RSpec.world.wants_to_quit\n\n        @configuration.load_spec_files\n      ensure\n        @world.announce_filters\n      end\n\n      # Runs the provided example groups.\n      #\n      # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def run_specs(example_groups)\n        examples_count = @world.example_count(example_groups)\n        examples_passed = @configuration.reporter.report(examples_count) do |reporter|\n          @configuration.with_suite_hooks do\n            if examples_count == 0 && @configuration.fail_if_no_examples\n              return @configuration.failure_exit_code\n            end\n\n            example_groups.map { |g| g.run(reporter) }.all?\n          end\n        end\n\n        exit_code(examples_passed)\n      end\n\n      # @private\n      def configure(err, out)\n        @configuration.error_stream = err\n        @configuration.output_stream = out if @configuration.output_stream == $stdout\n        @options.configure(@configuration)\n      end\n\n      # @private\n      def self.disable_autorun!\n        @autorun_disabled = true\n      end\n\n      # @private\n      def self.autorun_disabled?\n        @autorun_disabled ||= false\n      end\n\n      # @private\n      def self.installed_at_exit?\n        @installed_at_exit ||= false\n      end\n\n      # @private\n      def self.running_in_drb?\n        return false unless defined?(DRb)\n\n        server = begin\n                   DRb.current_server\n                 rescue DRb::DRbServerNotFound\n                   return false\n                 end\n\n        return false unless server && server.alive?\n\n        require 'socket'\n        require 'uri'\n\n        local_ipv4 = begin\n                       IPSocket.getaddress(Socket.gethostname)\n                     rescue SocketError\n                       return false\n                     end\n\n        [\"127.0.0.1\", \"localhost\", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }\n      end\n\n      # @private\n      def self.trap_interrupt\n        trap('INT') { handle_interrupt }\n      end\n\n      # @private\n      def self.handle_interrupt\n        if RSpec.world.wants_to_quit\n          exit!(1)\n        else\n          RSpec.world.wants_to_quit = true\n\n          $stderr.puts(\n            \"\\nRSpec is shutting down and will print the summary report... Interrupt again to force quit \" \\\n            \"(warning: at_exit hooks will be skipped if you force quit).\"\n          )\n        end\n      end\n\n      # @private\n      def exit_code(examples_passed=false)\n        return @configuration.error_exit_code || @configuration.failure_exit_code if @world.non_example_failure\n        return @configuration.failure_exit_code unless examples_passed\n\n        0\n      end\n\n    private\n\n      def persist_example_statuses\n        return if @configuration.dry_run\n        return unless (path = @configuration.example_status_persistence_file_path)\n\n        ExampleStatusPersister.persist(@world.all_examples, path)\n      rescue SystemCallError => e\n        RSpec.warning \"Could not write example statuses to #{path} (configured as \" \\\n                      \"`config.example_status_persistence_file_path`) due to a \" \\\n                      \"system error: #{e.inspect}. Please check that the config \" \\\n                      \"option is set to an accessible, valid file path\", :call_site => nil\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "autorun", "signature": "def self.autorun if autorun_disabled?", "start_line": 16, "end_line": 26}, "metadata": {"module": "RSpec", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 301}
{"function_name": "running_in_drb?", "file_path": "rspec-core/lib/rspec/core/runner.rb", "focal_code": "def self.running_in_drb?\n        return false unless defined?(DRb)\n\n        server = begin\n                   DRb.current_server\n                 rescue DRb::DRbServerNotFound\n                   return false\n                 end\n\n        return false unless server && server.alive?\n\n        require 'socket'\n        require 'uri'\n\n        local_ipv4 = begin\n                       IPSocket.getaddress(Socket.gethostname)\n                     rescue SocketError\n                       return false\n                     end\n\n        [\"127.0.0.1\", \"localhost\", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }\n      end", "file_content": "module RSpec\n  module Core\n    # Provides the main entry point to run a suite of RSpec examples.\n    class Runner\n      # @attr_reader\n      # @private\n      attr_reader :options, :configuration, :world\n\n      # Register an `at_exit` hook that runs the suite when the process exits.\n      #\n      # @note This is not generally needed. The `rspec` command takes care\n      #       of running examples for you without involving an `at_exit`\n      #       hook. This is only needed if you are running specs using\n      #       the `ruby` command, and even then, the normal way to invoke\n      #       this is by requiring `rspec/autorun`.\n      def self.autorun\n        if autorun_disabled?\n          RSpec.deprecate(\"Requiring `rspec/autorun` when running RSpec via the `rspec` command\")\n          return\n        elsif installed_at_exit? || running_in_drb?\n          return\n        end\n\n        at_exit { perform_at_exit }\n        @installed_at_exit = true\n      end\n\n      # @private\n      def self.perform_at_exit\n        # Don't bother running any specs and just let the program terminate\n        # if we got here due to an unrescued exception (anything other than\n        # SystemExit, which is raised when somebody calls Kernel#exit).\n        return unless $!.nil? || $!.is_a?(SystemExit)\n\n        # We got here because either the end of the program was reached or\n        # somebody called Kernel#exit. Run the specs and then override any\n        # existing exit status with RSpec's exit status if any specs failed.\n        invoke\n      end\n\n      # Runs the suite of specs and exits the process with an appropriate exit\n      # code.\n      def self.invoke\n        disable_autorun!\n        status = run(ARGV, $stderr, $stdout).to_i\n        exit(status) if status != 0\n      end\n\n      # Run a suite of RSpec examples. Does not exit.\n      #\n      # This is used internally by RSpec to run a suite, but is available\n      # for use by any other automation tool.\n      #\n      # If you want to run this multiple times in the same process, and you\n      # want files like `spec_helper.rb` to be reloaded, be sure to load `load`\n      # instead of `require`.\n      #\n      # @param args [Array] command-line-supported arguments\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def self.run(args, err=$stderr, out=$stdout)\n        trap_interrupt\n        options = ConfigurationOptions.new(args)\n\n        if options.options[:runner]\n          options.options[:runner].call(options, err, out)\n        else\n          new(options).run(err, out)\n        end\n      end\n\n      def initialize(options, configuration=RSpec.configuration, world=RSpec.world)\n        @options       = options\n        @configuration = configuration\n        @world         = world\n      end\n\n      # Configures and runs a spec suite.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def run(err, out)\n        setup(err, out)\n        return @configuration.reporter.exit_early(exit_code) if RSpec.world.wants_to_quit\n\n        run_specs(@world.ordered_example_groups).tap do\n          persist_example_statuses\n        end\n      end\n\n      # Wires together the various configuration objects and state holders.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def setup(err, out)\n        configure(err, out)\n        return if RSpec.world.wants_to_quit\n\n        @configuration.load_spec_files\n      ensure\n        @world.announce_filters\n      end\n\n      # Runs the provided example groups.\n      #\n      # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def run_specs(example_groups)\n        examples_count = @world.example_count(example_groups)\n        examples_passed = @configuration.reporter.report(examples_count) do |reporter|\n          @configuration.with_suite_hooks do\n            if examples_count == 0 && @configuration.fail_if_no_examples\n              return @configuration.failure_exit_code\n            end\n\n            example_groups.map { |g| g.run(reporter) }.all?\n          end\n        end\n\n        exit_code(examples_passed)\n      end\n\n      # @private\n      def configure(err, out)\n        @configuration.error_stream = err\n        @configuration.output_stream = out if @configuration.output_stream == $stdout\n        @options.configure(@configuration)\n      end\n\n      # @private\n      def self.disable_autorun!\n        @autorun_disabled = true\n      end\n\n      # @private\n      def self.autorun_disabled?\n        @autorun_disabled ||= false\n      end\n\n      # @private\n      def self.installed_at_exit?\n        @installed_at_exit ||= false\n      end\n\n      # @private\n      def self.running_in_drb?\n        return false unless defined?(DRb)\n\n        server = begin\n                   DRb.current_server\n                 rescue DRb::DRbServerNotFound\n                   return false\n                 end\n\n        return false unless server && server.alive?\n\n        require 'socket'\n        require 'uri'\n\n        local_ipv4 = begin\n                       IPSocket.getaddress(Socket.gethostname)\n                     rescue SocketError\n                       return false\n                     end\n\n        [\"127.0.0.1\", \"localhost\", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }\n      end\n\n      # @private\n      def self.trap_interrupt\n        trap('INT') { handle_interrupt }\n      end\n\n      # @private\n      def self.handle_interrupt\n        if RSpec.world.wants_to_quit\n          exit!(1)\n        else\n          RSpec.world.wants_to_quit = true\n\n          $stderr.puts(\n            \"\\nRSpec is shutting down and will print the summary report... Interrupt again to force quit \" \\\n            \"(warning: at_exit hooks will be skipped if you force quit).\"\n          )\n        end\n      end\n\n      # @private\n      def exit_code(examples_passed=false)\n        return @configuration.error_exit_code || @configuration.failure_exit_code if @world.non_example_failure\n        return @configuration.failure_exit_code unless examples_passed\n\n        0\n      end\n\n    private\n\n      def persist_example_statuses\n        return if @configuration.dry_run\n        return unless (path = @configuration.example_status_persistence_file_path)\n\n        ExampleStatusPersister.persist(@world.all_examples, path)\n      rescue SystemCallError => e\n        RSpec.warning \"Could not write example statuses to #{path} (configured as \" \\\n                      \"`config.example_status_persistence_file_path`) due to a \" \\\n                      \"system error: #{e.inspect}. Please check that the config \" \\\n                      \"option is set to an accessible, valid file path\", :call_site => nil\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "running_in_drb?", "signature": "def self.running_in_drb? return false unless defined?(DRb)", "start_line": 151, "end_line": 172}, "metadata": {"module": "RSpec", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 302}
{"function_name": "handle_interrupt", "file_path": "rspec-core/lib/rspec/core/runner.rb", "focal_code": "def self.handle_interrupt\n        if RSpec.world.wants_to_quit\n          exit!(1)\n        else\n          RSpec.world.wants_to_quit = true\n\n          $stderr.puts(\n            \"\\nRSpec is shutting down and will print the summary report... Interrupt again to force quit \" \\\n            \"(warning: at_exit hooks will be skipped if you force quit).\"\n          )\n        end\n      end", "file_content": "module RSpec\n  module Core\n    # Provides the main entry point to run a suite of RSpec examples.\n    class Runner\n      # @attr_reader\n      # @private\n      attr_reader :options, :configuration, :world\n\n      # Register an `at_exit` hook that runs the suite when the process exits.\n      #\n      # @note This is not generally needed. The `rspec` command takes care\n      #       of running examples for you without involving an `at_exit`\n      #       hook. This is only needed if you are running specs using\n      #       the `ruby` command, and even then, the normal way to invoke\n      #       this is by requiring `rspec/autorun`.\n      def self.autorun\n        if autorun_disabled?\n          RSpec.deprecate(\"Requiring `rspec/autorun` when running RSpec via the `rspec` command\")\n          return\n        elsif installed_at_exit? || running_in_drb?\n          return\n        end\n\n        at_exit { perform_at_exit }\n        @installed_at_exit = true\n      end\n\n      # @private\n      def self.perform_at_exit\n        # Don't bother running any specs and just let the program terminate\n        # if we got here due to an unrescued exception (anything other than\n        # SystemExit, which is raised when somebody calls Kernel#exit).\n        return unless $!.nil? || $!.is_a?(SystemExit)\n\n        # We got here because either the end of the program was reached or\n        # somebody called Kernel#exit. Run the specs and then override any\n        # existing exit status with RSpec's exit status if any specs failed.\n        invoke\n      end\n\n      # Runs the suite of specs and exits the process with an appropriate exit\n      # code.\n      def self.invoke\n        disable_autorun!\n        status = run(ARGV, $stderr, $stdout).to_i\n        exit(status) if status != 0\n      end\n\n      # Run a suite of RSpec examples. Does not exit.\n      #\n      # This is used internally by RSpec to run a suite, but is available\n      # for use by any other automation tool.\n      #\n      # If you want to run this multiple times in the same process, and you\n      # want files like `spec_helper.rb` to be reloaded, be sure to load `load`\n      # instead of `require`.\n      #\n      # @param args [Array] command-line-supported arguments\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def self.run(args, err=$stderr, out=$stdout)\n        trap_interrupt\n        options = ConfigurationOptions.new(args)\n\n        if options.options[:runner]\n          options.options[:runner].call(options, err, out)\n        else\n          new(options).run(err, out)\n        end\n      end\n\n      def initialize(options, configuration=RSpec.configuration, world=RSpec.world)\n        @options       = options\n        @configuration = configuration\n        @world         = world\n      end\n\n      # Configures and runs a spec suite.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def run(err, out)\n        setup(err, out)\n        return @configuration.reporter.exit_early(exit_code) if RSpec.world.wants_to_quit\n\n        run_specs(@world.ordered_example_groups).tap do\n          persist_example_statuses\n        end\n      end\n\n      # Wires together the various configuration objects and state holders.\n      #\n      # @param err [IO] error stream\n      # @param out [IO] output stream\n      def setup(err, out)\n        configure(err, out)\n        return if RSpec.world.wants_to_quit\n\n        @configuration.load_spec_files\n      ensure\n        @world.announce_filters\n      end\n\n      # Runs the provided example groups.\n      #\n      # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run\n      # @return [Fixnum] exit status code. 0 if all specs passed,\n      #   or the configured failure exit code (1 by default) if specs\n      #   failed.\n      def run_specs(example_groups)\n        examples_count = @world.example_count(example_groups)\n        examples_passed = @configuration.reporter.report(examples_count) do |reporter|\n          @configuration.with_suite_hooks do\n            if examples_count == 0 && @configuration.fail_if_no_examples\n              return @configuration.failure_exit_code\n            end\n\n            example_groups.map { |g| g.run(reporter) }.all?\n          end\n        end\n\n        exit_code(examples_passed)\n      end\n\n      # @private\n      def configure(err, out)\n        @configuration.error_stream = err\n        @configuration.output_stream = out if @configuration.output_stream == $stdout\n        @options.configure(@configuration)\n      end\n\n      # @private\n      def self.disable_autorun!\n        @autorun_disabled = true\n      end\n\n      # @private\n      def self.autorun_disabled?\n        @autorun_disabled ||= false\n      end\n\n      # @private\n      def self.installed_at_exit?\n        @installed_at_exit ||= false\n      end\n\n      # @private\n      def self.running_in_drb?\n        return false unless defined?(DRb)\n\n        server = begin\n                   DRb.current_server\n                 rescue DRb::DRbServerNotFound\n                   return false\n                 end\n\n        return false unless server && server.alive?\n\n        require 'socket'\n        require 'uri'\n\n        local_ipv4 = begin\n                       IPSocket.getaddress(Socket.gethostname)\n                     rescue SocketError\n                       return false\n                     end\n\n        [\"127.0.0.1\", \"localhost\", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }\n      end\n\n      # @private\n      def self.trap_interrupt\n        trap('INT') { handle_interrupt }\n      end\n\n      # @private\n      def self.handle_interrupt\n        if RSpec.world.wants_to_quit\n          exit!(1)\n        else\n          RSpec.world.wants_to_quit = true\n\n          $stderr.puts(\n            \"\\nRSpec is shutting down and will print the summary report... Interrupt again to force quit \" \\\n            \"(warning: at_exit hooks will be skipped if you force quit).\"\n          )\n        end\n      end\n\n      # @private\n      def exit_code(examples_passed=false)\n        return @configuration.error_exit_code || @configuration.failure_exit_code if @world.non_example_failure\n        return @configuration.failure_exit_code unless examples_passed\n\n        0\n      end\n\n    private\n\n      def persist_example_statuses\n        return if @configuration.dry_run\n        return unless (path = @configuration.example_status_persistence_file_path)\n\n        ExampleStatusPersister.persist(@world.all_examples, path)\n      rescue SystemCallError => e\n        RSpec.warning \"Could not write example statuses to #{path} (configured as \" \\\n                      \"`config.example_status_persistence_file_path`) due to a \" \\\n                      \"system error: #{e.inspect}. Please check that the config \" \\\n                      \"option is set to an accessible, valid file path\", :call_site => nil\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "handle_interrupt", "signature": "def self.handle_interrupt if RSpec.world.wants_to_quit", "start_line": 180, "end_line": 191}, "metadata": {"module": "RSpec", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 303}
{"function_name": "sandboxed", "file_path": "rspec-core/lib/rspec/core/sandbox.rb", "focal_code": "def self.sandboxed\n        orig_config  = RSpec.configuration\n        orig_world   = RSpec.world\n        orig_example = RSpec.current_example\n\n        RSpec.configuration = RSpec::Core::Configuration.new\n        RSpec.world         = RSpec::Core::World.new(RSpec.configuration)\n\n        yield RSpec.configuration\n      ensure\n        RSpec.configuration   = orig_config\n        RSpec.world           = orig_world\n        RSpec.current_example = orig_example\n      end", "file_content": "module RSpec\n  module Core\n    # A sandbox isolates the enclosed code into an environment that looks 'new'\n    # meaning globally accessed objects are reset for the duration of the\n    # sandbox.\n    #\n    # @note This module is not normally available. You must require\n    #   `rspec/core/sandbox` to load it.\n    module Sandbox\n      # Execute a provided block with RSpec global objects (configuration,\n      # world) reset.  This is used to test RSpec with RSpec.\n      #\n      # When calling this the configuration is passed into the provided block.\n      # Use this to set custom configs for your sandboxed examples.\n      #\n      # ```\n      # Sandbox.sandboxed do |config|\n      #   config.before(:context) { RSpec.current_example = nil }\n      # end\n      # ```\n      def self.sandboxed\n        orig_config  = RSpec.configuration\n        orig_world   = RSpec.world\n        orig_example = RSpec.current_example\n\n        RSpec.configuration = RSpec::Core::Configuration.new\n        RSpec.world         = RSpec::Core::World.new(RSpec.configuration)\n\n        yield RSpec.configuration\n      ensure\n        RSpec.configuration   = orig_config\n        RSpec.world           = orig_world\n        RSpec.current_example = orig_example\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "sandboxed", "signature": "def self.sandboxed orig_config  = RSpec.configuration", "start_line": 21, "end_line": 34}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 304}
{"function_name": "add", "file_path": "rspec-core/lib/rspec/core/shared_example_group.rb", "focal_code": "def add(context, name, *metadata_args, &block)\n          unless block\n            RSpec.warning \"Shared example group #{name} was defined without a \"\\\n                          \"block and will have no effect. Please define a \"\\\n                          \"block or remove the definition.\"\n          end\n\n          if RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion\n            return legacy_add(context, name, *metadata_args, &block)\n          end\n\n          unless valid_name?(name)\n            raise ArgumentError, \"Shared example group names can only be a string, \" \\\n                                 \"symbol or module but got: #{name.inspect}\"\n          end\n\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          warn_if_key_taken context, name, block\n\n          metadata = Metadata.build_hash_from(metadata_args)\n          shared_module = SharedExampleGroupModule.new(name, block, metadata)\n          shared_example_groups[context][name] = shared_module\n        end", "file_content": "RSpec::Support.require_rspec_support \"with_keywords_when_needed\"\n\nmodule RSpec\n  module Core\n    # Represents some functionality that is shared with multiple example groups.\n    # The functionality is defined by the provided block, which is lazily\n    # eval'd when the `SharedExampleGroupModule` instance is included in an example\n    # group.\n    class SharedExampleGroupModule < Module\n      # @private\n      attr_reader :definition\n\n      def initialize(description, definition, metadata)\n        @description = description\n        @definition  = definition\n        @metadata    = metadata\n      end\n\n      # Provides a human-readable representation of this module.\n      def inspect\n        \"#<#{self.class.name} #{@description.inspect}>\"\n      end\n      alias to_s inspect\n\n      # Ruby callback for when a module is included in another module is class.\n      # Our definition evaluates the shared group block in the context of the\n      # including example group.\n      def included(klass)\n        inclusion_line = klass.metadata[:location]\n        include_in klass, inclusion_line, [], nil\n      end\n\n      # @private\n      def include_in(klass, inclusion_line, args, customization_block)\n        klass.update_inherited_metadata(@metadata) unless @metadata.empty?\n\n        SharedExampleGroupInclusionStackFrame.with_frame(@description, inclusion_line) do\n          RSpec::Support::WithKeywordsWhenNeeded.class_exec(klass, *args, &@definition)\n          klass.class_exec(&customization_block) if customization_block\n        end\n      end\n    end\n\n    # Shared example groups let you define common context and/or common\n    # examples that you wish to use in multiple example groups.\n    #\n    # When defined, the shared group block is stored for later evaluation.\n    # It can later be included in an example group either explicitly\n    # (using `include_examples`, `include_context` or `it_behaves_like`)\n    # or implicitly (via matching metadata).\n    #\n    # Named shared example groups are scoped based on where they are\n    # defined. Shared groups defined in an example group are available\n    # for inclusion in that example group or any child example groups,\n    # but not in any parent or sibling example groups. Shared example\n    # groups defined at the top level can be included from any example group.\n    module SharedExampleGroup\n      # @overload shared_examples(name, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param block The block to be eval'd\n      # @overload shared_examples(name, metadata, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this\n      #     group; any example group or example with matching metadata will\n      #     automatically include this shared example group.\n      #   @param block The block to be eval'd\n      #\n      # Stores the block for later use. The block will be evaluated\n      # in the context of an example group via `include_examples`,\n      # `include_context`, or `it_behaves_like`.\n      #\n      # @example\n      #   shared_examples \"auditable\" do\n      #     it \"stores an audit record on save!\" do\n      #       expect { auditable.save! }.to change(Audit, :count).by(1)\n      #     end\n      #   end\n      #\n      #   RSpec.describe Account do\n      #     it_behaves_like \"auditable\" do\n      #       let(:auditable) { Account.new }\n      #     end\n      #   end\n      #\n      # @see ExampleGroup.it_behaves_like\n      # @see ExampleGroup.include_examples\n      # @see ExampleGroup.include_context\n      def shared_examples(name, *args, &block)\n        top_level = self == ExampleGroup\n        if top_level && RSpec::Support.thread_local_data[:in_example_group]\n          raise \"Creating isolated shared examples from within a context is \" \\\n                \"not allowed. Remove `RSpec.` prefix or move this to a \" \\\n                \"top-level scope.\"\n        end\n\n        RSpec.world.shared_example_group_registry.add(self, name, *args, &block)\n      end\n      alias shared_context      shared_examples\n      alias shared_examples_for shared_examples\n\n      # @api private\n      #\n      # Shared examples top level DSL.\n      module TopLevelDSL\n        # @private\n        def self.definitions\n          proc do\n            def shared_examples(name, *args, &block)\n              RSpec.world.shared_example_group_registry.add(:main, name, *args, &block)\n            end\n            alias shared_context      shared_examples\n            alias shared_examples_for shared_examples\n          end\n        end\n\n        # @private\n        def self.exposed_globally?\n          @exposed_globally ||= false\n        end\n\n        # @api private\n        #\n        # Adds the top level DSL methods to Module and the top level binding.\n        def self.expose_globally!\n          return if exposed_globally?\n          Core::DSL.change_global_dsl(&definitions)\n          @exposed_globally = true\n        end\n\n        # @api private\n        #\n        # Removes the top level DSL methods to Module and the top level binding.\n        def self.remove_globally!\n          return unless exposed_globally?\n\n          Core::DSL.change_global_dsl do\n            undef shared_examples\n            undef shared_context\n            undef shared_examples_for\n          end\n\n          @exposed_globally = false\n        end\n      end\n\n      # @private\n      class Registry\n        def add(context, name, *metadata_args, &block)\n          unless block\n            RSpec.warning \"Shared example group #{name} was defined without a \"\\\n                          \"block and will have no effect. Please define a \"\\\n                          \"block or remove the definition.\"\n          end\n\n          if RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion\n            return legacy_add(context, name, *metadata_args, &block)\n          end\n\n          unless valid_name?(name)\n            raise ArgumentError, \"Shared example group names can only be a string, \" \\\n                                 \"symbol or module but got: #{name.inspect}\"\n          end\n\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          warn_if_key_taken context, name, block\n\n          metadata = Metadata.build_hash_from(metadata_args)\n          shared_module = SharedExampleGroupModule.new(name, block, metadata)\n          shared_example_groups[context][name] = shared_module\n        end\n\n        def find(lookup_contexts, name)\n          lookup_contexts.each do |context|\n            found = shared_example_groups[context][name]\n            return found if found\n          end\n\n          shared_example_groups[:main][name]\n        end\n\n      private\n\n        # TODO: remove this in RSpec 4. This exists only to support\n        # `config.shared_context_metadata_behavior == :trigger_inclusion`,\n        # the legacy behavior of shared context metadata, which we do\n        # not want to support in RSpec 4.\n        def legacy_add(context, name, *metadata_args, &block)\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          shared_module = SharedExampleGroupModule.new(name, block, {})\n\n          if valid_name?(name)\n            warn_if_key_taken context, name, block\n            shared_example_groups[context][name] = shared_module\n          else\n            metadata_args.unshift name\n          end\n\n          return if metadata_args.empty?\n          RSpec.configuration.include shared_module, *metadata_args\n        end\n\n        def shared_example_groups\n          @shared_example_groups ||= Hash.new { |hash, context| hash[context] = {} }\n        end\n\n        def valid_name?(candidate)\n          case candidate\n          when String, Symbol, Module then true\n          else false\n          end\n        end\n\n        def warn_if_key_taken(context, key, new_block)\n          existing_module = shared_example_groups[context][key]\n          return unless existing_module\n\n          old_definition_location = formatted_location existing_module.definition\n          new_definition_location = formatted_location new_block\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          if loaded_spec_files.include?(new_definition_location) && old_definition_location == new_definition_location\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Your shared example group, '#{key}', defined at:\n              | #{old_definition_location}\n              |was automatically loaded by RSpec because the file name\n              |matches the configured autoloading pattern (#{RSpec.configuration.pattern}),\n              |and is also being required from somewhere else. To fix this\n              |warning, either rename the file to not match the pattern, or\n              |do not explicitly require the file.\n            WARNING\n          else\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Shared example group '#{key}' has been previously defined at:\n              |  #{old_definition_location}\n              |...and you are now defining it at:\n              |  #{new_definition_location}\n              |The new definition will overwrite the original one.\n            WARNING\n          end\n        end\n\n        if RUBY_VERSION.to_f >= 1.9\n          def formatted_location(block)\n            block.source_location.join(\":\")\n          end\n        else # 1.8.7\n          # :nocov:\n          def formatted_location(block)\n            block.source_location.join(\":\").gsub(/:in.*$/, '')\n          end\n          # :nocov:\n        end\n\n        if Proc.method_defined?(:source_location)\n          def ensure_block_has_source_location(_block); end\n        else # for 1.8.7\n          # :nocov:\n          def ensure_block_has_source_location(block)\n            source_location = yield.split(':')\n            block.extend(Module.new { define_method(:source_location) { source_location } })\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\n\n  instance_exec(&Core::SharedExampleGroup::TopLevelDSL.definitions)\nend\n", "language": "Ruby", "function_component": {"name": "add", "signature": "def add(context, name, *metadata_args, &block)", "start_line": 150, "end_line": 172}, "metadata": {"module": "RSpec", "class_name": "Registry", "class_signature": "class Registry"}, "task_id": 305}
{"function_name": "legacy_add", "file_path": "rspec-core/lib/rspec/core/shared_example_group.rb", "focal_code": "def legacy_add(context, name, *metadata_args, &block)\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          shared_module = SharedExampleGroupModule.new(name, block, {})\n\n          if valid_name?(name)\n            warn_if_key_taken context, name, block\n            shared_example_groups[context][name] = shared_module\n          else\n            metadata_args.unshift name\n          end\n\n          return if metadata_args.empty?\n          RSpec.configuration.include shared_module, *metadata_args\n        end", "file_content": "RSpec::Support.require_rspec_support \"with_keywords_when_needed\"\n\nmodule RSpec\n  module Core\n    # Represents some functionality that is shared with multiple example groups.\n    # The functionality is defined by the provided block, which is lazily\n    # eval'd when the `SharedExampleGroupModule` instance is included in an example\n    # group.\n    class SharedExampleGroupModule < Module\n      # @private\n      attr_reader :definition\n\n      def initialize(description, definition, metadata)\n        @description = description\n        @definition  = definition\n        @metadata    = metadata\n      end\n\n      # Provides a human-readable representation of this module.\n      def inspect\n        \"#<#{self.class.name} #{@description.inspect}>\"\n      end\n      alias to_s inspect\n\n      # Ruby callback for when a module is included in another module is class.\n      # Our definition evaluates the shared group block in the context of the\n      # including example group.\n      def included(klass)\n        inclusion_line = klass.metadata[:location]\n        include_in klass, inclusion_line, [], nil\n      end\n\n      # @private\n      def include_in(klass, inclusion_line, args, customization_block)\n        klass.update_inherited_metadata(@metadata) unless @metadata.empty?\n\n        SharedExampleGroupInclusionStackFrame.with_frame(@description, inclusion_line) do\n          RSpec::Support::WithKeywordsWhenNeeded.class_exec(klass, *args, &@definition)\n          klass.class_exec(&customization_block) if customization_block\n        end\n      end\n    end\n\n    # Shared example groups let you define common context and/or common\n    # examples that you wish to use in multiple example groups.\n    #\n    # When defined, the shared group block is stored for later evaluation.\n    # It can later be included in an example group either explicitly\n    # (using `include_examples`, `include_context` or `it_behaves_like`)\n    # or implicitly (via matching metadata).\n    #\n    # Named shared example groups are scoped based on where they are\n    # defined. Shared groups defined in an example group are available\n    # for inclusion in that example group or any child example groups,\n    # but not in any parent or sibling example groups. Shared example\n    # groups defined at the top level can be included from any example group.\n    module SharedExampleGroup\n      # @overload shared_examples(name, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param block The block to be eval'd\n      # @overload shared_examples(name, metadata, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this\n      #     group; any example group or example with matching metadata will\n      #     automatically include this shared example group.\n      #   @param block The block to be eval'd\n      #\n      # Stores the block for later use. The block will be evaluated\n      # in the context of an example group via `include_examples`,\n      # `include_context`, or `it_behaves_like`.\n      #\n      # @example\n      #   shared_examples \"auditable\" do\n      #     it \"stores an audit record on save!\" do\n      #       expect { auditable.save! }.to change(Audit, :count).by(1)\n      #     end\n      #   end\n      #\n      #   RSpec.describe Account do\n      #     it_behaves_like \"auditable\" do\n      #       let(:auditable) { Account.new }\n      #     end\n      #   end\n      #\n      # @see ExampleGroup.it_behaves_like\n      # @see ExampleGroup.include_examples\n      # @see ExampleGroup.include_context\n      def shared_examples(name, *args, &block)\n        top_level = self == ExampleGroup\n        if top_level && RSpec::Support.thread_local_data[:in_example_group]\n          raise \"Creating isolated shared examples from within a context is \" \\\n                \"not allowed. Remove `RSpec.` prefix or move this to a \" \\\n                \"top-level scope.\"\n        end\n\n        RSpec.world.shared_example_group_registry.add(self, name, *args, &block)\n      end\n      alias shared_context      shared_examples\n      alias shared_examples_for shared_examples\n\n      # @api private\n      #\n      # Shared examples top level DSL.\n      module TopLevelDSL\n        # @private\n        def self.definitions\n          proc do\n            def shared_examples(name, *args, &block)\n              RSpec.world.shared_example_group_registry.add(:main, name, *args, &block)\n            end\n            alias shared_context      shared_examples\n            alias shared_examples_for shared_examples\n          end\n        end\n\n        # @private\n        def self.exposed_globally?\n          @exposed_globally ||= false\n        end\n\n        # @api private\n        #\n        # Adds the top level DSL methods to Module and the top level binding.\n        def self.expose_globally!\n          return if exposed_globally?\n          Core::DSL.change_global_dsl(&definitions)\n          @exposed_globally = true\n        end\n\n        # @api private\n        #\n        # Removes the top level DSL methods to Module and the top level binding.\n        def self.remove_globally!\n          return unless exposed_globally?\n\n          Core::DSL.change_global_dsl do\n            undef shared_examples\n            undef shared_context\n            undef shared_examples_for\n          end\n\n          @exposed_globally = false\n        end\n      end\n\n      # @private\n      class Registry\n        def add(context, name, *metadata_args, &block)\n          unless block\n            RSpec.warning \"Shared example group #{name} was defined without a \"\\\n                          \"block and will have no effect. Please define a \"\\\n                          \"block or remove the definition.\"\n          end\n\n          if RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion\n            return legacy_add(context, name, *metadata_args, &block)\n          end\n\n          unless valid_name?(name)\n            raise ArgumentError, \"Shared example group names can only be a string, \" \\\n                                 \"symbol or module but got: #{name.inspect}\"\n          end\n\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          warn_if_key_taken context, name, block\n\n          metadata = Metadata.build_hash_from(metadata_args)\n          shared_module = SharedExampleGroupModule.new(name, block, metadata)\n          shared_example_groups[context][name] = shared_module\n        end\n\n        def find(lookup_contexts, name)\n          lookup_contexts.each do |context|\n            found = shared_example_groups[context][name]\n            return found if found\n          end\n\n          shared_example_groups[:main][name]\n        end\n\n      private\n\n        # TODO: remove this in RSpec 4. This exists only to support\n        # `config.shared_context_metadata_behavior == :trigger_inclusion`,\n        # the legacy behavior of shared context metadata, which we do\n        # not want to support in RSpec 4.\n        def legacy_add(context, name, *metadata_args, &block)\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          shared_module = SharedExampleGroupModule.new(name, block, {})\n\n          if valid_name?(name)\n            warn_if_key_taken context, name, block\n            shared_example_groups[context][name] = shared_module\n          else\n            metadata_args.unshift name\n          end\n\n          return if metadata_args.empty?\n          RSpec.configuration.include shared_module, *metadata_args\n        end\n\n        def shared_example_groups\n          @shared_example_groups ||= Hash.new { |hash, context| hash[context] = {} }\n        end\n\n        def valid_name?(candidate)\n          case candidate\n          when String, Symbol, Module then true\n          else false\n          end\n        end\n\n        def warn_if_key_taken(context, key, new_block)\n          existing_module = shared_example_groups[context][key]\n          return unless existing_module\n\n          old_definition_location = formatted_location existing_module.definition\n          new_definition_location = formatted_location new_block\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          if loaded_spec_files.include?(new_definition_location) && old_definition_location == new_definition_location\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Your shared example group, '#{key}', defined at:\n              | #{old_definition_location}\n              |was automatically loaded by RSpec because the file name\n              |matches the configured autoloading pattern (#{RSpec.configuration.pattern}),\n              |and is also being required from somewhere else. To fix this\n              |warning, either rename the file to not match the pattern, or\n              |do not explicitly require the file.\n            WARNING\n          else\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Shared example group '#{key}' has been previously defined at:\n              |  #{old_definition_location}\n              |...and you are now defining it at:\n              |  #{new_definition_location}\n              |The new definition will overwrite the original one.\n            WARNING\n          end\n        end\n\n        if RUBY_VERSION.to_f >= 1.9\n          def formatted_location(block)\n            block.source_location.join(\":\")\n          end\n        else # 1.8.7\n          # :nocov:\n          def formatted_location(block)\n            block.source_location.join(\":\").gsub(/:in.*$/, '')\n          end\n          # :nocov:\n        end\n\n        if Proc.method_defined?(:source_location)\n          def ensure_block_has_source_location(_block); end\n        else # for 1.8.7\n          # :nocov:\n          def ensure_block_has_source_location(block)\n            source_location = yield.split(':')\n            block.extend(Module.new { define_method(:source_location) { source_location } })\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\n\n  instance_exec(&Core::SharedExampleGroup::TopLevelDSL.definitions)\nend\n", "language": "Ruby", "function_component": {"name": "legacy_add", "signature": "def legacy_add(context, name, *metadata_args, &block)", "start_line": 189, "end_line": 202}, "metadata": {"module": "RSpec", "class_name": "Registry", "class_signature": "class Registry"}, "task_id": 306}
{"function_name": "warn_if_key_taken", "file_path": "rspec-core/lib/rspec/core/shared_example_group.rb", "focal_code": "def warn_if_key_taken(context, key, new_block)\n          existing_module = shared_example_groups[context][key]\n          return unless existing_module\n\n          old_definition_location = formatted_location existing_module.definition\n          new_definition_location = formatted_location new_block\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          if loaded_spec_files.include?(new_definition_location) && old_definition_location == new_definition_location\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Your shared example group, '#{key}', defined at:\n              | #{old_definition_location}\n              |was automatically loaded by RSpec because the file name\n              |matches the configured autoloading pattern (#{RSpec.configuration.pattern}),\n              |and is also being required from somewhere else. To fix this\n              |warning, either rename the file to not match the pattern, or\n              |do not explicitly require the file.\n            WARNING\n          else\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Shared example group '#{key}' has been previously defined at:\n              |  #{old_definition_location}\n              |...and you are now defining it at:\n              |  #{new_definition_location}\n              |The new definition will overwrite the original one.\n            WARNING\n          end\n        end", "file_content": "RSpec::Support.require_rspec_support \"with_keywords_when_needed\"\n\nmodule RSpec\n  module Core\n    # Represents some functionality that is shared with multiple example groups.\n    # The functionality is defined by the provided block, which is lazily\n    # eval'd when the `SharedExampleGroupModule` instance is included in an example\n    # group.\n    class SharedExampleGroupModule < Module\n      # @private\n      attr_reader :definition\n\n      def initialize(description, definition, metadata)\n        @description = description\n        @definition  = definition\n        @metadata    = metadata\n      end\n\n      # Provides a human-readable representation of this module.\n      def inspect\n        \"#<#{self.class.name} #{@description.inspect}>\"\n      end\n      alias to_s inspect\n\n      # Ruby callback for when a module is included in another module is class.\n      # Our definition evaluates the shared group block in the context of the\n      # including example group.\n      def included(klass)\n        inclusion_line = klass.metadata[:location]\n        include_in klass, inclusion_line, [], nil\n      end\n\n      # @private\n      def include_in(klass, inclusion_line, args, customization_block)\n        klass.update_inherited_metadata(@metadata) unless @metadata.empty?\n\n        SharedExampleGroupInclusionStackFrame.with_frame(@description, inclusion_line) do\n          RSpec::Support::WithKeywordsWhenNeeded.class_exec(klass, *args, &@definition)\n          klass.class_exec(&customization_block) if customization_block\n        end\n      end\n    end\n\n    # Shared example groups let you define common context and/or common\n    # examples that you wish to use in multiple example groups.\n    #\n    # When defined, the shared group block is stored for later evaluation.\n    # It can later be included in an example group either explicitly\n    # (using `include_examples`, `include_context` or `it_behaves_like`)\n    # or implicitly (via matching metadata).\n    #\n    # Named shared example groups are scoped based on where they are\n    # defined. Shared groups defined in an example group are available\n    # for inclusion in that example group or any child example groups,\n    # but not in any parent or sibling example groups. Shared example\n    # groups defined at the top level can be included from any example group.\n    module SharedExampleGroup\n      # @overload shared_examples(name, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param block The block to be eval'd\n      # @overload shared_examples(name, metadata, &block)\n      #   @param name [String, Symbol, Module] identifer to use when looking up\n      #     this shared group\n      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this\n      #     group; any example group or example with matching metadata will\n      #     automatically include this shared example group.\n      #   @param block The block to be eval'd\n      #\n      # Stores the block for later use. The block will be evaluated\n      # in the context of an example group via `include_examples`,\n      # `include_context`, or `it_behaves_like`.\n      #\n      # @example\n      #   shared_examples \"auditable\" do\n      #     it \"stores an audit record on save!\" do\n      #       expect { auditable.save! }.to change(Audit, :count).by(1)\n      #     end\n      #   end\n      #\n      #   RSpec.describe Account do\n      #     it_behaves_like \"auditable\" do\n      #       let(:auditable) { Account.new }\n      #     end\n      #   end\n      #\n      # @see ExampleGroup.it_behaves_like\n      # @see ExampleGroup.include_examples\n      # @see ExampleGroup.include_context\n      def shared_examples(name, *args, &block)\n        top_level = self == ExampleGroup\n        if top_level && RSpec::Support.thread_local_data[:in_example_group]\n          raise \"Creating isolated shared examples from within a context is \" \\\n                \"not allowed. Remove `RSpec.` prefix or move this to a \" \\\n                \"top-level scope.\"\n        end\n\n        RSpec.world.shared_example_group_registry.add(self, name, *args, &block)\n      end\n      alias shared_context      shared_examples\n      alias shared_examples_for shared_examples\n\n      # @api private\n      #\n      # Shared examples top level DSL.\n      module TopLevelDSL\n        # @private\n        def self.definitions\n          proc do\n            def shared_examples(name, *args, &block)\n              RSpec.world.shared_example_group_registry.add(:main, name, *args, &block)\n            end\n            alias shared_context      shared_examples\n            alias shared_examples_for shared_examples\n          end\n        end\n\n        # @private\n        def self.exposed_globally?\n          @exposed_globally ||= false\n        end\n\n        # @api private\n        #\n        # Adds the top level DSL methods to Module and the top level binding.\n        def self.expose_globally!\n          return if exposed_globally?\n          Core::DSL.change_global_dsl(&definitions)\n          @exposed_globally = true\n        end\n\n        # @api private\n        #\n        # Removes the top level DSL methods to Module and the top level binding.\n        def self.remove_globally!\n          return unless exposed_globally?\n\n          Core::DSL.change_global_dsl do\n            undef shared_examples\n            undef shared_context\n            undef shared_examples_for\n          end\n\n          @exposed_globally = false\n        end\n      end\n\n      # @private\n      class Registry\n        def add(context, name, *metadata_args, &block)\n          unless block\n            RSpec.warning \"Shared example group #{name} was defined without a \"\\\n                          \"block and will have no effect. Please define a \"\\\n                          \"block or remove the definition.\"\n          end\n\n          if RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion\n            return legacy_add(context, name, *metadata_args, &block)\n          end\n\n          unless valid_name?(name)\n            raise ArgumentError, \"Shared example group names can only be a string, \" \\\n                                 \"symbol or module but got: #{name.inspect}\"\n          end\n\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          warn_if_key_taken context, name, block\n\n          metadata = Metadata.build_hash_from(metadata_args)\n          shared_module = SharedExampleGroupModule.new(name, block, metadata)\n          shared_example_groups[context][name] = shared_module\n        end\n\n        def find(lookup_contexts, name)\n          lookup_contexts.each do |context|\n            found = shared_example_groups[context][name]\n            return found if found\n          end\n\n          shared_example_groups[:main][name]\n        end\n\n      private\n\n        # TODO: remove this in RSpec 4. This exists only to support\n        # `config.shared_context_metadata_behavior == :trigger_inclusion`,\n        # the legacy behavior of shared context metadata, which we do\n        # not want to support in RSpec 4.\n        def legacy_add(context, name, *metadata_args, &block)\n          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }\n          shared_module = SharedExampleGroupModule.new(name, block, {})\n\n          if valid_name?(name)\n            warn_if_key_taken context, name, block\n            shared_example_groups[context][name] = shared_module\n          else\n            metadata_args.unshift name\n          end\n\n          return if metadata_args.empty?\n          RSpec.configuration.include shared_module, *metadata_args\n        end\n\n        def shared_example_groups\n          @shared_example_groups ||= Hash.new { |hash, context| hash[context] = {} }\n        end\n\n        def valid_name?(candidate)\n          case candidate\n          when String, Symbol, Module then true\n          else false\n          end\n        end\n\n        def warn_if_key_taken(context, key, new_block)\n          existing_module = shared_example_groups[context][key]\n          return unless existing_module\n\n          old_definition_location = formatted_location existing_module.definition\n          new_definition_location = formatted_location new_block\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          if loaded_spec_files.include?(new_definition_location) && old_definition_location == new_definition_location\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Your shared example group, '#{key}', defined at:\n              | #{old_definition_location}\n              |was automatically loaded by RSpec because the file name\n              |matches the configured autoloading pattern (#{RSpec.configuration.pattern}),\n              |and is also being required from somewhere else. To fix this\n              |warning, either rename the file to not match the pattern, or\n              |do not explicitly require the file.\n            WARNING\n          else\n            RSpec.warn_with <<-WARNING.gsub(/^ +\\|/, ''), :call_site => nil\n              |WARNING: Shared example group '#{key}' has been previously defined at:\n              |  #{old_definition_location}\n              |...and you are now defining it at:\n              |  #{new_definition_location}\n              |The new definition will overwrite the original one.\n            WARNING\n          end\n        end\n\n        if RUBY_VERSION.to_f >= 1.9\n          def formatted_location(block)\n            block.source_location.join(\":\")\n          end\n        else # 1.8.7\n          # :nocov:\n          def formatted_location(block)\n            block.source_location.join(\":\").gsub(/:in.*$/, '')\n          end\n          # :nocov:\n        end\n\n        if Proc.method_defined?(:source_location)\n          def ensure_block_has_source_location(_block); end\n        else # for 1.8.7\n          # :nocov:\n          def ensure_block_has_source_location(block)\n            source_location = yield.split(':')\n            block.extend(Module.new { define_method(:source_location) { source_location } })\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\n\n  instance_exec(&Core::SharedExampleGroup::TopLevelDSL.definitions)\nend\n", "language": "Ruby", "function_component": {"name": "warn_if_key_taken", "signature": "def warn_if_key_taken(context, key, new_block)", "start_line": 215, "end_line": 242}, "metadata": {"module": "RSpec", "class_name": "Registry", "class_signature": "class Registry"}, "task_id": 307}
{"function_name": "announce_filters", "file_path": "rspec-core/lib/rspec/core/world.rb", "focal_code": "def announce_filters\n        fail_if_config_and_cli_options_invalid\n        filter_announcements = []\n\n        announce_inclusion_filter filter_announcements\n        announce_exclusion_filter filter_announcements\n\n        unless filter_manager.empty?\n          if filter_announcements.length == 1\n            report_filter_message(\"Run options: #{filter_announcements[0]}\")\n          else\n            report_filter_message(\"Run options:\\n  #{filter_announcements.join(\"\\n  \")}\")\n          end\n        end\n\n        if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?\n          report_filter_message(\"#{everything_filtered_message}; ignoring #{inclusion_filter.description}\")\n          filtered_examples.clear\n          inclusion_filter.clear\n        end\n\n        return unless example_count.zero?\n\n        example_groups.clear\n        unless rspec_is_quitting\n          if filter_manager.empty?\n            report_filter_message(\"No examples found.\")\n          elsif exclusion_filter.empty? || inclusion_filter.empty?\n            report_filter_message(everything_filtered_message)\n          end\n        end\n      end", "file_content": "module RSpec\n  module Core\n    # @api private\n    #\n    # Internal container for global non-configuration data.\n    class World\n      # @private\n      attr_reader :example_groups, :filtered_examples, :example_group_counts_by_spec_file\n\n      # Used internally to determine what to do when a SIGINT is received.\n      attr_accessor :wants_to_quit\n\n      # Used internally to signify that a SystemExit occurred in\n      # `Configuration#load_file_handling_errors`, and thus examples cannot\n      # be counted accurately. Specifically, we cannot accurately report\n      # \"No examples found\".\n      # @private\n      attr_accessor :rspec_is_quitting\n\n      # Used internally to signal that a failure outside of an example\n      # has occurred, and that therefore the exit status should indicate\n      # the run failed.\n      # @private\n      attr_accessor :non_example_failure\n\n      def initialize(configuration=RSpec.configuration)\n        @wants_to_quit = false\n        @rspec_is_quitting = false\n        @configuration = configuration\n        configuration.world = self\n        @example_groups = []\n        @example_group_counts_by_spec_file = Hash.new(0)\n        prepare_example_filtering\n      end\n\n      # @api public\n      #\n      # Prepares filters so that they apply to example groups when they run.\n      #\n      # This is a separate method so that filters can be modified/replaced and\n      # examples refiltered during a process's lifetime, which can be useful for\n      # a custom runner.\n      def prepare_example_filtering\n        @filtered_examples = Hash.new do |hash, group|\n          hash[group] = filter_manager.prune(group.examples)\n        end\n      end\n\n      # @api private\n      #\n      # Apply ordering strategy from configuration to example groups.\n      def ordered_example_groups\n        ordering_strategy = @configuration.ordering_registry.fetch(:global)\n        ordering_strategy.order(@example_groups)\n      end\n\n      # @api private\n      #\n      # Reset world to 'scratch' before running suite.\n      def reset\n        RSpec::ExampleGroups.remove_all_constants\n        example_groups.clear\n        @sources_by_path.clear if defined?(@sources_by_path)\n        @syntax_highlighter = nil\n        @example_group_counts_by_spec_file = Hash.new(0)\n      end\n\n      # @private\n      def filter_manager\n        @configuration.filter_manager\n      end\n\n      # @private\n      def registered_example_group_files\n        @example_group_counts_by_spec_file.keys\n      end\n\n      # @api private\n      #\n      # Records an example group.\n      def record(example_group)\n        @configuration.on_example_group_definition_callbacks.each { |block| block.call(example_group) }\n        @example_group_counts_by_spec_file[example_group.metadata[:absolute_file_path]] += 1\n      end\n\n      # @private\n      def num_example_groups_defined_in(file)\n        @example_group_counts_by_spec_file[file]\n      end\n\n      # @private\n      def shared_example_group_registry\n        @shared_example_group_registry ||= SharedExampleGroup::Registry.new\n      end\n\n      # @private\n      def inclusion_filter\n        @configuration.inclusion_filter\n      end\n\n      # @private\n      def exclusion_filter\n        @configuration.exclusion_filter\n      end\n\n      # @api private\n      #\n      # Get count of examples to be run.\n      def example_count(groups=example_groups)\n        FlatMap.flat_map(groups) { |g| g.descendants }.\n          inject(0) { |a, e| a + e.filtered_examples.size }\n      end\n\n      # @private\n      def all_example_groups\n        FlatMap.flat_map(example_groups) { |g| g.descendants }\n      end\n\n      # @private\n      def all_examples\n        FlatMap.flat_map(all_example_groups) { |g| g.examples }\n      end\n\n      # @private\n      # Traverses the tree of each top level group.\n      # For each it yields the group, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def traverse_example_group_trees_until(&block)\n        example_groups.each do |group|\n          group.traverse_tree_until(&block)\n        end\n      end\n\n      # @api private\n      #\n      # Find line number of previous declaration.\n      def preceding_declaration_line(absolute_file_name, filter_line)\n        line_numbers = descending_declaration_line_numbers_by_file.fetch(absolute_file_name) do\n          return nil\n        end\n\n        line_numbers.find { |num| num <= filter_line }\n      end\n\n      # @private\n      def reporter\n        @configuration.reporter\n      end\n\n      # @private\n      def source_from_file(path)\n        unless defined?(@sources_by_path)\n          RSpec::Support.require_rspec_support 'source'\n          @sources_by_path = {}\n        end\n\n        @sources_by_path[path] ||= Support::Source.from_file(path)\n      end\n\n      # @private\n      def syntax_highlighter\n        @syntax_highlighter ||= Formatters::SyntaxHighlighter.new(@configuration)\n      end\n\n      # @api private\n      #\n      # Notify reporter of filters.\n      def announce_filters\n        fail_if_config_and_cli_options_invalid\n        filter_announcements = []\n\n        announce_inclusion_filter filter_announcements\n        announce_exclusion_filter filter_announcements\n\n        unless filter_manager.empty?\n          if filter_announcements.length == 1\n            report_filter_message(\"Run options: #{filter_announcements[0]}\")\n          else\n            report_filter_message(\"Run options:\\n  #{filter_announcements.join(\"\\n  \")}\")\n          end\n        end\n\n        if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?\n          report_filter_message(\"#{everything_filtered_message}; ignoring #{inclusion_filter.description}\")\n          filtered_examples.clear\n          inclusion_filter.clear\n        end\n\n        return unless example_count.zero?\n\n        example_groups.clear\n        unless rspec_is_quitting\n          if filter_manager.empty?\n            report_filter_message(\"No examples found.\")\n          elsif exclusion_filter.empty? || inclusion_filter.empty?\n            report_filter_message(everything_filtered_message)\n          end\n        end\n      end\n\n      # @private\n      def report_filter_message(message)\n        reporter.message(message) unless @configuration.silence_filter_announcements?\n      end\n\n      # @private\n      def everything_filtered_message\n        \"\\nAll examples were filtered out\"\n      end\n\n      # @api private\n      #\n      # Add inclusion filters to announcement message.\n      def announce_inclusion_filter(announcements)\n        return if inclusion_filter.empty?\n\n        announcements << \"include #{inclusion_filter.description}\"\n      end\n\n      # @api private\n      #\n      # Add exclusion filters to announcement message.\n      def announce_exclusion_filter(announcements)\n        return if exclusion_filter.empty?\n\n        announcements << \"exclude #{exclusion_filter.description}\"\n      end\n\n    private\n\n      def descending_declaration_line_numbers_by_file\n        @descending_declaration_line_numbers_by_file ||= begin\n          declaration_locations = FlatMap.flat_map(example_groups, &:declaration_locations)\n          hash_of_arrays = Hash.new { |h, k| h[k] = [] }\n\n          # TODO: change `inject` to `each_with_object` when we drop 1.8.7 support.\n          line_nums_by_file = declaration_locations.inject(hash_of_arrays) do |hash, (file_name, line_number)|\n            hash[file_name] << line_number\n            hash\n          end\n\n          line_nums_by_file.each_value do |list|\n            list.sort!\n            list.reverse!\n          end\n        end\n      end\n\n      def fail_if_config_and_cli_options_invalid\n        return unless @configuration.only_failures_but_not_configured?\n\n        reporter.abort_with(\n          \"\\nTo use `--only-failures`, you must first set \" \\\n          \"`config.example_status_persistence_file_path`.\",\n          1 # exit code\n        )\n      end\n\n      # @private\n      # Provides a null implementation for initial use by configuration.\n      module Null\n        def self.non_example_failure; end\n        def self.non_example_failure=(_); end\n\n        def self.registered_example_group_files\n          []\n        end\n\n        def self.traverse_example_group_trees_until\n        end\n\n        # :nocov:\n        def self.example_groups\n          []\n        end\n\n        def self.all_example_groups\n          []\n        end\n        # :nocov:\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "announce_filters", "signature": "def announce_filters fail_if_config_and_cli_options_invalid", "start_line": 171, "end_line": 202}, "metadata": {"module": "RSpec", "class_name": "World", "class_signature": "class World"}, "task_id": 308}
{"function_name": "descending_declaration_line_numbers_by_file", "file_path": "rspec-core/lib/rspec/core/world.rb", "focal_code": "def descending_declaration_line_numbers_by_file\n        @descending_declaration_line_numbers_by_file ||= begin\n          declaration_locations = FlatMap.flat_map(example_groups, &:declaration_locations)\n          hash_of_arrays = Hash.new { |h, k| h[k] = [] }\n\n          # TODO: change `inject` to `each_with_object` when we drop 1.8.7 support.\n          line_nums_by_file = declaration_locations.inject(hash_of_arrays) do |hash, (file_name, line_number)|\n            hash[file_name] << line_number\n            hash\n          end\n\n          line_nums_by_file.each_value do |list|\n            list.sort!\n            list.reverse!\n          end\n        end\n      end", "file_content": "module RSpec\n  module Core\n    # @api private\n    #\n    # Internal container for global non-configuration data.\n    class World\n      # @private\n      attr_reader :example_groups, :filtered_examples, :example_group_counts_by_spec_file\n\n      # Used internally to determine what to do when a SIGINT is received.\n      attr_accessor :wants_to_quit\n\n      # Used internally to signify that a SystemExit occurred in\n      # `Configuration#load_file_handling_errors`, and thus examples cannot\n      # be counted accurately. Specifically, we cannot accurately report\n      # \"No examples found\".\n      # @private\n      attr_accessor :rspec_is_quitting\n\n      # Used internally to signal that a failure outside of an example\n      # has occurred, and that therefore the exit status should indicate\n      # the run failed.\n      # @private\n      attr_accessor :non_example_failure\n\n      def initialize(configuration=RSpec.configuration)\n        @wants_to_quit = false\n        @rspec_is_quitting = false\n        @configuration = configuration\n        configuration.world = self\n        @example_groups = []\n        @example_group_counts_by_spec_file = Hash.new(0)\n        prepare_example_filtering\n      end\n\n      # @api public\n      #\n      # Prepares filters so that they apply to example groups when they run.\n      #\n      # This is a separate method so that filters can be modified/replaced and\n      # examples refiltered during a process's lifetime, which can be useful for\n      # a custom runner.\n      def prepare_example_filtering\n        @filtered_examples = Hash.new do |hash, group|\n          hash[group] = filter_manager.prune(group.examples)\n        end\n      end\n\n      # @api private\n      #\n      # Apply ordering strategy from configuration to example groups.\n      def ordered_example_groups\n        ordering_strategy = @configuration.ordering_registry.fetch(:global)\n        ordering_strategy.order(@example_groups)\n      end\n\n      # @api private\n      #\n      # Reset world to 'scratch' before running suite.\n      def reset\n        RSpec::ExampleGroups.remove_all_constants\n        example_groups.clear\n        @sources_by_path.clear if defined?(@sources_by_path)\n        @syntax_highlighter = nil\n        @example_group_counts_by_spec_file = Hash.new(0)\n      end\n\n      # @private\n      def filter_manager\n        @configuration.filter_manager\n      end\n\n      # @private\n      def registered_example_group_files\n        @example_group_counts_by_spec_file.keys\n      end\n\n      # @api private\n      #\n      # Records an example group.\n      def record(example_group)\n        @configuration.on_example_group_definition_callbacks.each { |block| block.call(example_group) }\n        @example_group_counts_by_spec_file[example_group.metadata[:absolute_file_path]] += 1\n      end\n\n      # @private\n      def num_example_groups_defined_in(file)\n        @example_group_counts_by_spec_file[file]\n      end\n\n      # @private\n      def shared_example_group_registry\n        @shared_example_group_registry ||= SharedExampleGroup::Registry.new\n      end\n\n      # @private\n      def inclusion_filter\n        @configuration.inclusion_filter\n      end\n\n      # @private\n      def exclusion_filter\n        @configuration.exclusion_filter\n      end\n\n      # @api private\n      #\n      # Get count of examples to be run.\n      def example_count(groups=example_groups)\n        FlatMap.flat_map(groups) { |g| g.descendants }.\n          inject(0) { |a, e| a + e.filtered_examples.size }\n      end\n\n      # @private\n      def all_example_groups\n        FlatMap.flat_map(example_groups) { |g| g.descendants }\n      end\n\n      # @private\n      def all_examples\n        FlatMap.flat_map(all_example_groups) { |g| g.examples }\n      end\n\n      # @private\n      # Traverses the tree of each top level group.\n      # For each it yields the group, then the children, recursively.\n      # Halts the traversal of a branch of the tree as soon as the passed block returns true.\n      # Note that siblings groups and their sub-trees will continue to be explored.\n      # This is intended to make it easy to find the top-most group that satisfies some\n      # condition.\n      def traverse_example_group_trees_until(&block)\n        example_groups.each do |group|\n          group.traverse_tree_until(&block)\n        end\n      end\n\n      # @api private\n      #\n      # Find line number of previous declaration.\n      def preceding_declaration_line(absolute_file_name, filter_line)\n        line_numbers = descending_declaration_line_numbers_by_file.fetch(absolute_file_name) do\n          return nil\n        end\n\n        line_numbers.find { |num| num <= filter_line }\n      end\n\n      # @private\n      def reporter\n        @configuration.reporter\n      end\n\n      # @private\n      def source_from_file(path)\n        unless defined?(@sources_by_path)\n          RSpec::Support.require_rspec_support 'source'\n          @sources_by_path = {}\n        end\n\n        @sources_by_path[path] ||= Support::Source.from_file(path)\n      end\n\n      # @private\n      def syntax_highlighter\n        @syntax_highlighter ||= Formatters::SyntaxHighlighter.new(@configuration)\n      end\n\n      # @api private\n      #\n      # Notify reporter of filters.\n      def announce_filters\n        fail_if_config_and_cli_options_invalid\n        filter_announcements = []\n\n        announce_inclusion_filter filter_announcements\n        announce_exclusion_filter filter_announcements\n\n        unless filter_manager.empty?\n          if filter_announcements.length == 1\n            report_filter_message(\"Run options: #{filter_announcements[0]}\")\n          else\n            report_filter_message(\"Run options:\\n  #{filter_announcements.join(\"\\n  \")}\")\n          end\n        end\n\n        if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?\n          report_filter_message(\"#{everything_filtered_message}; ignoring #{inclusion_filter.description}\")\n          filtered_examples.clear\n          inclusion_filter.clear\n        end\n\n        return unless example_count.zero?\n\n        example_groups.clear\n        unless rspec_is_quitting\n          if filter_manager.empty?\n            report_filter_message(\"No examples found.\")\n          elsif exclusion_filter.empty? || inclusion_filter.empty?\n            report_filter_message(everything_filtered_message)\n          end\n        end\n      end\n\n      # @private\n      def report_filter_message(message)\n        reporter.message(message) unless @configuration.silence_filter_announcements?\n      end\n\n      # @private\n      def everything_filtered_message\n        \"\\nAll examples were filtered out\"\n      end\n\n      # @api private\n      #\n      # Add inclusion filters to announcement message.\n      def announce_inclusion_filter(announcements)\n        return if inclusion_filter.empty?\n\n        announcements << \"include #{inclusion_filter.description}\"\n      end\n\n      # @api private\n      #\n      # Add exclusion filters to announcement message.\n      def announce_exclusion_filter(announcements)\n        return if exclusion_filter.empty?\n\n        announcements << \"exclude #{exclusion_filter.description}\"\n      end\n\n    private\n\n      def descending_declaration_line_numbers_by_file\n        @descending_declaration_line_numbers_by_file ||= begin\n          declaration_locations = FlatMap.flat_map(example_groups, &:declaration_locations)\n          hash_of_arrays = Hash.new { |h, k| h[k] = [] }\n\n          # TODO: change `inject` to `each_with_object` when we drop 1.8.7 support.\n          line_nums_by_file = declaration_locations.inject(hash_of_arrays) do |hash, (file_name, line_number)|\n            hash[file_name] << line_number\n            hash\n          end\n\n          line_nums_by_file.each_value do |list|\n            list.sort!\n            list.reverse!\n          end\n        end\n      end\n\n      def fail_if_config_and_cli_options_invalid\n        return unless @configuration.only_failures_but_not_configured?\n\n        reporter.abort_with(\n          \"\\nTo use `--only-failures`, you must first set \" \\\n          \"`config.example_status_persistence_file_path`.\",\n          1 # exit code\n        )\n      end\n\n      # @private\n      # Provides a null implementation for initial use by configuration.\n      module Null\n        def self.non_example_failure; end\n        def self.non_example_failure=(_); end\n\n        def self.registered_example_group_files\n          []\n        end\n\n        def self.traverse_example_group_trees_until\n        end\n\n        # :nocov:\n        def self.example_groups\n          []\n        end\n\n        def self.all_example_groups\n          []\n        end\n        # :nocov:\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "descending_declaration_line_numbers_by_file", "signature": "def descending_declaration_line_numbers_by_file @descending_declaration_line_numbers_by_file ||= begin", "start_line": 234, "end_line": 250}, "metadata": {"module": "RSpec", "class_name": "World", "class_signature": "class World"}, "task_id": 309}
{"function_name": "bisect", "file_path": "rspec-core/lib/rspec/core/bisect/coordinator.rb", "focal_code": "def bisect\n          repro = start_bisect_runner do |runner|\n            minimizer = ExampleMinimizer.new(@shell_command, runner, @notifier)\n\n            gracefully_abort_on_sigint(minimizer)\n            minimizer.find_minimal_repro\n            minimizer.repro_command_for_currently_needed_ids\n          end\n\n          @notifier.publish(:bisect_repro_command, :repro => repro)\n\n          true\n        rescue BisectFailedError => e\n          @notifier.publish(:bisect_failed, :failure_explanation => e.message)\n          false\n        ensure\n          @notifier.publish(:close)\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/shell_command\"\nRSpec::Support.require_rspec_core \"bisect/example_minimizer\"\nRSpec::Support.require_rspec_core \"bisect/utilities\"\nRSpec::Support.require_rspec_core \"formatters/bisect_progress_formatter\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # The main entry point into the bisect logic. Coordinates among:\n      #   - Bisect::ShellCommand: Generates shell commands to run spec subsets\n      #   - Bisect::ExampleMinimizer: Contains the core bisect logic.\n      #   - A bisect runner: runs a set of examples and returns the results.\n      #   - A bisect formatter: provides progress updates to the user.\n      # @private\n      class Coordinator\n        def self.bisect_with(spec_runner, original_cli_args, formatter)\n          new(spec_runner, original_cli_args, formatter).bisect\n        end\n\n        def initialize(spec_runner, original_cli_args, formatter)\n          @spec_runner   = spec_runner\n          @shell_command = ShellCommand.new(original_cli_args)\n          @notifier      = Bisect::Notifier.new(formatter)\n        end\n\n        def bisect\n          repro = start_bisect_runner do |runner|\n            minimizer = ExampleMinimizer.new(@shell_command, runner, @notifier)\n\n            gracefully_abort_on_sigint(minimizer)\n            minimizer.find_minimal_repro\n            minimizer.repro_command_for_currently_needed_ids\n          end\n\n          @notifier.publish(:bisect_repro_command, :repro => repro)\n\n          true\n        rescue BisectFailedError => e\n          @notifier.publish(:bisect_failed, :failure_explanation => e.message)\n          false\n        ensure\n          @notifier.publish(:close)\n        end\n\n      private\n\n        def start_bisect_runner(&block)\n          klass = @spec_runner.configuration.bisect_runner_class\n          klass.start(@shell_command, @spec_runner, &block)\n        end\n\n        def gracefully_abort_on_sigint(minimizer)\n          trap('INT') do\n            repro = minimizer.repro_command_for_currently_needed_ids\n            @notifier.publish(:bisect_aborted, :repro => repro)\n            exit(1)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect", "signature": "def bisect repro = start_bisect_runner do |runner|", "start_line": 26, "end_line": 43}, "metadata": {"module": "RSpec", "class_name": "Coordinator", "class_signature": "class Coordinator"}, "task_id": 310}
{"function_name": "find_minimal_repro", "file_path": "rspec-core/lib/rspec/core/bisect/example_minimizer.rb", "focal_code": "def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # @private\n      # Contains the core bisect logic. Searches for examples we can ignore by\n      # repeatedly running different subsets of the suite.\n      class ExampleMinimizer\n        attr_reader :shell_command, :runner, :all_example_ids, :failed_example_ids\n        attr_accessor :remaining_ids\n\n        def initialize(shell_command, runner, notifier)\n          @shell_command = shell_command\n          @runner        = runner\n          @notifier      = notifier\n        end\n\n        def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end\n\n        def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end\n\n        def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end\n\n        def currently_needed_ids\n          remaining_ids + failed_example_ids\n        end\n\n        def repro_command_for_currently_needed_ids\n          return shell_command.repro_command_from(currently_needed_ids) if remaining_ids\n          \"(Not yet enough information to provide any repro command)\"\n        end\n\n        # @private\n        # Convenience class for describing a subset of the candidate examples\n        ExampleRange = Struct.new(:start, :finish) do\n          def description\n            if start == finish\n              \"example #{start}\"\n            else\n              \"examples #{start}-#{finish}\"\n            end\n          end\n        end\n\n      private\n\n        def example_range(ids)\n          ExampleRange.new(\n            non_failing_example_ids.find_index(ids.first) + 1,\n            non_failing_example_ids.find_index(ids.last) + 1\n          )\n        end\n\n        def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end\n\n        def non_failing_example_ids\n          @non_failing_example_ids ||= all_example_ids - failed_example_ids\n        end\n\n        def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end\n\n        def track_duration\n          start = ::RSpec::Core::Time.now\n          [yield, ::RSpec::Core::Time.now - start]\n        end\n\n        def abort_if_ordering_inconsistent(results)\n          expected_order = all_example_ids & results.all_example_ids\n          return if expected_order == results.all_example_ids\n\n          raise BisectFailedError, \"\\n\\nThe example ordering is inconsistent. \" \\\n                \"`--bisect` relies upon consistent ordering (e.g. by passing \" \\\n                \"`--seed` if you're using random ordering) to work properly.\"\n        end\n\n        def notify(*args)\n          @notifier.publish(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_minimal_repro", "signature": "def find_minimal_repro prep", "start_line": 19, "end_line": 31}, "metadata": {"module": "RSpec", "class_name": "ExampleMinimizer", "class_signature": "class ExampleMinimizer"}, "task_id": 311}
{"function_name": "bisect", "file_path": "rspec-core/lib/rspec/core/bisect/example_minimizer.rb", "focal_code": "def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # @private\n      # Contains the core bisect logic. Searches for examples we can ignore by\n      # repeatedly running different subsets of the suite.\n      class ExampleMinimizer\n        attr_reader :shell_command, :runner, :all_example_ids, :failed_example_ids\n        attr_accessor :remaining_ids\n\n        def initialize(shell_command, runner, notifier)\n          @shell_command = shell_command\n          @runner        = runner\n          @notifier      = notifier\n        end\n\n        def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end\n\n        def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end\n\n        def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end\n\n        def currently_needed_ids\n          remaining_ids + failed_example_ids\n        end\n\n        def repro_command_for_currently_needed_ids\n          return shell_command.repro_command_from(currently_needed_ids) if remaining_ids\n          \"(Not yet enough information to provide any repro command)\"\n        end\n\n        # @private\n        # Convenience class for describing a subset of the candidate examples\n        ExampleRange = Struct.new(:start, :finish) do\n          def description\n            if start == finish\n              \"example #{start}\"\n            else\n              \"examples #{start}-#{finish}\"\n            end\n          end\n        end\n\n      private\n\n        def example_range(ids)\n          ExampleRange.new(\n            non_failing_example_ids.find_index(ids.first) + 1,\n            non_failing_example_ids.find_index(ids.last) + 1\n          )\n        end\n\n        def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end\n\n        def non_failing_example_ids\n          @non_failing_example_ids ||= all_example_ids - failed_example_ids\n        end\n\n        def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end\n\n        def track_duration\n          start = ::RSpec::Core::Time.now\n          [yield, ::RSpec::Core::Time.now - start]\n        end\n\n        def abort_if_ordering_inconsistent(results)\n          expected_order = all_example_ids & results.all_example_ids\n          return if expected_order == results.all_example_ids\n\n          raise BisectFailedError, \"\\n\\nThe example ordering is inconsistent. \" \\\n                \"`--bisect` relies upon consistent ordering (e.g. by passing \" \\\n                \"`--seed` if you're using random ordering) to work properly.\"\n        end\n\n        def notify(*args)\n          @notifier.publish(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect", "signature": "def bisect(candidate_ids)", "start_line": 33, "end_line": 43}, "metadata": {"module": "RSpec", "class_name": "ExampleMinimizer", "class_signature": "class ExampleMinimizer"}, "task_id": 312}
{"function_name": "bisect_over", "file_path": "rspec-core/lib/rspec/core/bisect/example_minimizer.rb", "focal_code": "def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # @private\n      # Contains the core bisect logic. Searches for examples we can ignore by\n      # repeatedly running different subsets of the suite.\n      class ExampleMinimizer\n        attr_reader :shell_command, :runner, :all_example_ids, :failed_example_ids\n        attr_accessor :remaining_ids\n\n        def initialize(shell_command, runner, notifier)\n          @shell_command = shell_command\n          @runner        = runner\n          @notifier      = notifier\n        end\n\n        def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end\n\n        def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end\n\n        def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end\n\n        def currently_needed_ids\n          remaining_ids + failed_example_ids\n        end\n\n        def repro_command_for_currently_needed_ids\n          return shell_command.repro_command_from(currently_needed_ids) if remaining_ids\n          \"(Not yet enough information to provide any repro command)\"\n        end\n\n        # @private\n        # Convenience class for describing a subset of the candidate examples\n        ExampleRange = Struct.new(:start, :finish) do\n          def description\n            if start == finish\n              \"example #{start}\"\n            else\n              \"examples #{start}-#{finish}\"\n            end\n          end\n        end\n\n      private\n\n        def example_range(ids)\n          ExampleRange.new(\n            non_failing_example_ids.find_index(ids.first) + 1,\n            non_failing_example_ids.find_index(ids.last) + 1\n          )\n        end\n\n        def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end\n\n        def non_failing_example_ids\n          @non_failing_example_ids ||= all_example_ids - failed_example_ids\n        end\n\n        def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end\n\n        def track_duration\n          start = ::RSpec::Core::Time.now\n          [yield, ::RSpec::Core::Time.now - start]\n        end\n\n        def abort_if_ordering_inconsistent(results)\n          expected_order = all_example_ids & results.all_example_ids\n          return if expected_order == results.all_example_ids\n\n          raise BisectFailedError, \"\\n\\nThe example ordering is inconsistent. \" \\\n                \"`--bisect` relies upon consistent ordering (e.g. by passing \" \\\n                \"`--seed` if you're using random ordering) to work properly.\"\n        end\n\n        def notify(*args)\n          @notifier.publish(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect_over", "signature": "def bisect_over(candidate_ids)", "start_line": 45, "end_line": 81}, "metadata": {"module": "RSpec", "class_name": "ExampleMinimizer", "class_signature": "class ExampleMinimizer"}, "task_id": 313}
{"function_name": "prep", "file_path": "rspec-core/lib/rspec/core/bisect/example_minimizer.rb", "focal_code": "def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # @private\n      # Contains the core bisect logic. Searches for examples we can ignore by\n      # repeatedly running different subsets of the suite.\n      class ExampleMinimizer\n        attr_reader :shell_command, :runner, :all_example_ids, :failed_example_ids\n        attr_accessor :remaining_ids\n\n        def initialize(shell_command, runner, notifier)\n          @shell_command = shell_command\n          @runner        = runner\n          @notifier      = notifier\n        end\n\n        def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end\n\n        def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end\n\n        def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end\n\n        def currently_needed_ids\n          remaining_ids + failed_example_ids\n        end\n\n        def repro_command_for_currently_needed_ids\n          return shell_command.repro_command_from(currently_needed_ids) if remaining_ids\n          \"(Not yet enough information to provide any repro command)\"\n        end\n\n        # @private\n        # Convenience class for describing a subset of the candidate examples\n        ExampleRange = Struct.new(:start, :finish) do\n          def description\n            if start == finish\n              \"example #{start}\"\n            else\n              \"examples #{start}-#{finish}\"\n            end\n          end\n        end\n\n      private\n\n        def example_range(ids)\n          ExampleRange.new(\n            non_failing_example_ids.find_index(ids.first) + 1,\n            non_failing_example_ids.find_index(ids.last) + 1\n          )\n        end\n\n        def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end\n\n        def non_failing_example_ids\n          @non_failing_example_ids ||= all_example_ids - failed_example_ids\n        end\n\n        def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end\n\n        def track_duration\n          start = ::RSpec::Core::Time.now\n          [yield, ::RSpec::Core::Time.now - start]\n        end\n\n        def abort_if_ordering_inconsistent(results)\n          expected_order = all_example_ids & results.all_example_ids\n          return if expected_order == results.all_example_ids\n\n          raise BisectFailedError, \"\\n\\nThe example ordering is inconsistent. \" \\\n                \"`--bisect` relies upon consistent ordering (e.g. by passing \" \\\n                \"`--seed` if you're using random ordering) to work properly.\"\n        end\n\n        def notify(*args)\n          @notifier.publish(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "prep", "signature": "def prep notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args, :bisect_runner => runner.class.name)", "start_line": 113, "end_line": 132}, "metadata": {"module": "RSpec", "class_name": "ExampleMinimizer", "class_signature": "class ExampleMinimizer"}, "task_id": 314}
{"function_name": "get_expected_failures_for?", "file_path": "rspec-core/lib/rspec/core/bisect/example_minimizer.rb", "focal_code": "def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end", "file_content": "RSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # @private\n      # Contains the core bisect logic. Searches for examples we can ignore by\n      # repeatedly running different subsets of the suite.\n      class ExampleMinimizer\n        attr_reader :shell_command, :runner, :all_example_ids, :failed_example_ids\n        attr_accessor :remaining_ids\n\n        def initialize(shell_command, runner, notifier)\n          @shell_command = shell_command\n          @runner        = runner\n          @notifier      = notifier\n        end\n\n        def find_minimal_repro\n          prep\n\n          _, duration = track_duration do\n            bisect(non_failing_example_ids)\n          end\n\n          notify(:bisect_complete, :duration => duration,\n                                   :original_non_failing_count => non_failing_example_ids.size,\n                                   :remaining_count => remaining_ids.size)\n\n          remaining_ids + failed_example_ids\n        end\n\n        def bisect(candidate_ids)\n          notify(:bisect_dependency_check_started)\n          if get_expected_failures_for?([])\n            notify(:bisect_dependency_check_failed)\n            self.remaining_ids = []\n            return\n          end\n          notify(:bisect_dependency_check_passed)\n\n          bisect_over(candidate_ids)\n        end\n\n        def bisect_over(candidate_ids)\n          return if candidate_ids.one?\n\n          notify(\n            :bisect_round_started,\n            :candidate_range => example_range(candidate_ids),\n            :candidates_count => candidate_ids.size\n          )\n\n          slice_size = (candidate_ids.length / 2.0).ceil\n          lhs, rhs = candidate_ids.each_slice(slice_size).to_a\n\n          ids_to_ignore, duration = track_duration do\n            [lhs, rhs].find do |ids|\n              get_expected_failures_for?(remaining_ids - ids)\n            end\n          end\n\n          if ids_to_ignore\n            self.remaining_ids -= ids_to_ignore\n            notify(\n              :bisect_round_ignoring_ids,\n              :ids_to_ignore => ids_to_ignore,\n              :ignore_range => example_range(ids_to_ignore),\n              :remaining_ids => remaining_ids,\n              :duration => duration\n            )\n            bisect_over(candidate_ids - ids_to_ignore)\n          else\n            notify(\n              :bisect_round_detected_multiple_culprits,\n              :duration => duration\n            )\n            bisect_over(lhs)\n            bisect_over(rhs)\n          end\n        end\n\n        def currently_needed_ids\n          remaining_ids + failed_example_ids\n        end\n\n        def repro_command_for_currently_needed_ids\n          return shell_command.repro_command_from(currently_needed_ids) if remaining_ids\n          \"(Not yet enough information to provide any repro command)\"\n        end\n\n        # @private\n        # Convenience class for describing a subset of the candidate examples\n        ExampleRange = Struct.new(:start, :finish) do\n          def description\n            if start == finish\n              \"example #{start}\"\n            else\n              \"examples #{start}-#{finish}\"\n            end\n          end\n        end\n\n      private\n\n        def example_range(ids)\n          ExampleRange.new(\n            non_failing_example_ids.find_index(ids.first) + 1,\n            non_failing_example_ids.find_index(ids.last) + 1\n          )\n        end\n\n        def prep\n          notify(:bisect_starting, :original_cli_args => shell_command.original_cli_args,\n                                   :bisect_runner => runner.class.name)\n\n          _, duration = track_duration do\n            original_results    = runner.original_results\n            @all_example_ids    = original_results.all_example_ids\n            @failed_example_ids = original_results.failed_example_ids\n            @remaining_ids      = non_failing_example_ids\n          end\n\n          if @failed_example_ids.empty?\n            raise BisectFailedError, \"\\n\\nNo failures found. Bisect only works \" \\\n                  \"in the presence of one or more failing examples.\"\n          else\n            notify(:bisect_original_run_complete, :failed_example_ids => failed_example_ids,\n                                                  :non_failing_example_ids => non_failing_example_ids,\n                                                  :duration => duration)\n          end\n        end\n\n        def non_failing_example_ids\n          @non_failing_example_ids ||= all_example_ids - failed_example_ids\n        end\n\n        def get_expected_failures_for?(ids)\n          ids_to_run = all_example_ids & (ids + failed_example_ids)\n          notify(\n            :bisect_individual_run_start,\n            :command => shell_command.repro_command_from(ids_to_run),\n            :ids_to_run => ids_to_run\n          )\n\n          results, duration = track_duration { runner.run(ids_to_run) }\n          notify(:bisect_individual_run_complete, :duration => duration, :results => results)\n\n          abort_if_ordering_inconsistent(results)\n          (failed_example_ids & results.failed_example_ids) == failed_example_ids\n        end\n\n        def track_duration\n          start = ::RSpec::Core::Time.now\n          [yield, ::RSpec::Core::Time.now - start]\n        end\n\n        def abort_if_ordering_inconsistent(results)\n          expected_order = all_example_ids & results.all_example_ids\n          return if expected_order == results.all_example_ids\n\n          raise BisectFailedError, \"\\n\\nThe example ordering is inconsistent. \" \\\n                \"`--bisect` relies upon consistent ordering (e.g. by passing \" \\\n                \"`--seed` if you're using random ordering) to work properly.\"\n        end\n\n        def notify(*args)\n          @notifier.publish(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "get_expected_failures_for?", "signature": "def get_expected_failures_for?(ids)", "start_line": 138, "end_line": 151}, "metadata": {"module": "RSpec", "class_name": "ExampleMinimizer", "class_signature": "class ExampleMinimizer"}, "task_id": 315}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/bisect/fork_runner.rb", "focal_code": "def initialize(runner, channel)\n            @runner = runner\n            @channel = channel\n\n            @spec_output = StringIO.new\n\n            runner.configuration.tap do |c|\n              c.reset_reporter\n              c.output_stream = @spec_output\n              c.error_stream = @spec_output\n            end\n          end", "file_content": "require 'stringio'\nRSpec::Support.require_rspec_core \"formatters/base_bisect_formatter\"\nRSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # A Bisect runner that runs requested subsets of the suite by forking\n      # sub-processes. The main process bootstraps RSpec and the application\n      # environment (including preloading files specified via `--require`) so\n      # that the individual spec runs do not have to re-pay that cost.  Each\n      # spec run happens in a forked process, ensuring that the spec files are\n      # not loaded in the main process.\n      #\n      # For most projects, bisections that use `ForkRunner` instead of\n      # `ShellRunner` will finish significantly faster, because the `ShellRunner`\n      # pays the cost of booting RSpec and the app environment on _every_ run of\n      # a subset. In contrast, `ForkRunner` pays that cost only once.\n      #\n      # However, not all projects can use `ForkRunner`. Obviously, on platforms\n      # that do not support forking (e.g. Windows), it cannot be used. In addition,\n      # it can cause problems for some projects that put side-effectful spec\n      # bootstrapping logic that should run on every spec run directly at the top\n      # level in a file loaded by `--require`, rather than in a `before(:suite)`\n      # hook. For example, consider a project that relies on some top-level logic\n      # in `spec_helper` to boot a Redis server for the test suite, intending the\n      # Redis bootstrapping to happen on every spec run. With `ShellRunner`, the\n      # bootstrapping logic will happen for each run of any subset of the suite,\n      # but for `ForkRunner`, such logic will only get run once, when the\n      # `RunDispatcher` boots the application environment. This might cause\n      # problems. The solution is for users to move the bootstrapping logic into\n      # a `before(:suite)` hook, or use the slower `ShellRunner`.\n      #\n      # @private\n      class ForkRunner\n        def self.start(shell_command, spec_runner)\n          instance = new(shell_command, spec_runner)\n          yield instance\n        ensure\n          instance.shutdown\n        end\n\n        def self.name\n          :fork\n        end\n\n        def initialize(shell_command, spec_runner)\n          @shell_command = shell_command\n          @channel = Channel.new\n          @run_dispatcher = RunDispatcher.new(spec_runner, @channel)\n        end\n\n        def run(locations)\n          run_descriptor = ExampleSetDescriptor.new(locations, original_results.failed_example_ids)\n          dispatch_run(run_descriptor)\n        end\n\n        def original_results\n          @original_results ||= dispatch_run(ExampleSetDescriptor.new(\n            @shell_command.original_locations, []))\n        end\n\n        def shutdown\n          @channel.close\n        end\n\n      private\n\n        def dispatch_run(run_descriptor)\n          @run_dispatcher.dispatch_specs(run_descriptor)\n          @channel.receive.tap do |result|\n            if result.is_a?(String)\n              raise BisectFailedError.for_failed_spec_run(result)\n            end\n          end\n        end\n\n        # @private\n        class RunDispatcher\n          def initialize(runner, channel)\n            @runner = runner\n            @channel = channel\n\n            @spec_output = StringIO.new\n\n            runner.configuration.tap do |c|\n              c.reset_reporter\n              c.output_stream = @spec_output\n              c.error_stream = @spec_output\n            end\n          end\n\n          def dispatch_specs(run_descriptor)\n            pid = fork { run_specs(run_descriptor) }\n            # We don't use Process.waitpid here as it was causing bisects to\n            # block due to the file descriptor limit on OSX / Linux. We need\n            # to detach the process to avoid having zombie processes\n            # consuming slots in the kernel process table during bisect runs.\n            Process.detach(pid)\n          end\n\n        private\n\n          def run_specs(run_descriptor)\n            # :nocov: - Executed in a forked process, by integration/bisect_spec\n            $stdout = $stderr = @spec_output\n            formatter = CaptureFormatter.new(run_descriptor.failed_example_ids)\n\n            @runner.configuration.tap do |c|\n              c.files_or_directories_to_run = run_descriptor.all_example_ids\n              c.formatter = formatter\n              c.load_spec_files\n            end\n\n            # `announce_filters` has the side effect of implementing the logic\n            # that honors `config.run_all_when_everything_filtered` so we need\n            # to call it here. When we remove `run_all_when_everything_filtered`\n            # (slated for RSpec 4), we can remove this call to `announce_filters`.\n            @runner.world.announce_filters\n\n            @runner.run_specs(@runner.world.ordered_example_groups)\n            latest_run_results = formatter.results\n\n            if latest_run_results.nil? || latest_run_results.all_example_ids.empty?\n              @channel.send(@spec_output.string)\n            else\n              @channel.send(latest_run_results)\n            end\n            # :nocov:\n          end\n        end\n\n        class CaptureFormatter < Formatters::BaseBisectFormatter\n          attr_accessor :results\n          alias_method :notify_results, :results=\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(runner, channel)", "start_line": 80, "end_line": 91}, "metadata": {"module": "RSpec", "class_name": "ForkRunner", "class_signature": "class ForkRunner"}, "task_id": 316}
{"function_name": "capture_run_results", "file_path": "rspec-core/lib/rspec/core/bisect/server.rb", "focal_code": "def capture_run_results(files_or_directories_to_run=[], expected_failures=[])\n          self.expected_failures  = expected_failures\n          self.files_or_directories_to_run = files_or_directories_to_run\n          self.latest_run_results = nil\n          run_output = yield\n\n          if latest_run_results.nil? || latest_run_results.all_example_ids.empty?\n            raise BisectFailedError.for_failed_spec_run(run_output)\n          end\n\n          latest_run_results\n        end", "file_content": "require 'drb/drb'\nrequire 'drb/acl'\nRSpec::Support.require_rspec_core \"bisect/utilities\"\n\nmodule RSpec\n  module Core\n    # @private\n    module Bisect\n      # @private\n      # A DRb server that receives run results from a separate RSpec process\n      # started by the bisect process.\n      class Server\n        def self.run\n          server = new\n          server.start\n          yield server\n        ensure\n          server.stop\n        end\n\n        def capture_run_results(files_or_directories_to_run=[], expected_failures=[])\n          self.expected_failures  = expected_failures\n          self.files_or_directories_to_run = files_or_directories_to_run\n          self.latest_run_results = nil\n          run_output = yield\n\n          if latest_run_results.nil? || latest_run_results.all_example_ids.empty?\n            raise BisectFailedError.for_failed_spec_run(run_output)\n          end\n\n          latest_run_results\n        end\n\n        def start\n          # Only allow remote DRb requests from this machine.\n          DRb.install_acl ACL.new(%w[ deny all allow localhost allow 127.0.0.1 allow ::1 ])\n\n          # We pass `nil` as the first arg to allow it to pick a DRb port.\n          @drb = DRb.start_service(nil, self)\n        end\n\n        def stop\n          @drb.stop_service\n        end\n\n        def drb_port\n          @drb_port ||= Integer(@drb.uri[/\\d+$/])\n        end\n\n        # Fetched via DRb by the BisectDRbFormatter to determine when to abort.\n        attr_accessor :expected_failures\n\n        # Set via DRb by the BisectDRbFormatter with the results of the run.\n        attr_accessor :latest_run_results\n\n        # Fetched via DRb to tell clients which files to run\n        attr_accessor :files_or_directories_to_run\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "capture_run_results", "signature": "def capture_run_results(files_or_directories_to_run=[], expected_failures=[])", "start_line": 21, "end_line": 32}, "metadata": {"module": "RSpec", "class_name": "Server", "class_signature": "class Server"}, "task_id": 317}
{"function_name": "command_for", "file_path": "rspec-core/lib/rspec/core/bisect/shell_command.rb", "focal_code": "def command_for(locations, server)\n          parts = []\n\n          parts << RUBY << load_path\n          parts << open3_safe_escape(RSpec::Core.path_to_executable)\n\n          parts << \"--format\"   << \"bisect-drb\"\n          parts << \"--drb-port\" << server.drb_port\n\n          parts.concat(reusable_cli_options)\n          parts.concat(locations.map { |l| open3_safe_escape(l) })\n\n          parts.join(\" \")\n        end", "file_content": "RSpec::Support.require_rspec_core \"shell_escape\"\nrequire 'shellwords'\n\nmodule RSpec\n  module Core\n    module Bisect\n      # Provides an API to generate shell commands to run the suite for a\n      # set of locations, using the given bisect server to capture the results.\n      # @private\n      class ShellCommand\n        attr_reader :original_cli_args\n\n        def initialize(original_cli_args)\n          @original_cli_args = original_cli_args.reject { |arg| arg.start_with?(\"--bisect\") }\n        end\n\n        def command_for(locations, server)\n          parts = []\n\n          parts << RUBY << load_path\n          parts << open3_safe_escape(RSpec::Core.path_to_executable)\n\n          parts << \"--format\"   << \"bisect-drb\"\n          parts << \"--drb-port\" << server.drb_port\n\n          parts.concat(reusable_cli_options)\n          parts.concat(locations.map { |l| open3_safe_escape(l) })\n\n          parts.join(\" \")\n        end\n\n        def repro_command_from(locations)\n          parts = []\n\n          parts.concat environment_repro_parts\n          parts << \"rspec\"\n          parts.concat Formatters::Helpers.organize_ids(locations)\n          parts.concat original_cli_args_without_locations\n\n          parts.join(\" \")\n        end\n\n        def original_locations\n          parsed_original_cli_options.fetch(:files_or_directories_to_run)\n        end\n\n        def bisect_environment_hash\n          if ENV.key?('SPEC_OPTS')\n            { 'SPEC_OPTS' => spec_opts_without_bisect }\n          else\n            {}\n          end\n        end\n\n        def spec_opts_without_bisect\n          Shellwords.join(\n            Shellwords.split(ENV.fetch('SPEC_OPTS', '')).reject do |arg|\n              arg =~ /^--bisect/\n            end\n          )\n        end\n\n      private\n\n        include RSpec::Core::ShellEscape\n        # On JRuby, Open3.popen3 does not handle shellescaped args properly:\n        # https://github.com/jruby/jruby/issues/2767\n        if RSpec::Support::Ruby.jruby?\n          # :nocov:\n          alias open3_safe_escape quote\n          # :nocov:\n        else\n          alias open3_safe_escape escape\n        end\n\n        def environment_repro_parts\n          bisect_environment_hash.map do |k, v|\n            %Q(#{k}=\"#{v}\")\n          end\n        end\n\n        def reusable_cli_options\n          @reusable_cli_options ||= begin\n            opts = original_cli_args_without_locations\n\n            if (port = parsed_original_cli_options[:drb_port])\n              opts -= %W[ --drb-port #{port} ]\n            end\n\n            parsed_original_cli_options.fetch(:formatters) { [] }.each do |(name, out)|\n              opts -= %W[ --format #{name} -f -f#{name} ]\n              opts -= %W[ --out #{out} -o -o#{out} ]\n            end\n\n            opts\n          end\n        end\n\n        def original_cli_args_without_locations\n          @original_cli_args_without_locations ||= begin\n            files_or_dirs = parsed_original_cli_options.fetch(:files_or_directories_to_run)\n            @original_cli_args - files_or_dirs\n          end\n        end\n\n        def parsed_original_cli_options\n          @parsed_original_cli_options ||= Parser.parse(@original_cli_args)\n        end\n\n        def load_path\n          @load_path ||= \"-I#{$LOAD_PATH.map { |p| open3_safe_escape(p) }.join(':')}\"\n        end\n\n        # Path to the currently running Ruby executable, borrowed from Rake:\n        # https://github.com/ruby/rake/blob/v10.4.2/lib/rake/file_utils.rb#L8-L12\n        # Note that we skip `ENV['RUBY']` because we don't have to deal with running\n        # RSpec from within a MRI source repository:\n        # https://github.com/ruby/rake/commit/968682759b3b65e42748cd2befb2ff3e982272d9\n        RUBY = File.join(\n          RbConfig::CONFIG['bindir'],\n          RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']).\n          sub(/.*\\s.*/m, '\"\\&\"')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "command_for", "signature": "def command_for(locations, server)", "start_line": 17, "end_line": 30}, "metadata": {"module": "RSpec", "class_name": "ShellCommand", "class_signature": "class ShellCommand"}, "task_id": 318}
{"function_name": "reusable_cli_options", "file_path": "rspec-core/lib/rspec/core/bisect/shell_command.rb", "focal_code": "def reusable_cli_options\n          @reusable_cli_options ||= begin\n            opts = original_cli_args_without_locations\n\n            if (port = parsed_original_cli_options[:drb_port])\n              opts -= %W[ --drb-port #{port} ]\n            end\n\n            parsed_original_cli_options.fetch(:formatters) { [] }.each do |(name, out)|\n              opts -= %W[ --format #{name} -f -f#{name} ]\n              opts -= %W[ --out #{out} -o -o#{out} ]\n            end\n\n            opts\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"shell_escape\"\nrequire 'shellwords'\n\nmodule RSpec\n  module Core\n    module Bisect\n      # Provides an API to generate shell commands to run the suite for a\n      # set of locations, using the given bisect server to capture the results.\n      # @private\n      class ShellCommand\n        attr_reader :original_cli_args\n\n        def initialize(original_cli_args)\n          @original_cli_args = original_cli_args.reject { |arg| arg.start_with?(\"--bisect\") }\n        end\n\n        def command_for(locations, server)\n          parts = []\n\n          parts << RUBY << load_path\n          parts << open3_safe_escape(RSpec::Core.path_to_executable)\n\n          parts << \"--format\"   << \"bisect-drb\"\n          parts << \"--drb-port\" << server.drb_port\n\n          parts.concat(reusable_cli_options)\n          parts.concat(locations.map { |l| open3_safe_escape(l) })\n\n          parts.join(\" \")\n        end\n\n        def repro_command_from(locations)\n          parts = []\n\n          parts.concat environment_repro_parts\n          parts << \"rspec\"\n          parts.concat Formatters::Helpers.organize_ids(locations)\n          parts.concat original_cli_args_without_locations\n\n          parts.join(\" \")\n        end\n\n        def original_locations\n          parsed_original_cli_options.fetch(:files_or_directories_to_run)\n        end\n\n        def bisect_environment_hash\n          if ENV.key?('SPEC_OPTS')\n            { 'SPEC_OPTS' => spec_opts_without_bisect }\n          else\n            {}\n          end\n        end\n\n        def spec_opts_without_bisect\n          Shellwords.join(\n            Shellwords.split(ENV.fetch('SPEC_OPTS', '')).reject do |arg|\n              arg =~ /^--bisect/\n            end\n          )\n        end\n\n      private\n\n        include RSpec::Core::ShellEscape\n        # On JRuby, Open3.popen3 does not handle shellescaped args properly:\n        # https://github.com/jruby/jruby/issues/2767\n        if RSpec::Support::Ruby.jruby?\n          # :nocov:\n          alias open3_safe_escape quote\n          # :nocov:\n        else\n          alias open3_safe_escape escape\n        end\n\n        def environment_repro_parts\n          bisect_environment_hash.map do |k, v|\n            %Q(#{k}=\"#{v}\")\n          end\n        end\n\n        def reusable_cli_options\n          @reusable_cli_options ||= begin\n            opts = original_cli_args_without_locations\n\n            if (port = parsed_original_cli_options[:drb_port])\n              opts -= %W[ --drb-port #{port} ]\n            end\n\n            parsed_original_cli_options.fetch(:formatters) { [] }.each do |(name, out)|\n              opts -= %W[ --format #{name} -f -f#{name} ]\n              opts -= %W[ --out #{out} -o -o#{out} ]\n            end\n\n            opts\n          end\n        end\n\n        def original_cli_args_without_locations\n          @original_cli_args_without_locations ||= begin\n            files_or_dirs = parsed_original_cli_options.fetch(:files_or_directories_to_run)\n            @original_cli_args - files_or_dirs\n          end\n        end\n\n        def parsed_original_cli_options\n          @parsed_original_cli_options ||= Parser.parse(@original_cli_args)\n        end\n\n        def load_path\n          @load_path ||= \"-I#{$LOAD_PATH.map { |p| open3_safe_escape(p) }.join(':')}\"\n        end\n\n        # Path to the currently running Ruby executable, borrowed from Rake:\n        # https://github.com/ruby/rake/blob/v10.4.2/lib/rake/file_utils.rb#L8-L12\n        # Note that we skip `ENV['RUBY']` because we don't have to deal with running\n        # RSpec from within a MRI source repository:\n        # https://github.com/ruby/rake/commit/968682759b3b65e42748cd2befb2ff3e982272d9\n        RUBY = File.join(\n          RbConfig::CONFIG['bindir'],\n          RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']).\n          sub(/.*\\s.*/m, '\"\\&\"')\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "reusable_cli_options", "signature": "def reusable_cli_options @reusable_cli_options ||= begin", "start_line": 82, "end_line": 97}, "metadata": {"module": "RSpec", "class_name": "ShellCommand", "class_signature": "class ShellCommand"}, "task_id": 319}
{"function_name": "run_command", "file_path": "rspec-core/lib/rspec/core/bisect/shell_runner.rb", "focal_code": "def run_command(cmd)\n            out = err = nil\n\n            original_spec_opts = ENV['SPEC_OPTS']\n            ENV['SPEC_OPTS'] = @shell_command.spec_opts_without_bisect\n\n            Open3.popen3(cmd) do |_, stdout, stderr|\n              # Reading the streams blocks until the process is complete\n              out = stdout.read\n              err = stderr.read\n            end\n\n            \"Stdout:\\n#{out}\\n\\nStderr:\\n#{err}\"\n          ensure\n            ENV['SPEC_OPTS'] = original_spec_opts\n          end", "file_content": "require 'open3'\nRSpec::Support.require_rspec_core \"bisect/server\"\n\nmodule RSpec\n  module Core\n    module Bisect\n      # Provides an API to run the suite for a set of locations, using\n      # the given bisect server to capture the results.\n      #\n      # Sets of specs are run by shelling out.\n      # @private\n      class ShellRunner\n        def self.start(shell_command, _spec_runner)\n          Server.run do |server|\n            yield new(server, shell_command)\n          end\n        end\n\n        def self.name\n          :shell\n        end\n\n        def initialize(server, shell_command)\n          @server        = server\n          @shell_command = shell_command\n        end\n\n        def run(locations)\n          run_locations(locations, original_results.failed_example_ids)\n        end\n\n        def original_results\n          @original_results ||= run_locations(@shell_command.original_locations)\n        end\n\n      private\n\n        def run_locations(*capture_args)\n          @server.capture_run_results(*capture_args) do\n            run_command @shell_command.command_for([], @server)\n          end\n        end\n\n        # `Open3.capture2e` does not work on JRuby:\n        # https://github.com/jruby/jruby/issues/2766\n        if Open3.respond_to?(:capture2e) && !RSpec::Support::Ruby.jruby?\n          def run_command(cmd)\n            Open3.capture2e(@shell_command.bisect_environment_hash, cmd).first\n          end\n        else # for 1.8.7\n          # :nocov:\n          def run_command(cmd)\n            out = err = nil\n\n            original_spec_opts = ENV['SPEC_OPTS']\n            ENV['SPEC_OPTS'] = @shell_command.spec_opts_without_bisect\n\n            Open3.popen3(cmd) do |_, stdout, stderr|\n              # Reading the streams blocks until the process is complete\n              out = stdout.read\n              err = stderr.read\n            end\n\n            \"Stdout:\\n#{out}\\n\\nStderr:\\n#{err}\"\n          ensure\n            ENV['SPEC_OPTS'] = original_spec_opts\n          end\n          # :nocov:\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "run_command", "signature": "def run_command(cmd)", "start_line": 52, "end_line": 67}, "metadata": {"module": "RSpec", "class_name": "ShellRunner", "class_signature": "class ShellRunner"}, "task_id": 320}
{"function_name": "bisect_dependency_check_failed", "file_path": "rspec-core/lib/rspec/core/formatters/bisect_progress_formatter.rb", "focal_code": "def bisect_dependency_check_failed(_notification)\n          output.puts \" failure(s) do not require any non-failures to run first\"\n\n          if @bisect_runner == :fork\n            output.puts\n            output.puts \"=\" * 80\n            output.puts \"NOTE: this bisect run used `config.bisect_runner = :fork`, which generally\"\n            output.puts \"provides significantly faster bisection runs than the old shell-based runner,\"\n            output.puts \"but may inaccurately report that no non-failures are required. If this result\"\n            output.puts \"is unexpected, consider setting `config.bisect_runner = :shell` and trying again.\"\n            output.puts \"=\" * 80\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"formatters/base_text_formatter\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      # Produces progress output while bisecting.\n      class BisectProgressFormatter < BaseTextFormatter\n        def initialize(output, bisect_runner)\n          super(output)\n          @bisect_runner = bisect_runner\n        end\n\n        def bisect_starting(notification)\n          @round_count = 0\n          output.puts bisect_started_message(notification)\n          output.print \"Running suite to find failures...\"\n        end\n\n        def bisect_original_run_complete(notification)\n          failures     = Helpers.pluralize(notification.failed_example_ids.size, \"failing example\")\n          non_failures = Helpers.pluralize(notification.non_failing_example_ids.size, \"non-failing example\")\n\n          output.puts \" (#{Helpers.format_duration(notification.duration)})\"\n          output.puts \"Starting bisect with #{failures} and #{non_failures}.\"\n        end\n\n        def bisect_dependency_check_started(_notification)\n          output.print \"Checking that failure(s) are order-dependent..\"\n        end\n\n        def bisect_dependency_check_passed(_notification)\n          output.puts \" failure appears to be order-dependent\"\n        end\n\n        def bisect_dependency_check_failed(_notification)\n          output.puts \" failure(s) do not require any non-failures to run first\"\n\n          if @bisect_runner == :fork\n            output.puts\n            output.puts \"=\" * 80\n            output.puts \"NOTE: this bisect run used `config.bisect_runner = :fork`, which generally\"\n            output.puts \"provides significantly faster bisection runs than the old shell-based runner,\"\n            output.puts \"but may inaccurately report that no non-failures are required. If this result\"\n            output.puts \"is unexpected, consider setting `config.bisect_runner = :shell` and trying again.\"\n            output.puts \"=\" * 80\n          end\n        end\n\n        def bisect_round_started(notification, include_trailing_space=true)\n          @round_count += 1\n          range_desc = notification.candidate_range.description\n\n          output.print \"\\nRound #{@round_count}: bisecting over non-failing #{range_desc}\"\n          output.print \" \" if include_trailing_space\n        end\n\n        def bisect_round_ignoring_ids(notification)\n          range_desc = notification.ignore_range.description\n\n          output.print \" ignoring #{range_desc}\"\n          output.print \" (#{Helpers.format_duration(notification.duration)})\"\n        end\n\n        def bisect_round_detected_multiple_culprits(notification)\n          output.print \" multiple culprits detected - splitting candidates\"\n          output.print \" (#{Helpers.format_duration(notification.duration)})\"\n        end\n\n        def bisect_individual_run_complete(_)\n          output.print '.'\n        end\n\n        def bisect_complete(notification)\n          output.puts \"\\nBisect complete! Reduced necessary non-failing examples \" \\\n                      \"from #{notification.original_non_failing_count} to \" \\\n                      \"#{notification.remaining_count} in \" \\\n                      \"#{Helpers.format_duration(notification.duration)}.\"\n        end\n\n        def bisect_repro_command(notification)\n          output.puts \"\\nThe minimal reproduction command is:\\n  #{notification.repro}\"\n        end\n\n        def bisect_failed(notification)\n          output.puts \"\\nBisect failed! #{notification.failure_explanation}\"\n        end\n\n        def bisect_aborted(notification)\n          output.puts \"\\n\\nBisect aborted!\"\n          output.puts \"\\nThe most minimal reproduction command discovered so far is:\\n  #{notification.repro}\"\n        end\n\n      private\n\n        def bisect_started_message(notification)\n          options = notification.original_cli_args.join(' ')\n          \"Bisect started using options: #{options.inspect}\"\n        end\n      end\n\n      # @private\n      # Produces detailed debug output while bisecting. Used when bisect is\n      # performed with `--bisect=verbose`. Designed to provide details for\n      # us when we need to troubleshoot bisect bugs.\n      class BisectDebugFormatter < BisectProgressFormatter\n        def bisect_original_run_complete(notification)\n          output.puts \" (#{Helpers.format_duration(notification.duration)})\"\n\n          output.puts \" - #{describe_ids 'Failing examples', notification.failed_example_ids}\"\n          output.puts \" - #{describe_ids 'Non-failing examples', notification.non_failing_example_ids}\"\n        end\n\n        def bisect_individual_run_start(notification)\n          output.print \"\\n - Running: #{notification.command}\"\n        end\n\n        def bisect_individual_run_complete(notification)\n          output.print \" (#{Helpers.format_duration(notification.duration)})\"\n        end\n\n        def bisect_dependency_check_passed(_notification)\n          output.print \"\\n - Failure appears to be order-dependent\"\n        end\n\n        def bisect_dependency_check_failed(_notification)\n          output.print \"\\n - Failure is not order-dependent\"\n        end\n\n        def bisect_round_started(notification)\n          super(notification, false)\n        end\n\n        def bisect_round_ignoring_ids(notification)\n          output.print \"\\n - #{describe_ids 'Examples we can safely ignore', notification.ids_to_ignore}\"\n          output.print \"\\n - #{describe_ids 'Remaining non-failing examples', notification.remaining_ids}\"\n        end\n\n        def bisect_round_detected_multiple_culprits(_notification)\n          output.print \"\\n - Multiple culprits detected - splitting candidates\"\n        end\n\n      private\n\n        def describe_ids(description, ids)\n          organized_ids = Formatters::Helpers.organize_ids(ids)\n          formatted_ids = organized_ids.map { |id| \"    - #{id}\" }.join(\"\\n\")\n          \"#{description} (#{ids.size}):\\n#{formatted_ids}\"\n        end\n\n        def bisect_started_message(notification)\n          \"#{super} and bisect runner: #{notification.bisect_runner.inspect}\"\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "bisect_dependency_check_failed", "signature": "def bisect_dependency_check_failed(_notification)", "start_line": 36, "end_line": 48}, "metadata": {"module": "RSpec", "class_name": "BisectProgressFormatter", "class_signature": "class BisectProgressFormatter < < BaseTextFormatter"}, "task_id": 321}
{"function_name": "console_code_for", "file_path": "rspec-core/lib/rspec/core/formatters/console_codes.rb", "focal_code": "def console_code_for(code_or_symbol)\n          if (config_method = config_colors_to_methods[code_or_symbol])\n            console_code_for RSpec.configuration.__send__(config_method)\n          elsif VT100_CODE_VALUES.key?(code_or_symbol)\n            code_or_symbol\n          else\n            VT100_CODES.fetch(code_or_symbol) do\n              console_code_for(:white)\n            end\n          end\n        end", "file_content": "module RSpec\n  module Core\n    module Formatters\n      # ConsoleCodes provides helpers for formatting console output\n      # with ANSI codes, e.g. color's and bold.\n      module ConsoleCodes\n        # @private\n        VT100_CODES =\n          {\n            :black         => 30,\n            :red           => 31,\n            :green         => 32,\n            :yellow        => 33,\n            :blue          => 34,\n            :magenta       => 35,\n            :cyan          => 36,\n            :white         => 37,\n            :bold_black   => '1;30',\n            :bold_red     => '1;31',\n            :bold_green   => '1;32',\n            :bold_yellow  => '1;33',\n            :bold_blue    => '1;34',\n            :bold_magenta => '1;35',\n            :bold_cyan    => '1;36',\n            :bold_white   => '1;37',\n            :bold          => 1,\n          }\n        # @private\n        VT100_CODE_VALUES = VT100_CODES.invert\n\n        module_function\n\n        # @private\n        def config_colors_to_methods\n          @config_colors_to_methods ||=\n            Configuration.instance_methods.grep(/_color\\z/).inject({}) do |hash, method|\n              hash[method.to_s.sub(/_color\\z/, '').to_sym] = method\n              hash\n            end\n        end\n\n        # Fetches the correct code for the supplied symbol, or checks\n        # that a code is valid. Defaults to white (37).\n        #\n        # @param code_or_symbol [Symbol, Fixnum] Symbol or code to check\n        # @return [Fixnum] a console code\n        def console_code_for(code_or_symbol)\n          if (config_method = config_colors_to_methods[code_or_symbol])\n            console_code_for RSpec.configuration.__send__(config_method)\n          elsif VT100_CODE_VALUES.key?(code_or_symbol)\n            code_or_symbol\n          else\n            VT100_CODES.fetch(code_or_symbol) do\n              console_code_for(:white)\n            end\n          end\n        end\n\n        # Wraps a piece of text in ANSI codes with the supplied code. Will\n        # only apply the control code if `RSpec.configuration.color_enabled?`\n        # returns true.\n        #\n        # @param text [String] the text to wrap\n        # @param code_or_symbol [Symbol, Fixnum] the desired control code\n        # @return [String] the wrapped text\n        def wrap(text, code_or_symbol)\n          if RSpec.configuration.color_enabled?\n            \"\\e[#{console_code_for(code_or_symbol)}m#{text}\\e[0m\"\n          else\n            text\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "console_code_for", "signature": "def console_code_for(code_or_symbol)", "start_line": 47, "end_line": 57}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 322}
{"function_name": "printer", "file_path": "rspec-core/lib/rspec/core/formatters/deprecation_formatter.rb", "focal_code": "def printer\n          @printer ||= case deprecation_stream\n                       when File\n                         ImmediatePrinter.new(FileStream.new(deprecation_stream),\n                                              summary_stream, self)\n                       when RaiseErrorStream\n                         ImmediatePrinter.new(deprecation_stream, summary_stream, self)\n                       else\n                         DelayedPrinter.new(deprecation_stream, summary_stream, self)\n                       end\n        end", "file_content": "RSpec::Support.require_rspec_core \"formatters/helpers\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class DeprecationFormatter\n        Formatters.register self, :deprecation, :deprecation_summary\n\n        attr_reader :count, :deprecation_stream, :summary_stream\n\n        def initialize(deprecation_stream, summary_stream)\n          @deprecation_stream = deprecation_stream\n          @summary_stream = summary_stream\n          @seen_deprecations = Set.new\n          @count = 0\n        end\n        alias :output :deprecation_stream\n\n        def printer\n          @printer ||= case deprecation_stream\n                       when File\n                         ImmediatePrinter.new(FileStream.new(deprecation_stream),\n                                              summary_stream, self)\n                       when RaiseErrorStream\n                         ImmediatePrinter.new(deprecation_stream, summary_stream, self)\n                       else\n                         DelayedPrinter.new(deprecation_stream, summary_stream, self)\n                       end\n        end\n\n        def deprecation(notification)\n          return if @seen_deprecations.include? notification\n\n          @count += 1\n          printer.print_deprecation_message notification\n          @seen_deprecations << notification\n        end\n\n        def deprecation_summary(_notification)\n          printer.deprecation_summary\n        end\n\n        def deprecation_message_for(data)\n          if data.message\n            SpecifiedDeprecationMessage.new(data)\n          else\n            GeneratedDeprecationMessage.new(data)\n          end\n        end\n\n        RAISE_ERROR_CONFIG_NOTICE = <<-EOS.gsub(/^\\s+\\|/, '')\n          |\n          |If you need more of the backtrace for any of these deprecations to\n          |identify where to make the necessary changes, you can configure\n          |`config.raise_errors_for_deprecations!`, and it will turn the\n          |deprecation warnings into errors, giving you the full backtrace.\n        EOS\n\n        DEPRECATION_STREAM_NOTICE = \"Pass `--deprecation-out` or set \" \\\n          \"`config.deprecation_stream` to a file for full output.\"\n        TOO_MANY_WARNINGS_NOTICE  = \"Too many similar deprecation messages \" \\\n          \"reported, disregarding further reports. #{DEPRECATION_STREAM_NOTICE}\"\n\n        # @private\n        SpecifiedDeprecationMessage = Struct.new(:type) do\n          def initialize(data)\n            @message = data.message\n            super deprecation_type_for(data)\n          end\n\n          def to_s\n            output_formatted @message\n          end\n\n          def too_many_warnings_message\n            TOO_MANY_WARNINGS_NOTICE\n          end\n\n          private\n\n          def output_formatted(str)\n            return str unless str.lines.count > 1\n            separator = '-' * 80\n            \"#{separator}\\n#{str.chomp}\\n#{separator}\"\n          end\n\n          def deprecation_type_for(data)\n            data.message.gsub(/(\\w+\\/)+\\w+\\.rb:\\d+/, '')\n          end\n        end\n\n        # @private\n        GeneratedDeprecationMessage = Struct.new(:type) do\n          def initialize(data)\n            @data = data\n            super data.deprecated\n          end\n\n          def to_s\n            msg = String.new(\"#{@data.deprecated} is deprecated.\")\n            msg << \" Use #{@data.replacement} instead.\" if @data.replacement\n            msg << \" Called from #{@data.call_site}.\"   if @data.call_site\n            msg\n          end\n\n          def too_many_warnings_message\n            \"Too many uses of deprecated '#{type}'. #{DEPRECATION_STREAM_NOTICE}\"\n          end\n        end\n\n        # @private\n        class ImmediatePrinter\n          attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter\n\n          def initialize(deprecation_stream, summary_stream, deprecation_formatter)\n            @deprecation_stream = deprecation_stream\n\n            @summary_stream = summary_stream\n            @deprecation_formatter = deprecation_formatter\n          end\n\n          def print_deprecation_message(data)\n            deprecation_message = deprecation_formatter.deprecation_message_for(data)\n            deprecation_stream.puts deprecation_message.to_s\n          end\n\n          def deprecation_summary\n            return if deprecation_formatter.count.zero?\n            deprecation_stream.summarize(summary_stream, deprecation_formatter.count)\n          end\n        end\n\n        # @private\n        class DelayedPrinter\n          TOO_MANY_USES_LIMIT = 4\n\n          attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter\n\n          def initialize(deprecation_stream, summary_stream, deprecation_formatter)\n            @deprecation_stream = deprecation_stream\n            @summary_stream = summary_stream\n            @deprecation_formatter = deprecation_formatter\n            @seen_deprecations = Hash.new { 0 }\n            @deprecation_messages = Hash.new { |h, k| h[k] = [] }\n          end\n\n          def print_deprecation_message(data)\n            deprecation_message = deprecation_formatter.deprecation_message_for(data)\n            @seen_deprecations[deprecation_message] += 1\n\n            stash_deprecation_message(deprecation_message)\n          end\n\n          def stash_deprecation_message(deprecation_message)\n            if @seen_deprecations[deprecation_message] < TOO_MANY_USES_LIMIT\n              @deprecation_messages[deprecation_message] << deprecation_message.to_s\n            elsif @seen_deprecations[deprecation_message] == TOO_MANY_USES_LIMIT\n              @deprecation_messages[deprecation_message] << deprecation_message.too_many_warnings_message\n            end\n          end\n\n          def deprecation_summary\n            return unless @deprecation_messages.any?\n\n            print_deferred_deprecation_warnings\n            deprecation_stream.puts RAISE_ERROR_CONFIG_NOTICE\n\n            summary_stream.puts \"\\n#{Helpers.pluralize(deprecation_formatter.count, 'deprecation warning')} total\"\n          end\n\n          def print_deferred_deprecation_warnings\n            deprecation_stream.puts \"\\nDeprecation Warnings:\\n\\n\"\n            @deprecation_messages.keys.sort_by(&:type).each do |deprecation|\n              messages = @deprecation_messages[deprecation]\n              messages.each { |msg| deprecation_stream.puts msg }\n              deprecation_stream.puts\n            end\n          end\n        end\n\n        # @private\n        # Not really a stream, but is usable in place of one.\n        class RaiseErrorStream\n          def puts(message)\n            raise DeprecationError, message\n          end\n\n          def summarize(summary_stream, deprecation_count)\n            summary_stream.puts \"\\n#{Helpers.pluralize(deprecation_count, 'deprecation')} found.\"\n          end\n        end\n\n        # @private\n        # Wraps a File object and provides file-specific operations.\n        class FileStream\n          def initialize(file)\n            @file = file\n\n            # In one of my test suites, I got lots of duplicate output in the\n            # deprecation file (e.g. 200 of the same deprecation, even though\n            # the `puts` below was only called 6 times). Setting `sync = true`\n            # fixes this (but we really have no idea why!).\n            @file.sync = true\n          end\n\n          def puts(*args)\n            @file.puts(*args)\n          end\n\n          def summarize(summary_stream, deprecation_count)\n            path = @file.respond_to?(:path) ? @file.path : @file.inspect\n            summary_stream.puts \"\\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{path}\"\n            puts RAISE_ERROR_CONFIG_NOTICE\n          end\n        end\n      end\n    end\n\n    # Deprecation Error.\n    DeprecationError = Class.new(StandardError)\n  end\nend\n", "language": "Ruby", "function_component": {"name": "printer", "signature": "def printer @printer ||= case deprecation_stream", "start_line": 20, "end_line": 30}, "metadata": {"module": "RSpec", "class_name": "DeprecationFormatter", "class_signature": "class DeprecationFormatter"}, "task_id": 323}
{"function_name": "initialize", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "initialize", "signature": "def initialize(exception, example, options={})", "start_line": 21, "end_line": 32}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 324}
{"function_name": "formatted_cause", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "formatted_cause", "signature": "def formatted_cause(exception)", "start_line": 50, "end_line": 74}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 325}
{"function_name": "fully_formatted_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "fully_formatted_lines", "signature": "def fully_formatted_lines(failure_number, colorizer)", "start_line": 94, "end_line": 105}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 326}
{"function_name": "indent_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "indent_lines", "signature": "def indent_lines(lines, failure_number)", "start_line": 139, "end_line": 153}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 327}
{"function_name": "failure_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "failure_lines", "signature": "def failure_lines @failure_lines ||= [].tap do |lines|", "start_line": 161, "end_line": 173}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 328}
{"function_name": "failure_slash_error_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "failure_slash_error_lines", "signature": "def failure_slash_error_lines lines = read_failed_lines", "start_line": 175, "end_line": 185}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 329}
{"function_name": "exception_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "exception_lines", "signature": "def exception_lines @exception_lines ||= begin", "start_line": 209, "end_line": 218}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 330}
{"function_name": "extra_failure_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "extra_failure_lines", "signature": "def extra_failure_lines @extra_failure_lines ||= begin", "start_line": 220, "end_line": 229}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 331}
{"function_name": "read_failed_lines", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "read_failed_lines", "signature": "def read_failed_lines matching_line = find_failed_line", "start_line": 241, "end_line": 265}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 332}
{"function_name": "find_failed_line", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "find_failed_line", "signature": "def find_failed_line line_regex = RSpec.configuration.in_project_source_dir_regex", "start_line": 267, "end_line": 280}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 333}
{"function_name": "pending_options", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "pending_options", "signature": "def pending_options if @execution_result.pending_fixed?", "start_line": 333, "end_line": 352}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 334}
{"function_name": "with_multiple_error_options_as_needed", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "with_multiple_error_options_as_needed", "signature": "def with_multiple_error_options_as_needed(exception, options)", "start_line": 354, "end_line": 368}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 335}
{"function_name": "multiple_exception_summarizer", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "multiple_exception_summarizer", "signature": "def multiple_exception_summarizer(exception, prior_detail_formatter, color)", "start_line": 374, "end_line": 393}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 336}
{"function_name": "sub_failure_list_formatter", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "sub_failure_list_formatter", "signature": "def sub_failure_list_formatter(exception, message_color)", "start_line": 395, "end_line": 416}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 337}
{"function_name": "with_truncated_backtrace", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "with_truncated_backtrace", "signature": "def with_truncated_backtrace(child)", "start_line": 433, "end_line": 448}, "metadata": {"module": "RSpec", "class_name": "ExceptionPresenter", "class_signature": "class ExceptionPresenter"}, "task_id": 338}
{"function_name": "add", "file_path": "rspec-core/lib/rspec/core/formatters/exception_presenter.rb", "focal_code": "def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end", "file_content": "# encoding: utf-8\nRSpec::Support.require_rspec_core \"formatters/console_codes\"\nRSpec::Support.require_rspec_core \"formatters/snippet_extractor\"\nRSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\nRSpec::Support.require_rspec_support \"encoded_string\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class ExceptionPresenter\n        attr_reader :exception, :example, :description, :message_color,\n                    :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n\n        # We want private attr_reader but that issues a warning on older rubies, refactor later\n        #\n        # rubocop:disable Style/AccessModifierDeclarations\n        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter\n        # rubocop:enable Style/AccessModifierDeclarations\n\n        def initialize(exception, example, options={})\n          @exception               = exception\n          @example                 = example\n          @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }\n          @description             = options.fetch(:description)            { example.full_description }\n          @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }\n          @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }\n          @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }\n          @indentation             = options.fetch(:indentation, 2)\n          @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)\n          @failure_lines           = options[:failure_lines]\n        end\n\n        def message_lines\n          add_shared_group_lines(failure_lines, Notifications::NullColorizer)\n        end\n\n        def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          add_shared_group_lines(failure_lines, colorizer).map do |line|\n            colorizer.wrap line, message_color\n          end\n        end\n\n        def formatted_backtrace(exception=@exception)\n          backtrace_formatter.format_backtrace(exception.backtrace, example.metadata) +\n            formatted_cause(exception)\n        end\n\n        if RSpec::Support::RubyFeatures.supports_exception_cause?\n          def formatted_cause(exception)\n            last_cause = final_exception(exception, [exception])\n            cause = []\n\n            if exception.cause\n              cause << '------------------'\n              cause << '--- Caused by: ---'\n              cause << \"#{exception_class_name(last_cause)}:\" unless exception_class_name(last_cause) =~ /RSpec/\n\n              encoded_string(exception_message_string(last_cause)).split(\"\\n\").each do |line|\n                cause << \"  #{line}\"\n              end\n\n              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?\n                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)\n                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting\n\n                lines.each do |line|\n                  cause << (\"  #{line}\")\n                end\n              end\n            end\n\n            cause\n          end\n        else\n          # :nocov:\n          def formatted_cause(_)\n            []\n          end\n          # :nocov:\n        end\n\n        def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          formatted_backtrace.map do |backtrace_info|\n            colorizer.wrap \"# #{backtrace_info}\", RSpec.configuration.detail_color\n          end\n        end\n\n        def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)\n          lines = fully_formatted_lines(failure_number, colorizer)\n          lines.join(\"\\n\") << \"\\n\"\n        end\n\n        def fully_formatted_lines(failure_number, colorizer)\n          lines = [\n            encoded_description(description),\n            detail_formatter.call(example, colorizer),\n            formatted_message_and_backtrace(colorizer),\n            extra_detail_formatter.call(failure_number, colorizer),\n          ].compact.flatten\n\n          lines = indent_lines(lines, failure_number)\n          lines.unshift(\"\")\n          lines\n        end\n\n      private\n\n        def final_exception(exception, previous=[])\n          cause = exception.cause\n\n          if cause && Exception === cause && !previous.include?(cause)\n            previous << cause\n            final_exception(cause, previous)\n          else\n            exception\n          end\n        end\n\n        if String.method_defined?(:encoding)\n          def encoding_of(string)\n            string.encoding\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string, Encoding.default_external)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoding_of(_string)\n          end\n\n          def encoded_string(string)\n            RSpec::Support::EncodedString.new(string)\n          end\n          # :nocov:\n        end\n\n        def indent_lines(lines, failure_number)\n          alignment_basis = ' ' * @indentation\n          alignment_basis <<  \"#{failure_number}) \" if failure_number\n          indentation = ' ' * alignment_basis.length\n\n          lines.each_with_index.map do |line, index|\n            if index == 0\n              \"#{alignment_basis}#{line}\"\n            elsif line.empty?\n              line\n            else\n              \"#{indentation}#{line}\"\n            end\n          end\n        end\n\n        def exception_class_name(exception=@exception)\n          name = exception.class.name.to_s\n          name = \"(anonymous error class)\" if name == ''\n          name\n        end\n\n        def failure_lines\n          @failure_lines ||= [].tap do |lines|\n            lines.concat(failure_slash_error_lines)\n\n            sections = [failure_slash_error_lines, exception_lines]\n            if sections.any? { |section| section.size > 1 } && !exception_lines.first.empty?\n              lines << ''\n            end\n\n            lines.concat(exception_lines)\n            lines.concat(extra_failure_lines)\n          end\n        end\n\n        def failure_slash_error_lines\n          lines = read_failed_lines\n          if lines.count == 1\n            lines[0] = \"Failure/Error: #{lines[0].strip}\"\n          else\n            least_indentation = SnippetExtractor.least_indentation_from(lines)\n            lines = lines.map { |line| line.sub(/^#{least_indentation}/, '  ') }\n            lines.unshift('Failure/Error:')\n          end\n          lines\n        end\n\n        # rubocop:disable Lint/RescueException\n        # :nocov:\n        if SyntaxError.instance_methods.include?(:detailed_message)\n          def exception_message_string(exception)\n            case exception\n            when SyntaxError then exception.detailed_message.to_s\n            else\n              exception.message.to_s\n            end\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        else\n          def exception_message_string(exception)\n            exception.message.to_s\n          rescue Exception => other\n            \"A #{exception.class} for which `exception.message.to_s` raises #{other.class}.\"\n          end\n        end\n        # :nocov:\n        # rubocop:enable Lint/RescueException\n\n        def exception_lines\n          @exception_lines ||= begin\n            lines = []\n            lines << \"#{exception_class_name}:\" unless exception_class_name =~ /RSpec/\n            encoded_string(exception_message_string(exception)).split(\"\\n\").each do |line|\n              lines << (line.empty? ? line : \"  #{line}\")\n            end\n            lines\n          end\n        end\n\n        def extra_failure_lines\n          @extra_failure_lines ||= begin\n            lines = Array(example.metadata[:extra_failure_lines])\n            unless lines.empty?\n              lines.unshift('') unless lines.first == ''\n              lines.push('') unless lines.last == ''\n            end\n            lines\n          end\n        end\n\n        def add_shared_group_lines(lines, colorizer)\n          return lines if @skip_shared_group_trace\n\n          example.metadata[:shared_group_inclusion_backtrace].each do |frame|\n            lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)\n          end\n\n          lines\n        end\n\n        def read_failed_lines\n          matching_line = find_failed_line\n          unless matching_line\n            return [\"Unable to find matching line from backtrace\"]\n          end\n\n          file_and_line_number = matching_line.match(/(.+?):(\\d+)(|:\\d+)/)\n\n          unless file_and_line_number\n            return [\"Unable to infer file and line number from backtrace\"]\n          end\n\n          file_path, line_number = file_and_line_number[1..2]\n          max_line_count = RSpec.configuration.max_displayed_failure_line_count\n          lines = SnippetExtractor.extract_expression_lines_at(file_path, line_number.to_i, max_line_count)\n          RSpec.world.syntax_highlighter.highlight(lines)\n        rescue SnippetExtractor::NoSuchFileError\n          [\"Unable to find #{file_path} to read failed line\"]\n        rescue SnippetExtractor::NoSuchLineError\n          [\"Unable to find matching line in #{file_path}\"]\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          [\"Unable to read failed line\"]\n          # :nocov:\n        end\n\n        def find_failed_line\n          line_regex = RSpec.configuration.in_project_source_dir_regex\n          loaded_spec_files = RSpec.configuration.loaded_spec_files\n\n          exception_backtrace.reject! do |line|\n            line.start_with?(\"<internal:\")\n          end\n\n          exception_backtrace.find do |line|\n            next unless (line_path = line[/(.+?):(\\d+)(|:\\d+)/, 1])\n            path = File.expand_path(line_path)\n            loaded_spec_files.include?(path) || path =~ line_regex\n          end || exception_backtrace.first\n        end\n\n        def formatted_message_and_backtrace(colorizer)\n          lines = colorized_message_lines(colorizer) + colorized_formatted_backtrace(colorizer)\n          encoding = encoding_of(\"\")\n          lines.map do |line|\n            RSpec::Support::EncodedString.new(line, encoding)\n          end\n        end\n\n        if  String.method_defined?(:encoding)\n          def encoded_description(description)\n            return if description.nil?\n            encoded_string(description)\n          end\n        else # for 1.8.7\n          # :nocov:\n          def encoded_description(description)\n            description\n          end\n          # :nocov:\n        end\n\n        def exception_backtrace\n          exception.backtrace || []\n        end\n\n        # @private\n        # Configuring the `ExceptionPresenter` with the right set of options to handle\n        # pending vs failed vs skipped and aggregated (or not) failures is not simple.\n        # This class takes care of building an appropriate `ExceptionPresenter` for the\n        # provided example.\n        class Factory\n          def build\n            ExceptionPresenter.new(@exception, @example, options)\n          end\n\n        private\n\n          def initialize(example)\n            @example          = example\n            @execution_result = example.execution_result\n            @exception        = if @execution_result.status == :pending\n                                  @execution_result.pending_exception\n                                else\n                                  @execution_result.exception\n                                end\n          end\n\n          def options\n            with_multiple_error_options_as_needed(@exception, pending_options || {})\n          end\n\n          def pending_options\n            if @execution_result.pending_fixed?\n              {\n                :description   => \"#{@example.full_description} FIXED\",\n                :message_color => RSpec.configuration.fixed_color,\n                :failure_lines => [\n                  \"Expected pending '#{@execution_result.pending_message}' to fail. No error was raised.\"\n                ]\n              }\n            elsif @execution_result.status == :pending\n              options = {\n                :message_color    => RSpec.configuration.pending_color,\n                :detail_formatter => PENDING_DETAIL_FORMATTER\n              }\n              if RSpec.configuration.pending_failure_output == :no_backtrace\n                options[:backtrace_formatter] = EmptyBacktraceFormatter\n              end\n              options\n            end\n          end\n\n          def with_multiple_error_options_as_needed(exception, options)\n            return options unless multiple_exceptions_error?(exception)\n\n            options = options.merge(\n              :failure_lines          => [],\n              :extra_detail_formatter => sub_failure_list_formatter(exception, options[:message_color]),\n              :detail_formatter       => multiple_exception_summarizer(exception,\n                                                                       options[:detail_formatter],\n                                                                       options[:message_color])\n            )\n\n            return options unless exception.aggregation_metadata[:hide_backtrace]\n            options[:backtrace_formatter] = EmptyBacktraceFormatter\n            options\n          end\n\n          def multiple_exceptions_error?(exception)\n            MultipleExceptionError::InterfaceTag === exception\n          end\n\n          def multiple_exception_summarizer(exception, prior_detail_formatter, color)\n            lambda do |example, colorizer|\n              summary = if exception.aggregation_metadata[:hide_backtrace]\n                          # Since the backtrace is hidden, the subfailures will come\n                          # immediately after this, and using `:` will read well.\n                          \"Got #{exception.exception_count_description}:\"\n                        else\n                          # The backtrace comes after this, so using a `:` doesn't make sense\n                          # since the failures may be many lines below.\n                          \"#{exception.summary}.\"\n                        end\n\n              summary = colorizer.wrap(summary, color || RSpec.configuration.failure_color)\n              return summary unless prior_detail_formatter\n              [\n                prior_detail_formatter.call(example, colorizer),\n                summary\n              ]\n            end\n          end\n\n          def sub_failure_list_formatter(exception, message_color)\n            common_backtrace_truncater = CommonBacktraceTruncater.new(exception)\n\n            lambda do |failure_number, colorizer|\n              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|\n                options = with_multiple_error_options_as_needed(\n                  failure,\n                  :description             => nil,\n                  :indentation             => 0,\n                  :message_color           => message_color || RSpec.configuration.failure_color,\n                  :skip_shared_group_trace => true\n                )\n\n                failure   = common_backtrace_truncater.with_truncated_backtrace(failure)\n                presenter = ExceptionPresenter.new(failure, @example, options)\n                presenter.fully_formatted_lines(\n                  \"#{failure_number ? \"#{failure_number}.\" : ''}#{index + 1}\",\n                  colorizer\n                )\n              end\n            end\n          end\n\n          # @private\n          # Used to prevent a confusing backtrace from showing up from the `aggregate_failures`\n          # block declared for `:aggregate_failures` metadata.\n          module EmptyBacktraceFormatter\n            def self.format_backtrace(*)\n              []\n            end\n          end\n\n          # @private\n          class CommonBacktraceTruncater\n            def initialize(parent)\n              @parent = parent\n            end\n\n            def with_truncated_backtrace(child)\n              child_bt  = child.backtrace\n              parent_bt = @parent.backtrace\n              return child if child_bt.nil? || child_bt.empty? || parent_bt.nil?\n\n              index_before_first_common_frame = -1.downto(-child_bt.size).find do |index|\n                parent_bt[index] != child_bt[index]\n              end\n\n              return child if index_before_first_common_frame.nil?\n              return child if index_before_first_common_frame == -1\n\n              child = child.dup\n              child.set_backtrace(child_bt[0..index_before_first_common_frame])\n              child\n            end\n          end\n        end\n\n        # @private\n        PENDING_DETAIL_FORMATTER = Proc.new do |example, colorizer|\n          colorizer.wrap(\"# #{example.execution_result.pending_message}\", :detail)\n        end\n      end\n    end\n\n    # Provides a single exception instance that provides access to\n    # multiple sub-exceptions. This is used in situations where a single\n    # individual spec has multiple exceptions, such as one in the `it` block\n    # and one in an `after` block.\n    class MultipleExceptionError < StandardError\n      # @private\n      # Used so there is a common module in the ancestor chain of this class\n      # and `RSpec::Expectations::MultipleExpectationsNotMetError`, which allows\n      # code to detect exceptions that are instances of either, without first\n      # checking to see if rspec-expectations is loaded.\n      module InterfaceTag\n        # Appends the provided exception to the list.\n        # @param exception [Exception] Exception to append to the list.\n        # @private\n        def add(exception)\n          # `PendingExampleFixedError` can be assigned to an example that initially has no\n          # failures, but when the `aggregate_failures` around hook completes, it notifies of\n          # a failure. If we do not ignore `PendingExampleFixedError` it would be surfaced to\n          # the user as part of a multiple exception error, which is undesirable. While it's\n          # pretty weird we handle this here, it's the best solution I've been able to come\n          # up with, and `PendingExampleFixedError` always represents the _lack_ of any exception\n          # so clearly when we are transitioning to a `MultipleExceptionError`, it makes sense to\n          # ignore it.\n          return if Pending::PendingExampleFixedError === exception\n\n          return if exception == self\n\n          all_exceptions << exception\n\n          if exception.class.name =~ /RSpec/\n            failures << exception\n          else\n            other_errors << exception\n          end\n        end\n\n        # Provides a way to force `ex` to be something that satisfies the multiple\n        # exception error interface. If it already satisfies it, it will be returned;\n        # otherwise it will wrap it in a `MultipleExceptionError`.\n        # @private\n        def self.for(ex)\n          return ex if self === ex\n          MultipleExceptionError.new(ex)\n        end\n      end\n\n      include InterfaceTag\n\n      # @return [Array<Exception>] The list of failures.\n      attr_reader :failures\n\n      # @return [Array<Exception>] The list of other errors.\n      attr_reader :other_errors\n\n      # @return [Array<Exception>] The list of failures and other exceptions, combined.\n      attr_reader :all_exceptions\n\n      # @return [Hash] Metadata used by RSpec for formatting purposes.\n      attr_reader :aggregation_metadata\n\n      # @return [nil] Provided only for interface compatibility with\n      #   `RSpec::Expectations::MultipleExpectationsNotMetError`.\n      attr_reader :aggregation_block_label\n\n      # @param exceptions [Array<Exception>] The initial list of exceptions.\n      def initialize(*exceptions)\n        super()\n\n        @failures                = []\n        @other_errors            = []\n        @all_exceptions          = []\n        @aggregation_metadata    = { :hide_backtrace => true }\n        @aggregation_block_label = nil\n\n        exceptions.each { |e| add e }\n      end\n\n      # @return [String] Combines all the exception messages into a single string.\n      # @note RSpec does not actually use this -- instead it formats each exception\n      #   individually.\n      def message\n        all_exceptions.map(&:message).join(\"\\n\\n\")\n      end\n\n      # @return [String] A summary of the failure, including the block label and a count of failures.\n      def summary\n        \"Got #{exception_count_description}\"\n      end\n\n      # return [String] A description of the failure/error counts.\n      def exception_count_description\n        failure_count = Formatters::Helpers.pluralize(failures.size, \"failure\")\n        return failure_count if other_errors.empty?\n        error_count = Formatters::Helpers.pluralize(other_errors.size, \"other error\")\n        \"#{failure_count} and #{error_count}\"\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "add", "signature": "def add(exception)", "start_line": 473, "end_line": 493}, "metadata": {"module": "RSpec", "class_name": "MultipleExceptionError", "class_signature": "class MultipleExceptionError < < StandardError"}, "task_id": 339}
{"function_name": "format_duration", "file_path": "rspec-core/lib/rspec/core/formatters/helpers.rb", "focal_code": "def self.format_duration(duration)\n          precision = case\n                      when duration < 1 then    SUB_SECOND_PRECISION\n                      when duration < 120 then  DEFAULT_PRECISION\n                      when duration < 300 then  1\n                      else                  0\n                      end\n\n          if duration > 60\n            minutes = (duration.round / 60).to_i\n            seconds = (duration - minutes * 60)\n\n            \"#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}\"\n          else\n            pluralize(format_seconds(duration, precision), 'second')\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # Formatters helpers.\n      module Helpers\n        # @private\n        SUB_SECOND_PRECISION = 5\n\n        # @private\n        DEFAULT_PRECISION = 2\n\n        # @api private\n        #\n        # Formats seconds into a human-readable string.\n        #\n        # @param duration [Float, Fixnum] in seconds\n        # @return [String] human-readable time\n        #\n        # @example\n        #    format_duration(1) #=>  \"1 minute 1 second\"\n        #    format_duration(135.14) #=> \"2 minutes 15.14 seconds\"\n        def self.format_duration(duration)\n          precision = case\n                      when duration < 1 then    SUB_SECOND_PRECISION\n                      when duration < 120 then  DEFAULT_PRECISION\n                      when duration < 300 then  1\n                      else                  0\n                      end\n\n          if duration > 60\n            minutes = (duration.round / 60).to_i\n            seconds = (duration - minutes * 60)\n\n            \"#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}\"\n          else\n            pluralize(format_seconds(duration, precision), 'second')\n          end\n        end\n\n        # @api private\n        #\n        # Formats seconds to have 5 digits of precision with trailing zeros\n        # removed if the number is less than 1 or with 2 digits of precision if\n        # the number is greater than zero.\n        #\n        # @param float [Float]\n        # @return [String] formatted float\n        #\n        # @example\n        #    format_seconds(0.000006) #=> \"0.00001\"\n        #    format_seconds(0.020000) #=> \"0.02\"\n        #    format_seconds(1.00000000001) #=> \"1\"\n        #\n        # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and\n        # {Helpers::DEFAULT_PRECISION}.\n        #\n        # @see #strip_trailing_zeroes\n        def self.format_seconds(float, precision=nil)\n          return '0' if float < 0\n          precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION\n          formatted = \"%.#{precision}f\" % float\n          strip_trailing_zeroes(formatted)\n        end\n\n        # @api private\n        #\n        # Remove trailing zeros from a string.\n        #\n        # Only remove trailing zeros after a decimal place.\n        # see: http://rubular.com/r/ojtTydOgpn\n        #\n        # @param string [String] string with trailing zeros\n        # @return [String] string with trailing zeros removed\n        def self.strip_trailing_zeroes(string)\n          string.sub(/(?:(\\..*[^0])0+|\\.0+)$/, '\\1')\n        end\n        private_class_method :strip_trailing_zeroes\n\n        # @api private\n        #\n        # Pluralize a word based on a count.\n        #\n        # @param count [Fixnum] number of objects\n        # @param string [String] word to be pluralized\n        # @return [String] pluralized word\n        def self.pluralize(count, string)\n          pluralized_string = if count.to_f == 1\n                                string\n                              elsif string.end_with?('s') # e.g. \"process\"\n                                \"#{string}es\" # e.g. \"processes\"\n                              else\n                                \"#{string}s\"\n                              end\n\n          \"#{count} #{pluralized_string}\"\n        end\n\n        # @api private\n        # Given a list of example ids, organizes them into a compact, ordered list.\n        def self.organize_ids(ids)\n          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|\n            file, id = Example.parse_id(id)\n            hash[file] << id\n            hash\n          end\n\n          grouped.sort_by(&:first).map do |file, grouped_ids|\n            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }\n            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))\n            ShellEscape.conditionally_quote(id)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "format_duration", "signature": "def self.format_duration(duration)", "start_line": 24, "end_line": 40}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 340}
{"function_name": "pluralize", "file_path": "rspec-core/lib/rspec/core/formatters/helpers.rb", "focal_code": "def self.pluralize(count, string)\n          pluralized_string = if count.to_f == 1\n                                string\n                              elsif string.end_with?('s') # e.g. \"process\"\n                                \"#{string}es\" # e.g. \"processes\"\n                              else\n                                \"#{string}s\"\n                              end\n\n          \"#{count} #{pluralized_string}\"\n        end", "file_content": "RSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # Formatters helpers.\n      module Helpers\n        # @private\n        SUB_SECOND_PRECISION = 5\n\n        # @private\n        DEFAULT_PRECISION = 2\n\n        # @api private\n        #\n        # Formats seconds into a human-readable string.\n        #\n        # @param duration [Float, Fixnum] in seconds\n        # @return [String] human-readable time\n        #\n        # @example\n        #    format_duration(1) #=>  \"1 minute 1 second\"\n        #    format_duration(135.14) #=> \"2 minutes 15.14 seconds\"\n        def self.format_duration(duration)\n          precision = case\n                      when duration < 1 then    SUB_SECOND_PRECISION\n                      when duration < 120 then  DEFAULT_PRECISION\n                      when duration < 300 then  1\n                      else                  0\n                      end\n\n          if duration > 60\n            minutes = (duration.round / 60).to_i\n            seconds = (duration - minutes * 60)\n\n            \"#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}\"\n          else\n            pluralize(format_seconds(duration, precision), 'second')\n          end\n        end\n\n        # @api private\n        #\n        # Formats seconds to have 5 digits of precision with trailing zeros\n        # removed if the number is less than 1 or with 2 digits of precision if\n        # the number is greater than zero.\n        #\n        # @param float [Float]\n        # @return [String] formatted float\n        #\n        # @example\n        #    format_seconds(0.000006) #=> \"0.00001\"\n        #    format_seconds(0.020000) #=> \"0.02\"\n        #    format_seconds(1.00000000001) #=> \"1\"\n        #\n        # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and\n        # {Helpers::DEFAULT_PRECISION}.\n        #\n        # @see #strip_trailing_zeroes\n        def self.format_seconds(float, precision=nil)\n          return '0' if float < 0\n          precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION\n          formatted = \"%.#{precision}f\" % float\n          strip_trailing_zeroes(formatted)\n        end\n\n        # @api private\n        #\n        # Remove trailing zeros from a string.\n        #\n        # Only remove trailing zeros after a decimal place.\n        # see: http://rubular.com/r/ojtTydOgpn\n        #\n        # @param string [String] string with trailing zeros\n        # @return [String] string with trailing zeros removed\n        def self.strip_trailing_zeroes(string)\n          string.sub(/(?:(\\..*[^0])0+|\\.0+)$/, '\\1')\n        end\n        private_class_method :strip_trailing_zeroes\n\n        # @api private\n        #\n        # Pluralize a word based on a count.\n        #\n        # @param count [Fixnum] number of objects\n        # @param string [String] word to be pluralized\n        # @return [String] pluralized word\n        def self.pluralize(count, string)\n          pluralized_string = if count.to_f == 1\n                                string\n                              elsif string.end_with?('s') # e.g. \"process\"\n                                \"#{string}es\" # e.g. \"processes\"\n                              else\n                                \"#{string}s\"\n                              end\n\n          \"#{count} #{pluralized_string}\"\n        end\n\n        # @api private\n        # Given a list of example ids, organizes them into a compact, ordered list.\n        def self.organize_ids(ids)\n          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|\n            file, id = Example.parse_id(id)\n            hash[file] << id\n            hash\n          end\n\n          grouped.sort_by(&:first).map do |file, grouped_ids|\n            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }\n            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))\n            ShellEscape.conditionally_quote(id)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "pluralize", "signature": "def self.pluralize(count, string)", "start_line": 88, "end_line": 98}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 341}
{"function_name": "organize_ids", "file_path": "rspec-core/lib/rspec/core/formatters/helpers.rb", "focal_code": "def self.organize_ids(ids)\n          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|\n            file, id = Example.parse_id(id)\n            hash[file] << id\n            hash\n          end\n\n          grouped.sort_by(&:first).map do |file, grouped_ids|\n            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }\n            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))\n            ShellEscape.conditionally_quote(id)\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"shell_escape\"\n\nmodule RSpec\n  module Core\n    module Formatters\n      # Formatters helpers.\n      module Helpers\n        # @private\n        SUB_SECOND_PRECISION = 5\n\n        # @private\n        DEFAULT_PRECISION = 2\n\n        # @api private\n        #\n        # Formats seconds into a human-readable string.\n        #\n        # @param duration [Float, Fixnum] in seconds\n        # @return [String] human-readable time\n        #\n        # @example\n        #    format_duration(1) #=>  \"1 minute 1 second\"\n        #    format_duration(135.14) #=> \"2 minutes 15.14 seconds\"\n        def self.format_duration(duration)\n          precision = case\n                      when duration < 1 then    SUB_SECOND_PRECISION\n                      when duration < 120 then  DEFAULT_PRECISION\n                      when duration < 300 then  1\n                      else                  0\n                      end\n\n          if duration > 60\n            minutes = (duration.round / 60).to_i\n            seconds = (duration - minutes * 60)\n\n            \"#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}\"\n          else\n            pluralize(format_seconds(duration, precision), 'second')\n          end\n        end\n\n        # @api private\n        #\n        # Formats seconds to have 5 digits of precision with trailing zeros\n        # removed if the number is less than 1 or with 2 digits of precision if\n        # the number is greater than zero.\n        #\n        # @param float [Float]\n        # @return [String] formatted float\n        #\n        # @example\n        #    format_seconds(0.000006) #=> \"0.00001\"\n        #    format_seconds(0.020000) #=> \"0.02\"\n        #    format_seconds(1.00000000001) #=> \"1\"\n        #\n        # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and\n        # {Helpers::DEFAULT_PRECISION}.\n        #\n        # @see #strip_trailing_zeroes\n        def self.format_seconds(float, precision=nil)\n          return '0' if float < 0\n          precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION\n          formatted = \"%.#{precision}f\" % float\n          strip_trailing_zeroes(formatted)\n        end\n\n        # @api private\n        #\n        # Remove trailing zeros from a string.\n        #\n        # Only remove trailing zeros after a decimal place.\n        # see: http://rubular.com/r/ojtTydOgpn\n        #\n        # @param string [String] string with trailing zeros\n        # @return [String] string with trailing zeros removed\n        def self.strip_trailing_zeroes(string)\n          string.sub(/(?:(\\..*[^0])0+|\\.0+)$/, '\\1')\n        end\n        private_class_method :strip_trailing_zeroes\n\n        # @api private\n        #\n        # Pluralize a word based on a count.\n        #\n        # @param count [Fixnum] number of objects\n        # @param string [String] word to be pluralized\n        # @return [String] pluralized word\n        def self.pluralize(count, string)\n          pluralized_string = if count.to_f == 1\n                                string\n                              elsif string.end_with?('s') # e.g. \"process\"\n                                \"#{string}es\" # e.g. \"processes\"\n                              else\n                                \"#{string}s\"\n                              end\n\n          \"#{count} #{pluralized_string}\"\n        end\n\n        # @api private\n        # Given a list of example ids, organizes them into a compact, ordered list.\n        def self.organize_ids(ids)\n          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|\n            file, id = Example.parse_id(id)\n            hash[file] << id\n            hash\n          end\n\n          grouped.sort_by(&:first).map do |file, grouped_ids|\n            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }\n            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))\n            ShellEscape.conditionally_quote(id)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "organize_ids", "signature": "def self.organize_ids(ids)", "start_line": 102, "end_line": 114}, "metadata": {"module": "RSpec", "class_name": "", "class_signature": ""}, "task_id": 342}
{"function_name": "print_summary", "file_path": "rspec-core/lib/rspec/core/formatters/html_printer.rb", "focal_code": "def print_summary(duration, example_count, failure_count, pending_count)\n          totals = String.new(\n            \"#{example_count} example#{'s' unless example_count == 1}, \"\n          )\n          totals << \"#{failure_count} failure#{'s' unless failure_count == 1}\"\n          totals << \", #{pending_count} pending\" if pending_count > 0\n\n          formatted_duration = \"%.5f\" % duration\n\n          @output.puts \"<script type=\\\"text/javascript\\\">\" \\\n            \"document.getElementById('duration').innerHTML = \\\"Finished in \" \\\n            \"<strong>#{formatted_duration} seconds</strong>\\\";</script>\"\n          @output.puts \"<script type=\\\"text/javascript\\\">\" \\\n            \"document.getElementById('totals').innerHTML = \\\"#{totals}\\\";</script>\"\n          @output.puts \"</div>\"\n          @output.puts \"</div>\"\n          @output.puts \"</body>\"\n          @output.puts \"</html>\"\n        end", "file_content": "require 'erb'\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class HtmlPrinter\n        include ERB::Util # For the #h method.\n        def initialize(output)\n          @output = output\n        end\n\n        def print_html_start\n          @output.puts HTML_HEADER\n          @output.puts REPORT_HEADER\n        end\n\n        def print_example_group_end\n          @output.puts \"  </dl>\"\n          @output.puts \"</div>\"\n        end\n\n        def print_example_group_start(group_id, description, number_of_parents)\n          @output.puts \"<div id=\\\"div_group_#{group_id}\\\" class=\\\"example_group passed\\\">\"\n          @output.puts \"  <dl #{indentation_style(number_of_parents)}>\"\n          @output.puts \"  <dt id=\\\"example_group_#{group_id}\\\" class=\\\"passed\\\">#{h(description)}</dt>\"\n        end\n\n        def print_example_passed(description, run_time)\n          formatted_run_time = \"%.5f\" % run_time\n          @output.puts \"    <dd class=\\\"example passed\\\">\" \\\n            \"<span class=\\\"passed_spec_name\\\">#{h(description)}</span>\" \\\n            \"<span class='duration'>#{formatted_run_time}s</span></dd>\"\n        end\n\n        def print_example_failed(pending_fixed, description, run_time, failure_id,\n                                 exception, extra_content)\n          formatted_run_time = \"%.5f\" % run_time\n\n          @output.puts \"    <dd class=\\\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\\\">\"\n          @output.puts \"      <span class=\\\"failed_spec_name\\\">#{h(description)}</span>\"\n          @output.puts \"      <span class=\\\"duration\\\">#{formatted_run_time}s</span>\"\n          @output.puts \"      <div class=\\\"failure\\\" id=\\\"failure_#{failure_id}\\\">\"\n          if exception\n            @output.puts \"        <div class=\\\"message\\\"><pre>#{h(exception[:message])}</pre></div>\"\n            @output.puts \"        <div class=\\\"backtrace\\\"><pre>#{h exception[:backtrace]}</pre></div>\"\n          end\n          @output.puts extra_content if extra_content\n          @output.puts \"      </div>\"\n          @output.puts \"    </dd>\"\n        end\n\n        def print_example_pending(description, pending_message)\n          @output.puts \"    <dd class=\\\"example not_implemented\\\">\" \\\n            \"<span class=\\\"not_implemented_spec_name\\\">#{h(description)} \" \\\n            \"(PENDING: #{h(pending_message)})</span></dd>\"\n        end\n\n        def print_summary(duration, example_count, failure_count, pending_count)\n          totals = String.new(\n            \"#{example_count} example#{'s' unless example_count == 1}, \"\n          )\n          totals << \"#{failure_count} failure#{'s' unless failure_count == 1}\"\n          totals << \", #{pending_count} pending\" if pending_count > 0\n\n          formatted_duration = \"%.5f\" % duration\n\n          @output.puts \"<script type=\\\"text/javascript\\\">\" \\\n            \"document.getElementById('duration').innerHTML = \\\"Finished in \" \\\n            \"<strong>#{formatted_duration} seconds</strong>\\\";</script>\"\n          @output.puts \"<script type=\\\"text/javascript\\\">\" \\\n            \"document.getElementById('totals').innerHTML = \\\"#{totals}\\\";</script>\"\n          @output.puts \"</div>\"\n          @output.puts \"</div>\"\n          @output.puts \"</body>\"\n          @output.puts \"</html>\"\n        end\n\n        def flush\n          @output.flush\n        end\n\n        def move_progress(percent_done)\n          @output.puts \"    <script type=\\\"text/javascript\\\">moveProgressBar('#{percent_done}');</script>\"\n          @output.flush\n        end\n\n        def make_header_red\n          @output.puts \"    <script type=\\\"text/javascript\\\">makeRed('rspec-header');</script>\"\n        end\n\n        def make_header_yellow\n          @output.puts \"    <script type=\\\"text/javascript\\\">makeYellow('rspec-header');</script>\"\n        end\n\n        def make_example_group_header_red(group_id)\n          @output.puts \"    <script type=\\\"text/javascript\\\">\" \\\n                       \"makeRed('div_group_#{group_id}');</script>\"\n          @output.puts \"    <script type=\\\"text/javascript\\\">\" \\\n                       \"makeRed('example_group_#{group_id}');</script>\"\n        end\n\n        def make_example_group_header_yellow(group_id)\n          @output.puts \"    <script type=\\\"text/javascript\\\">\" \\\n                       \"makeYellow('div_group_#{group_id}');</script>\"\n          @output.puts \"    <script type=\\\"text/javascript\\\">\" \\\n                       \"makeYellow('example_group_#{group_id}');</script>\"\n        end\n\n      private\n\n        def indentation_style(number_of_parents)\n          \"style=\\\"margin-left: #{(number_of_parents - 1) * 15}px;\\\"\"\n        end\n\n        REPORT_HEADER = <<-EOF\n<div class=\"rspec-report\">\n\n<div id=\"rspec-header\">\n  <div id=\"label\">\n    <h1>RSpec Code Examples</h1>\n  </div>\n\n  <div id=\"display-filters\">\n    <input id=\"passed_checkbox\"  name=\"passed_checkbox\"  type=\"checkbox\" checked=\"checked\" onchange=\"apply_filters()\" value=\"1\" /> <label for=\"passed_checkbox\">Passed</label>\n    <input id=\"failed_checkbox\"  name=\"failed_checkbox\"  type=\"checkbox\" checked=\"checked\" onchange=\"apply_filters()\" value=\"2\" /> <label for=\"failed_checkbox\">Failed</label>\n    <input id=\"pending_checkbox\" name=\"pending_checkbox\" type=\"checkbox\" checked=\"checked\" onchange=\"apply_filters()\" value=\"3\" /> <label for=\"pending_checkbox\">Pending</label>\n  </div>\n\n  <div id=\"summary\">\n    <p id=\"totals\">&#160;</p>\n    <p id=\"duration\">&#160;</p>\n  </div>\n</div>\n\n\n<div class=\"results\">\nEOF\n\n        GLOBAL_SCRIPTS = <<-EOF\n\nfunction addClass(element_id, classname) {\n  document.getElementById(element_id).className += (\" \" + classname);\n}\n\nfunction removeClass(element_id, classname) {\n  var elem = document.getElementById(element_id);\n  var classlist = elem.className.replace(classname,'');\n  elem.className = classlist;\n}\n\nfunction moveProgressBar(percentDone) {\n  document.getElementById(\"rspec-header\").style.width = percentDone +\"%\";\n}\n\nfunction makeRed(element_id) {\n  removeClass(element_id, 'passed');\n  removeClass(element_id, 'not_implemented');\n  addClass(element_id,'failed');\n}\n\nfunction makeYellow(element_id) {\n  var elem = document.getElementById(element_id);\n  if (elem.className.indexOf(\"failed\") == -1) {  // class doesn't includes failed\n    if (elem.className.indexOf(\"not_implemented\") == -1) { // class doesn't include not_implemented\n      removeClass(element_id, 'passed');\n      addClass(element_id,'not_implemented');\n    }\n  }\n}\n\nfunction apply_filters() {\n  var passed_filter = document.getElementById('passed_checkbox').checked;\n  var failed_filter = document.getElementById('failed_checkbox').checked;\n  var pending_filter = document.getElementById('pending_checkbox').checked;\n\n  assign_display_style(\"example passed\", passed_filter);\n  assign_display_style(\"example failed\", failed_filter);\n  assign_display_style(\"example not_implemented\", pending_filter);\n\n  assign_display_style_for_group(\"example_group passed\", passed_filter);\n  assign_display_style_for_group(\"example_group not_implemented\", pending_filter, pending_filter || passed_filter);\n  assign_display_style_for_group(\"example_group failed\", failed_filter, failed_filter || pending_filter || passed_filter);\n}\n\nfunction get_display_style(display_flag) {\n  var style_mode = 'none';\n  if (display_flag == true) {\n    style_mode = 'block';\n  }\n  return style_mode;\n}\n\nfunction assign_display_style(classname, display_flag) {\n  var style_mode = get_display_style(display_flag);\n  var elems = document.getElementsByClassName(classname)\n  for (var i=0; i<elems.length;i++) {\n    elems[i].style.display = style_mode;\n  }\n}\n\nfunction assign_display_style_for_group(classname, display_flag, subgroup_flag) {\n  var display_style_mode = get_display_style(display_flag);\n  var subgroup_style_mode = get_display_style(subgroup_flag);\n  var elems = document.getElementsByClassName(classname)\n  for (var i=0; i<elems.length;i++) {\n    var style_mode = display_style_mode;\n    if ((display_flag != subgroup_flag) && (elems[i].getElementsByTagName('dt')[0].innerHTML.indexOf(\", \") != -1)) {\n      elems[i].style.display = subgroup_style_mode;\n    } else {\n      elems[i].style.display = display_style_mode;\n    }\n  }\n}\nEOF\n        # rubocop:enable Layout/LineLength\n\n        GLOBAL_STYLES = <<-EOF\n#rspec-header {\n  background: #65C400; color: #fff; height: 4em;\n}\n\n.rspec-report h1 {\n  margin: 0px 10px 0px 10px;\n  padding: 10px;\n  font-family: \"Lucida Grande\", Helvetica, sans-serif;\n  font-size: 1.8em;\n  position: absolute;\n}\n\n#label {\n  float:left;\n}\n\n#display-filters {\n  float:left;\n  padding: 28px 0 0 40%;\n  font-family: \"Lucida Grande\", Helvetica, sans-serif;\n}\n\n#summary {\n  float:right;\n  padding: 5px 10px;\n  font-family: \"Lucida Grande\", Helvetica, sans-serif;\n  text-align: right;\n}\n\n#summary p {\n  margin: 0 0 0 2px;\n}\n\n#summary #totals {\n  font-size: 1.2em;\n}\n\n.example_group {\n  margin: 0 10px 5px;\n  background: #fff;\n}\n\ndl {\n  margin: 0; padding: 0 0 5px;\n  font: normal 11px \"Lucida Grande\", Helvetica, sans-serif;\n}\n\ndt {\n  padding: 3px;\n  background: #65C400;\n  color: #fff;\n  font-weight: bold;\n}\n\ndd {\n  margin: 5px 0 5px 5px;\n  padding: 3px 3px 3px 18px;\n}\n\ndd .duration {\n  padding-left: 5px;\n  text-align: right;\n  right: 0px;\n  float:right;\n}\n\ndd.example.passed {\n  border-left: 5px solid #65C400;\n  border-bottom: 1px solid #65C400;\n  background: #DBFFB4; color: #3D7700;\n}\n\ndd.example.not_implemented {\n  border-left: 5px solid #FAF834;\n  border-bottom: 1px solid #FAF834;\n  background: #FCFB98; color: #131313;\n}\n\ndd.example.pending_fixed {\n  border-left: 5px solid #0000C2;\n  border-bottom: 1px solid #0000C2;\n  color: #0000C2; background: #D3FBFF;\n}\n\ndd.example.failed {\n  border-left: 5px solid #C20000;\n  border-bottom: 1px solid #C20000;\n  color: #C20000; background: #FFFBD3;\n}\n\n\ndt.not_implemented {\n  color: #000000; background: #FAF834;\n}\n\ndt.pending_fixed {\n  color: #FFFFFF; background: #C40D0D;\n}\n\ndt.failed {\n  color: #FFFFFF; background: #C40D0D;\n}\n\n\n#rspec-header.not_implemented {\n  color: #000000; background: #FAF834;\n}\n\n#rspec-header.pending_fixed {\n  color: #FFFFFF; background: #C40D0D;\n}\n\n#rspec-header.failed {\n  color: #FFFFFF; background: #C40D0D;\n}\n\n\n.backtrace {\n  color: #000;\n  font-size: 12px;\n}\n\na {\n  color: #BE5C00;\n}\n\n/* Ruby code, style similar to vibrant ink */\n.ruby {\n  font-size: 12px;\n  font-family: monospace;\n  color: white;\n  background-color: black;\n  padding: 0.1em 0 0.2em 0;\n}\n\n.ruby .keyword { color: #FF6600; }\n.ruby .constant { color: #339999; }\n.ruby .attribute { color: white; }\n.ruby .global { color: white; }\n.ruby .module { color: white; }\n.ruby .class { color: white; }\n.ruby .string { color: #66FF00; }\n.ruby .ident { color: white; }\n.ruby .method { color: #FFCC00; }\n.ruby .number { color: white; }\n.ruby .char { color: white; }\n.ruby .comment { color: #9933CC; }\n.ruby .symbol { color: white; }\n.ruby .regex { color: #44B4CC; }\n.ruby .punct { color: white; }\n.ruby .escape { color: white; }\n.ruby .interp { color: white; }\n.ruby .expr { color: white; }\n\n.ruby .offending { background-color: gray; }\n.ruby .linenum {\n  width: 75px;\n  padding: 0.1em 1em 0.2em 0;\n  color: #000000;\n  background-color: #FFFBD3;\n}\nEOF\n\n        HTML_HEADER = <<-EOF\n<!DOCTYPE html>\n<html lang='en'>\n<head>\n  <title>RSpec results</title>\n  <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n  <meta http-equiv=\"Expires\" content=\"-1\" />\n  <meta http-equiv=\"Pragma\" content=\"no-cache\" />\n  <style type=\"text/css\">\n  body {\n    margin: 0;\n    padding: 0;\n    background: #fff;\n    font-size: 80%;\n  }\n  </style>\n  <script type=\"text/javascript\">\n    // <![CDATA[\n#{GLOBAL_SCRIPTS}\n    // ]]>\n  </script>\n  <style type=\"text/css\">\n#{GLOBAL_STYLES}\n  </style>\n</head>\n<body>\nEOF\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "print_summary", "signature": "def print_summary(duration, example_count, failure_count, pending_count)", "start_line": 59, "end_line": 77}, "metadata": {"module": "RSpec", "class_name": "HtmlPrinter", "class_signature": "class HtmlPrinter"}, "task_id": 343}
{"function_name": "lines_around", "file_path": "rspec-core/lib/rspec/core/formatters/html_snippet_extractor.rb", "focal_code": "def lines_around(file, line)\n          if File.file?(file)\n            lines = File.read(file).split(\"\\n\")\n            min = [0, line - 3].max\n            max = [line + 1, lines.length - 1].min\n            selected_lines = []\n            selected_lines.join(\"\\n\")\n            lines[min..max].join(\"\\n\")\n          else\n            \"# Couldn't get snippet for #{file}\"\n          end\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          \"# Couldn't get snippet for #{file}\"\n          # :nocov:\n        end", "file_content": "module RSpec\n  module Core\n    module Formatters\n      # @api private\n      #\n      # Extracts code snippets by looking at the backtrace of the passed error\n      # and applies synax highlighting and line numbers using html.\n      class HtmlSnippetExtractor\n        # @private\n        module NullConverter\n          def self.convert(code)\n            %Q(#{code}\\n<span class=\"comment\"># Install the coderay gem to get syntax highlighting</span>)\n          end\n        end\n\n        # @private\n        module CoderayConverter\n          def self.convert(code)\n            CodeRay.scan(code, :ruby).html(:line_numbers => false)\n          end\n        end\n\n        # rubocop:disable Style/ClassVars\n        # @private\n        @@converter = NullConverter\n\n        begin\n          require 'coderay'\n          RSpec::Support.require_rspec_core 'formatters/syntax_highlighter'\n          RSpec::Core::Formatters::SyntaxHighlighter.attempt_to_add_rspec_terms_to_coderay_keywords\n          @@converter = CoderayConverter\n          # rubocop:disable Lint/HandleExceptions\n        rescue LoadError\n          # it'll fall back to the NullConverter assigned above\n          # rubocop:enable Lint/HandleExceptions\n        end\n\n        # rubocop:enable Style/ClassVars\n\n        # @api private\n        #\n        # Extract lines of code corresponding to  a backtrace.\n        #\n        # @param backtrace [String] the backtrace from a test failure\n        # @return [String] highlighted code snippet indicating where the test\n        #   failure occurred\n        #\n        # @see #post_process\n        def snippet(backtrace)\n          raw_code, line = snippet_for(backtrace[0])\n          highlighted = @@converter.convert(raw_code)\n          post_process(highlighted, line)\n        end\n        # rubocop:enable Style/ClassVars\n\n        # @api private\n        #\n        # Create a snippet from a line of code.\n        #\n        # @param error_line [String] file name with line number (i.e.\n        #   'foo_spec.rb:12')\n        # @return [String] lines around the target line within the file\n        #\n        # @see #lines_around\n        def snippet_for(error_line)\n          if error_line =~ /(.*):(\\d+)/\n            file = Regexp.last_match[1]\n            line = Regexp.last_match[2].to_i\n            [lines_around(file, line), line]\n          else\n            [\"# Couldn't get snippet for #{error_line}\", 1]\n          end\n        end\n\n        # @api private\n        #\n        # Extract lines of code centered around a particular line within a\n        # source file.\n        #\n        # @param file [String] filename\n        # @param line [Fixnum] line number\n        # @return [String] lines around the target line within the file (2 above\n        #   and 1 below).\n        def lines_around(file, line)\n          if File.file?(file)\n            lines = File.read(file).split(\"\\n\")\n            min = [0, line - 3].max\n            max = [line + 1, lines.length - 1].min\n            selected_lines = []\n            selected_lines.join(\"\\n\")\n            lines[min..max].join(\"\\n\")\n          else\n            \"# Couldn't get snippet for #{file}\"\n          end\n        rescue SecurityError\n          # :nocov: - SecurityError is no longer produced starting in ruby 2.7\n          \"# Couldn't get snippet for #{file}\"\n          # :nocov:\n        end\n\n        # @api private\n        #\n        # Adds line numbers to all lines and highlights the line where the\n        # failure occurred using html `span` tags.\n        #\n        # @param highlighted [String] syntax-highlighted snippet surrounding the\n        #   offending line of code\n        # @param offending_line [Fixnum] line where failure occurred\n        # @return [String] completed snippet\n        def post_process(highlighted, offending_line)\n          new_lines = []\n          highlighted.split(\"\\n\").each_with_index do |line, i|\n            new_line = \"<span class=\\\"linenum\\\">#{offending_line + i - 2}</span>#{line}\"\n            new_line = \"<span class=\\\"offending\\\">#{new_line}</span>\" if i == 2\n            new_lines << new_line\n          end\n          new_lines.join(\"\\n\")\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "lines_around", "signature": "def lines_around(file, line)", "start_line": 84, "end_line": 99}, "metadata": {"module": "RSpec", "class_name": "HtmlSnippetExtractor", "class_signature": "class HtmlSnippetExtractor"}, "task_id": 344}
{"function_name": "dump_summary", "file_path": "rspec-core/lib/rspec/core/formatters/json_formatter.rb", "focal_code": "def dump_summary(summary)\n          @output_hash[:summary] = {\n            :duration => summary.duration,\n            :example_count => summary.example_count,\n            :failure_count => summary.failure_count,\n            :pending_count => summary.pending_count,\n            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count\n          }\n          @output_hash[:summary_line] = summary.totals_line\n        end", "file_content": "RSpec::Support.require_rspec_core \"formatters/base_formatter\"\nrequire 'json'\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class JsonFormatter < BaseFormatter\n        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close\n\n        attr_reader :output_hash\n\n        def initialize(output)\n          super\n          @output_hash = {\n            :version => RSpec::Core::Version::STRING\n          }\n        end\n\n        def message(notification)\n          (@output_hash[:messages] ||= []) << notification.message\n        end\n\n        def dump_summary(summary)\n          @output_hash[:summary] = {\n            :duration => summary.duration,\n            :example_count => summary.example_count,\n            :failure_count => summary.failure_count,\n            :pending_count => summary.pending_count,\n            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count\n          }\n          @output_hash[:summary_line] = summary.totals_line\n        end\n\n        def stop(group_notification)\n          @output_hash[:examples] = group_notification.notifications.map do |notification|\n            format_example(notification.example).tap do |hash|\n              e = notification.example.exception\n\n              if e\n                hash[:exception] = {\n                  :class => e.class.name,\n                  :message => e.message,\n                  :backtrace => notification.formatted_backtrace,\n                }\n              end\n            end\n          end\n        end\n\n        def seed(notification)\n          return unless notification.seed_used?\n          @output_hash[:seed] = notification.seed\n        end\n\n        def close(_notification)\n          output.write @output_hash.to_json\n        end\n\n        def dump_profile(profile)\n          @output_hash[:profile] = {}\n          dump_profile_slowest_examples(profile)\n          dump_profile_slowest_example_groups(profile)\n        end\n\n        # @api private\n        def dump_profile_slowest_examples(profile)\n          @output_hash[:profile] = {}\n          @output_hash[:profile][:examples] = profile.slowest_examples.map do |example|\n            format_example(example).tap do |hash|\n              hash[:run_time] = example.execution_result.run_time\n            end\n          end\n          @output_hash[:profile][:slowest] = profile.slow_duration\n          @output_hash[:profile][:total] = profile.duration\n        end\n\n        # @api private\n        def dump_profile_slowest_example_groups(profile)\n          @output_hash[:profile] ||= {}\n          @output_hash[:profile][:groups] = profile.slowest_groups.map do |loc, hash|\n            hash.update(:location => loc)\n          end\n        end\n\n      private\n\n        def format_example(example)\n          {\n            :id => example.id,\n            :description => example.description,\n            :full_description => example.full_description,\n            :status => example.execution_result.status.to_s,\n            :file_path => example.metadata[:file_path],\n            :line_number  => example.metadata[:line_number],\n            :run_time => example.execution_result.run_time,\n            :pending_message => example.execution_result.pending_message,\n          }\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "dump_summary", "signature": "def dump_summary(summary)", "start_line": 24, "end_line": 33}, "metadata": {"module": "RSpec", "class_name": "JsonFormatter", "class_signature": "class JsonFormatter < < BaseFormatter"}, "task_id": 345}
{"function_name": "stop", "file_path": "rspec-core/lib/rspec/core/formatters/json_formatter.rb", "focal_code": "def stop(group_notification)\n          @output_hash[:examples] = group_notification.notifications.map do |notification|\n            format_example(notification.example).tap do |hash|\n              e = notification.example.exception\n\n              if e\n                hash[:exception] = {\n                  :class => e.class.name,\n                  :message => e.message,\n                  :backtrace => notification.formatted_backtrace,\n                }\n              end\n            end\n          end\n        end", "file_content": "RSpec::Support.require_rspec_core \"formatters/base_formatter\"\nrequire 'json'\n\nmodule RSpec\n  module Core\n    module Formatters\n      # @private\n      class JsonFormatter < BaseFormatter\n        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close\n\n        attr_reader :output_hash\n\n        def initialize(output)\n          super\n          @output_hash = {\n            :version => RSpec::Core::Version::STRING\n          }\n        end\n\n        def message(notification)\n          (@output_hash[:messages] ||= []) << notification.message\n        end\n\n        def dump_summary(summary)\n          @output_hash[:summary] = {\n            :duration => summary.duration,\n            :example_count => summary.example_count,\n            :failure_count => summary.failure_count,\n            :pending_count => summary.pending_count,\n            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count\n          }\n          @output_hash[:summary_line] = summary.totals_line\n        end\n\n        def stop(group_notification)\n          @output_hash[:examples] = group_notification.notifications.map do |notification|\n            format_example(notification.example).tap do |hash|\n              e = notification.example.exception\n\n              if e\n                hash[:exception] = {\n                  :class => e.class.name,\n                  :message => e.message,\n                  :backtrace => notification.formatted_backtrace,\n                }\n              end\n            end\n          end\n        end\n\n        def seed(notification)\n          return unless notification.seed_used?\n          @output_hash[:seed] = notification.seed\n        end\n\n        def close(_notification)\n          output.write @output_hash.to_json\n        end\n\n        def dump_profile(profile)\n          @output_hash[:profile] = {}\n          dump_profile_slowest_examples(profile)\n          dump_profile_slowest_example_groups(profile)\n        end\n\n        # @api private\n        def dump_profile_slowest_examples(profile)\n          @output_hash[:profile] = {}\n          @output_hash[:profile][:examples] = profile.slowest_examples.map do |example|\n            format_example(example).tap do |hash|\n              hash[:run_time] = example.execution_result.run_time\n            end\n          end\n          @output_hash[:profile][:slowest] = profile.slow_duration\n          @output_hash[:profile][:total] = profile.duration\n        end\n\n        # @api private\n        def dump_profile_slowest_example_groups(profile)\n          @output_hash[:profile] ||= {}\n          @output_hash[:profile][:groups] = profile.slowest_groups.map do |loc, hash|\n            hash.update(:location => loc)\n          end\n        end\n\n      private\n\n        def format_example(example)\n          {\n            :id => example.id,\n            :description => example.description,\n            :full_description => example.full_description,\n            :status => example.execution_result.status.to_s,\n            :file_path => example.metadata[:file_path],\n            :line_number  => example.metadata[:line_number],\n            :run_time => example.execution_result.run_time,\n            :pending_message => example.execution_result.pending_message,\n          }\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "stop", "signature": "def stop(group_notification)", "start_line": 35, "end_line": 49}, "metadata": {"module": "RSpec", "class_name": "JsonFormatter", "class_signature": "class JsonFormatter < < BaseFormatter"}, "task_id": 346}
{"function_name": "line_range_of_expression", "file_path": "rspec-core/lib/rspec/core/formatters/snippet_extractor.rb", "focal_code": "def line_range_of_expression\n            @line_range_of_expression ||= begin\n              line_range = line_range_of_location_nodes_in_expression\n              initial_unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              unclosed_tokens = initial_unclosed_tokens\n\n              until (initial_unclosed_tokens & unclosed_tokens).empty?\n                line_range = (line_range.begin)..(line_range.end + 1)\n                unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              end\n\n              line_range\n            end\n          end", "file_content": "module RSpec\n  module Core\n    module Formatters\n      # @private\n      class SnippetExtractor\n        NoSuchFileError = Class.new(StandardError)\n        NoSuchLineError = Class.new(StandardError)\n\n        def self.extract_line_at(file_path, line_number)\n          source = source_from_file(file_path)\n          line = source.lines[line_number - 1]\n          raise NoSuchLineError unless line\n          line\n        end\n\n        def self.source_from_file(path)\n          raise NoSuchFileError unless File.exist?(path)\n          RSpec.world.source_from_file(path)\n        end\n\n        if RSpec::Support::RubyFeatures.ripper_supported?\n          NoExpressionAtLineError = Class.new(StandardError)\n\n          attr_reader :source, :beginning_line_number, :max_line_count\n\n          def self.extract_expression_lines_at(file_path, beginning_line_number, max_line_count=nil)\n            if max_line_count == 1\n              [extract_line_at(file_path, beginning_line_number)]\n            else\n              source = source_from_file(file_path)\n              new(source, beginning_line_number, max_line_count).expression_lines\n            end\n          end\n\n          def initialize(source, beginning_line_number, max_line_count=nil)\n            @source = source\n            @beginning_line_number = beginning_line_number\n            @max_line_count = max_line_count\n          end\n\n          def expression_lines\n            line_range = line_range_of_expression\n\n            if max_line_count && line_range.count > max_line_count\n              line_range = (line_range.begin)..(line_range.begin + max_line_count - 1)\n            end\n\n            source.lines[(line_range.begin - 1)..(line_range.end - 1)]\n          rescue SyntaxError, NoExpressionAtLineError\n            [self.class.extract_line_at(source.path, beginning_line_number)]\n          end\n\n          private\n\n          def line_range_of_expression\n            @line_range_of_expression ||= begin\n              line_range = line_range_of_location_nodes_in_expression\n              initial_unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              unclosed_tokens = initial_unclosed_tokens\n\n              until (initial_unclosed_tokens & unclosed_tokens).empty?\n                line_range = (line_range.begin)..(line_range.end + 1)\n                unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              end\n\n              line_range\n            end\n          end\n\n          def unclosed_tokens_in_line_range(line_range)\n            tokens = FlatMap.flat_map(line_range) do |line_number|\n              source.tokens_by_line_number[line_number]\n            end\n\n            tokens.each_with_object([]) do |token, unclosed_tokens|\n              if token.opening?\n                unclosed_tokens << token\n              else\n                index = unclosed_tokens.rindex do |unclosed_token|\n                  unclosed_token.closed_by?(token)\n                end\n                unclosed_tokens.delete_at(index) if index\n              end\n            end\n          end\n\n          def line_range_of_location_nodes_in_expression\n            line_numbers = expression_node.each_with_object(Set.new) do |node, set|\n              set << node.location.line if node.location\n            end\n\n            line_numbers.min..line_numbers.max\n          end\n\n          def expression_node\n            raise NoExpressionAtLineError if location_nodes_at_beginning_line.empty?\n\n            @expression_node ||= begin\n              common_ancestor_nodes = location_nodes_at_beginning_line.map do |node|\n                node.each_ancestor.to_a\n              end.reduce(:&)\n\n              common_ancestor_nodes.find { |node| expression_outmost_node?(node) }\n            end\n          end\n\n          def expression_outmost_node?(node)\n            return true unless node.parent\n            return false if node.type.to_s.start_with?('@')\n            ![node, node.parent].all? do |n|\n              # See `Ripper::PARSER_EVENTS` for the complete list of sexp types.\n              type = n.type.to_s\n              type.end_with?('call') || type.start_with?('method_add_')\n            end\n          end\n\n          def location_nodes_at_beginning_line\n            source.nodes_by_line_number[beginning_line_number]\n          end\n        else\n          # :nocov:\n          def self.extract_expression_lines_at(file_path, beginning_line_number, *)\n            [extract_line_at(file_path, beginning_line_number)]\n          end\n          # :nocov:\n        end\n\n        def self.least_indentation_from(lines)\n          lines.map { |line| line[/^[ \\t]*/] }.min\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "line_range_of_expression", "signature": "def line_range_of_expression @line_range_of_expression ||= begin", "start_line": 55, "end_line": 68}, "metadata": {"module": "RSpec", "class_name": "SnippetExtractor", "class_signature": "class SnippetExtractor"}, "task_id": 347}
{"function_name": "unclosed_tokens_in_line_range", "file_path": "rspec-core/lib/rspec/core/formatters/snippet_extractor.rb", "focal_code": "def unclosed_tokens_in_line_range(line_range)\n            tokens = FlatMap.flat_map(line_range) do |line_number|\n              source.tokens_by_line_number[line_number]\n            end\n\n            tokens.each_with_object([]) do |token, unclosed_tokens|\n              if token.opening?\n                unclosed_tokens << token\n              else\n                index = unclosed_tokens.rindex do |unclosed_token|\n                  unclosed_token.closed_by?(token)\n                end\n                unclosed_tokens.delete_at(index) if index\n              end\n            end\n          end", "file_content": "module RSpec\n  module Core\n    module Formatters\n      # @private\n      class SnippetExtractor\n        NoSuchFileError = Class.new(StandardError)\n        NoSuchLineError = Class.new(StandardError)\n\n        def self.extract_line_at(file_path, line_number)\n          source = source_from_file(file_path)\n          line = source.lines[line_number - 1]\n          raise NoSuchLineError unless line\n          line\n        end\n\n        def self.source_from_file(path)\n          raise NoSuchFileError unless File.exist?(path)\n          RSpec.world.source_from_file(path)\n        end\n\n        if RSpec::Support::RubyFeatures.ripper_supported?\n          NoExpressionAtLineError = Class.new(StandardError)\n\n          attr_reader :source, :beginning_line_number, :max_line_count\n\n          def self.extract_expression_lines_at(file_path, beginning_line_number, max_line_count=nil)\n            if max_line_count == 1\n              [extract_line_at(file_path, beginning_line_number)]\n            else\n              source = source_from_file(file_path)\n              new(source, beginning_line_number, max_line_count).expression_lines\n            end\n          end\n\n          def initialize(source, beginning_line_number, max_line_count=nil)\n            @source = source\n            @beginning_line_number = beginning_line_number\n            @max_line_count = max_line_count\n          end\n\n          def expression_lines\n            line_range = line_range_of_expression\n\n            if max_line_count && line_range.count > max_line_count\n              line_range = (line_range.begin)..(line_range.begin + max_line_count - 1)\n            end\n\n            source.lines[(line_range.begin - 1)..(line_range.end - 1)]\n          rescue SyntaxError, NoExpressionAtLineError\n            [self.class.extract_line_at(source.path, beginning_line_number)]\n          end\n\n          private\n\n          def line_range_of_expression\n            @line_range_of_expression ||= begin\n              line_range = line_range_of_location_nodes_in_expression\n              initial_unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              unclosed_tokens = initial_unclosed_tokens\n\n              until (initial_unclosed_tokens & unclosed_tokens).empty?\n                line_range = (line_range.begin)..(line_range.end + 1)\n                unclosed_tokens = unclosed_tokens_in_line_range(line_range)\n              end\n\n              line_range\n            end\n          end\n\n          def unclosed_tokens_in_line_range(line_range)\n            tokens = FlatMap.flat_map(line_range) do |line_number|\n              source.tokens_by_line_number[line_number]\n            end\n\n            tokens.each_with_object([]) do |token, unclosed_tokens|\n              if token.opening?\n                unclosed_tokens << token\n              else\n                index = unclosed_tokens.rindex do |unclosed_token|\n                  unclosed_token.closed_by?(token)\n                end\n                unclosed_tokens.delete_at(index) if index\n              end\n            end\n          end\n\n          def line_range_of_location_nodes_in_expression\n            line_numbers = expression_node.each_with_object(Set.new) do |node, set|\n              set << node.location.line if node.location\n            end\n\n            line_numbers.min..line_numbers.max\n          end\n\n          def expression_node\n            raise NoExpressionAtLineError if location_nodes_at_beginning_line.empty?\n\n            @expression_node ||= begin\n              common_ancestor_nodes = location_nodes_at_beginning_line.map do |node|\n                node.each_ancestor.to_a\n              end.reduce(:&)\n\n              common_ancestor_nodes.find { |node| expression_outmost_node?(node) }\n            end\n          end\n\n          def expression_outmost_node?(node)\n            return true unless node.parent\n            return false if node.type.to_s.start_with?('@')\n            ![node, node.parent].all? do |n|\n              # See `Ripper::PARSER_EVENTS` for the complete list of sexp types.\n              type = n.type.to_s\n              type.end_with?('call') || type.start_with?('method_add_')\n            end\n          end\n\n          def location_nodes_at_beginning_line\n            source.nodes_by_line_number[beginning_line_number]\n          end\n        else\n          # :nocov:\n          def self.extract_expression_lines_at(file_path, beginning_line_number, *)\n            [extract_line_at(file_path, beginning_line_number)]\n          end\n          # :nocov:\n        end\n\n        def self.least_indentation_from(lines)\n          lines.map { |line| line[/^[ \\t]*/] }.min\n        end\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "unclosed_tokens_in_line_range", "signature": "def unclosed_tokens_in_line_range(line_range)", "start_line": 70, "end_line": 85}, "metadata": {"module": "RSpec", "class_name": "SnippetExtractor", "class_signature": "class SnippetExtractor"}, "task_id": 348}
{"function_name": "highlight_syntax", "file_path": "rspec-core/lib/rspec/core/formatters/syntax_highlighter.rb", "focal_code": "def self.highlight_syntax(lines)\n            highlighted = begin\n              CodeRay.encode(lines.join(\"\\n\"), :ruby, :terminal)\n            rescue Support::AllExceptionsExceptOnesWeMustNotRescue\n              return lines\n            end\n\n            highlighted.split(\"\\n\").map do |line|\n              line.sub(/\\S/) { |char| char.insert(0, RESET_CODE) }\n            end\n          end", "file_content": "module RSpec\n  module Core\n    module Formatters\n      # @private\n      # Provides terminal syntax highlighting of code snippets\n      # when coderay is available.\n      class SyntaxHighlighter\n        def initialize(configuration)\n          @configuration = configuration\n        end\n\n        def highlight(lines)\n          implementation.highlight_syntax(lines)\n        end\n\n        # rubocop:disable Lint/RescueException\n        # rubocop:disable Lint/HandleExceptions\n        def self.attempt_to_add_rspec_terms_to_coderay_keywords\n          CodeRay::Scanners::Ruby::Patterns::IDENT_KIND.add(%w[\n            describe context\n            it specify\n            before after around\n            let subject\n            expect allow\n          ], :keyword)\n        rescue Exception\n          # Mutating CodeRay's contants like this is not a public API\n          # and might not always work. If we cannot add our keywords\n          # to CodeRay it is not a big deal and not worth raising an\n          # error over, so we ignore it.\n        end\n      # rubocop:enable Lint/HandleExceptions\n      # rubocop:enable Lint/RescueException\n\n      private\n\n        if RSpec::Support::OS.windows?\n          # :nocov:\n          def implementation\n            WindowsImplementation\n          end\n          # :nocov:\n        else\n          def implementation\n            return color_enabled_implementation if @configuration.color_enabled?\n            NoSyntaxHighlightingImplementation\n          end\n        end\n\n        def color_enabled_implementation\n          @color_enabled_implementation ||= begin\n            require 'coderay'\n            self.class.attempt_to_add_rspec_terms_to_coderay_keywords\n            CodeRayImplementation\n          rescue LoadError\n            NoSyntaxHighlightingImplementation\n          end\n        end\n\n        # @private\n        module CodeRayImplementation\n          RESET_CODE = \"\\e[0m\"\n\n          def self.highlight_syntax(lines)\n            highlighted = begin\n              CodeRay.encode(lines.join(\"\\n\"), :ruby, :terminal)\n            rescue Support::AllExceptionsExceptOnesWeMustNotRescue\n              return lines\n            end\n\n            highlighted.split(\"\\n\").map do |line|\n              line.sub(/\\S/) { |char| char.insert(0, RESET_CODE) }\n            end\n          end\n        end\n\n        # @private\n        module NoSyntaxHighlightingImplementation\n          def self.highlight_syntax(lines)\n            lines\n          end\n        end\n\n        # @private\n        # Not sure why, but our code above (and/or coderay itself) does not work\n        # on Windows, so we disable the feature on Windows.\n        WindowsImplementation = NoSyntaxHighlightingImplementation\n      end\n    end\n  end\nend\n", "language": "Ruby", "function_component": {"name": "highlight_syntax", "signature": "def self.highlight_syntax(lines)", "start_line": 64, "end_line": 74}, "metadata": {"module": "RSpec", "class_name": "SyntaxHighlighter", "class_signature": "class SyntaxHighlighter"}, "task_id": 349}
{"function_name": "parse", "file_path": "shoryuken/lib/shoryuken/body_parser.rb", "focal_code": "def parse(worker_class, sqs_msg)\n        body_parser = worker_class.get_shoryuken_options['body_parser']\n\n        case body_parser\n        when :json\n          JSON.parse(sqs_msg.body)\n        when Proc\n          body_parser.call(sqs_msg)\n        when :text, nil\n          sqs_msg.body\n        else\n          if body_parser.respond_to?(:parse)\n            # JSON.parse\n            body_parser.parse(sqs_msg.body)\n          elsif body_parser.respond_to?(:load)\n            # see https://github.com/ruby-shoryuken/shoryuken/pull/91\n            # JSON.load\n            body_parser.load(sqs_msg.body)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Parses SQS message bodies according to worker configuration.\n  # Supports JSON parsing, text extraction, custom Procs, and\n  # any object that responds to parse or load methods.\n  class BodyParser\n    class << self\n      # Parses the body of an SQS message according to the worker's body_parser option\n      #\n      # @param worker_class [Class] the worker class with shoryuken options\n      # @param sqs_msg [Shoryuken::Message] the SQS message to parse\n      # @return [Object] the parsed message body\n      def parse(worker_class, sqs_msg)\n        body_parser = worker_class.get_shoryuken_options['body_parser']\n\n        case body_parser\n        when :json\n          JSON.parse(sqs_msg.body)\n        when Proc\n          body_parser.call(sqs_msg)\n        when :text, nil\n          sqs_msg.body\n        else\n          if body_parser.respond_to?(:parse)\n            # JSON.parse\n            body_parser.parse(sqs_msg.body)\n          elsif body_parser.respond_to?(:load)\n            # see https://github.com/ruby-shoryuken/shoryuken/pull/91\n            # JSON.load\n            body_parser.load(sqs_msg.body)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "parse", "signature": "def parse(worker_class, sqs_msg)", "start_line": 14, "end_line": 34}, "metadata": {"module": "Shoryuken", "class_name": "BodyParser", "class_signature": "class BodyParser"}, "task_id": 350}
{"function_name": "stop", "file_path": "shoryuken/lib/shoryuken/launcher.rb", "focal_code": "def stop\n      @stopping = true\n      fire_event(:quiet, true)\n\n      initiate_stop\n\n      stop_new_dispatching\n      await_dispatching_in_progress\n\n      executor.shutdown\n      executor.wait_for_termination\n\n      fire_event(:stopped)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Launches and coordinates Shoryuken's message processing managers.\n  # Handles the lifecycle of the processing system including startup, shutdown, and health checks.\n  class Launcher\n    include Util\n\n    # Initializes a new Launcher with managers for each processing group\n    def initialize\n      @managers = create_managers\n      @stopping = false\n    end\n\n    # Indicates whether the launcher is in the process of stopping.\n    #\n    # This flag is set to true when either {#stop} or {#stop!} is called,\n    # and is used by ActiveJob adapters to signal jobs that they should\n    # checkpoint and prepare for graceful shutdown.\n    #\n    # @return [Boolean] true if stopping, false otherwise\n    def stopping?\n      @stopping\n    end\n\n    # Starts the message processing system\n    #\n    # @return [void]\n    def start\n      logger.info { 'Starting' }\n\n      start_callback\n      start_managers\n    end\n\n    # Forces an immediate stop of all processing\n    #\n    # @return [void]\n    def stop!\n      @stopping = true\n      initiate_stop\n\n      # Don't await here so the timeout below is not delayed\n      stop_new_dispatching\n\n      executor.shutdown\n      executor.kill unless executor.wait_for_termination(Shoryuken.options[:timeout])\n\n      fire_event(:stopped)\n    end\n\n    # Gracefully stops all processing, waiting for in-flight messages\n    #\n    # @return [void]\n    def stop\n      @stopping = true\n      fire_event(:quiet, true)\n\n      initiate_stop\n\n      stop_new_dispatching\n      await_dispatching_in_progress\n\n      executor.shutdown\n      executor.wait_for_termination\n\n      fire_event(:stopped)\n    end\n\n    # Checks if all processing groups are healthy\n    #\n    # @return [Boolean] true if all groups are running normally\n    def healthy?\n      Shoryuken.groups.keys.all? do |group|\n        manager = @managers.find { |m| m.group == group }\n        manager && manager.running?\n      end\n    end\n\n    private\n\n    # Stops all managers from dispatching new messages\n    #\n    # @return [void]\n    def stop_new_dispatching\n      @managers.each(&:stop_new_dispatching)\n    end\n\n    # Waits for any in-progress dispatching to complete\n    #\n    # @return [void]\n    def await_dispatching_in_progress\n      @managers.each(&:await_dispatching_in_progress)\n    end\n\n    # Returns the executor for running async operations\n    #\n    # @return [Concurrent::ExecutorService] the executor service\n    def executor\n      @_executor ||= Shoryuken.launcher_executor || Concurrent.global_io_executor\n    end\n\n    # Starts all managers in parallel futures\n    #\n    # @return [void]\n    def start_managers\n      @managers.each do |manager|\n        Concurrent::Future.execute { manager.start }\n      end\n    end\n\n    # Initiates the stop sequence\n    #\n    # @return [void]\n    def initiate_stop\n      logger.info { 'Shutting down' }\n\n      stop_callback\n    end\n\n    # Executes the start callback and fires startup event\n    #\n    # @return [void]\n    def start_callback\n      if (callback = Shoryuken.start_callback)\n        logger.debug { 'Calling start_callback' }\n        callback.call\n      end\n\n      fire_event(:startup)\n    end\n\n    # Executes the stop callback and fires shutdown event\n    #\n    # @return [void]\n    def stop_callback\n      if (callback = Shoryuken.stop_callback)\n        logger.debug { 'Calling stop_callback' }\n        callback.call\n      end\n\n      fire_event(:shutdown, true)\n    end\n\n    # Creates managers for each configured processing group\n    #\n    # @return [Array<Shoryuken::Manager>] the created managers\n    def create_managers\n      Shoryuken.groups.map do |group, options|\n        Shoryuken::Manager.new(\n          group,\n          Shoryuken::Fetcher.new(group),\n          Shoryuken.polling_strategy(group).new(options[:queues], Shoryuken.delay(group)),\n          options[:concurrency],\n          executor\n        )\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "stop", "signature": "def stop @stopping = true", "start_line": 55, "end_line": 68}, "metadata": {"module": "Shoryuken", "class_name": "Launcher", "class_signature": "class Launcher"}, "task_id": 351}
{"function_name": "create_managers", "file_path": "shoryuken/lib/shoryuken/launcher.rb", "focal_code": "def create_managers\n      Shoryuken.groups.map do |group, options|\n        Shoryuken::Manager.new(\n          group,\n          Shoryuken::Fetcher.new(group),\n          Shoryuken.polling_strategy(group).new(options[:queues], Shoryuken.delay(group)),\n          options[:concurrency],\n          executor\n        )\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Launches and coordinates Shoryuken's message processing managers.\n  # Handles the lifecycle of the processing system including startup, shutdown, and health checks.\n  class Launcher\n    include Util\n\n    # Initializes a new Launcher with managers for each processing group\n    def initialize\n      @managers = create_managers\n      @stopping = false\n    end\n\n    # Indicates whether the launcher is in the process of stopping.\n    #\n    # This flag is set to true when either {#stop} or {#stop!} is called,\n    # and is used by ActiveJob adapters to signal jobs that they should\n    # checkpoint and prepare for graceful shutdown.\n    #\n    # @return [Boolean] true if stopping, false otherwise\n    def stopping?\n      @stopping\n    end\n\n    # Starts the message processing system\n    #\n    # @return [void]\n    def start\n      logger.info { 'Starting' }\n\n      start_callback\n      start_managers\n    end\n\n    # Forces an immediate stop of all processing\n    #\n    # @return [void]\n    def stop!\n      @stopping = true\n      initiate_stop\n\n      # Don't await here so the timeout below is not delayed\n      stop_new_dispatching\n\n      executor.shutdown\n      executor.kill unless executor.wait_for_termination(Shoryuken.options[:timeout])\n\n      fire_event(:stopped)\n    end\n\n    # Gracefully stops all processing, waiting for in-flight messages\n    #\n    # @return [void]\n    def stop\n      @stopping = true\n      fire_event(:quiet, true)\n\n      initiate_stop\n\n      stop_new_dispatching\n      await_dispatching_in_progress\n\n      executor.shutdown\n      executor.wait_for_termination\n\n      fire_event(:stopped)\n    end\n\n    # Checks if all processing groups are healthy\n    #\n    # @return [Boolean] true if all groups are running normally\n    def healthy?\n      Shoryuken.groups.keys.all? do |group|\n        manager = @managers.find { |m| m.group == group }\n        manager && manager.running?\n      end\n    end\n\n    private\n\n    # Stops all managers from dispatching new messages\n    #\n    # @return [void]\n    def stop_new_dispatching\n      @managers.each(&:stop_new_dispatching)\n    end\n\n    # Waits for any in-progress dispatching to complete\n    #\n    # @return [void]\n    def await_dispatching_in_progress\n      @managers.each(&:await_dispatching_in_progress)\n    end\n\n    # Returns the executor for running async operations\n    #\n    # @return [Concurrent::ExecutorService] the executor service\n    def executor\n      @_executor ||= Shoryuken.launcher_executor || Concurrent.global_io_executor\n    end\n\n    # Starts all managers in parallel futures\n    #\n    # @return [void]\n    def start_managers\n      @managers.each do |manager|\n        Concurrent::Future.execute { manager.start }\n      end\n    end\n\n    # Initiates the stop sequence\n    #\n    # @return [void]\n    def initiate_stop\n      logger.info { 'Shutting down' }\n\n      stop_callback\n    end\n\n    # Executes the start callback and fires startup event\n    #\n    # @return [void]\n    def start_callback\n      if (callback = Shoryuken.start_callback)\n        logger.debug { 'Calling start_callback' }\n        callback.call\n      end\n\n      fire_event(:startup)\n    end\n\n    # Executes the stop callback and fires shutdown event\n    #\n    # @return [void]\n    def stop_callback\n      if (callback = Shoryuken.stop_callback)\n        logger.debug { 'Calling stop_callback' }\n        callback.call\n      end\n\n      fire_event(:shutdown, true)\n    end\n\n    # Creates managers for each configured processing group\n    #\n    # @return [Array<Shoryuken::Manager>] the created managers\n    def create_managers\n      Shoryuken.groups.map do |group, options|\n        Shoryuken::Manager.new(\n          group,\n          Shoryuken::Fetcher.new(group),\n          Shoryuken.polling_strategy(group).new(options[:queues], Shoryuken.delay(group)),\n          options[:concurrency],\n          executor\n        )\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "create_managers", "signature": "def create_managers Shoryuken.groups.map do |group, options|", "start_line": 148, "end_line": 158}, "metadata": {"module": "Shoryuken", "class_name": "Launcher", "class_signature": "class Launcher"}, "task_id": 352}
{"function_name": "delete_messages", "file_path": "shoryuken/lib/shoryuken/queue.rb", "focal_code": "def delete_messages(options)\n      failed_messages = client.delete_message_batch(\n        options.merge(queue_url: url)\n      ).failed || []\n      failed_messages.any? do |failure|\n        logger.error do\n          \"Could not delete #{failure.id}, code: '#{failure.code}', message: '#{failure.message}', sender_fault: #{failure.sender_fault}\"\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Represents an SQS queue and provides methods for sending and receiving messages.\n  # Handles both standard and FIFO queues, automatically adding required FIFO attributes.\n  class Queue\n    include Util\n\n    # SQS attribute name for FIFO queue identification\n    FIFO_ATTR               = 'FifoQueue'\n\n    # Default message group ID used for FIFO queues\n    MESSAGE_GROUP_ID        = 'ShoryukenMessage'\n\n    # SQS attribute name for visibility timeout\n    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'\n\n    # @return [String] the queue name\n    attr_accessor :name\n\n    # @return [Aws::SQS::Client] the SQS client\n    attr_accessor :client\n\n    # @return [String] the queue URL\n    attr_accessor :url\n\n    # Initializes a new Queue instance\n    #\n    # @param client [Aws::SQS::Client] the SQS client\n    # @param name_or_url_or_arn [String] the queue name, URL, or ARN\n    def initialize(client, name_or_url_or_arn)\n      self.client = client\n      set_name_and_url(name_or_url_or_arn)\n    end\n\n    # Returns the visibility timeout for the queue\n    #\n    # @return [Integer] the visibility timeout in seconds\n    def visibility_timeout\n      # Always lookup for the latest visibility when cache is disabled\n      # setting it to nil, forces re-lookup\n      @_visibility_timeout = nil unless Shoryuken.cache_visibility_timeout?\n      @_visibility_timeout ||= queue_attributes.attributes[VISIBILITY_TIMEOUT_ATTR].to_i\n    end\n\n    # Deletes messages from the queue in batch\n    #\n    # @param options [Hash] options for delete_message_batch\n    # @option options [Array<Hash>] :entries entries to delete with id and receipt_handle\n    # @return [Boolean] true if any messages failed to delete\n    def delete_messages(options)\n      failed_messages = client.delete_message_batch(\n        options.merge(queue_url: url)\n      ).failed || []\n      failed_messages.any? do |failure|\n        logger.error do\n          \"Could not delete #{failure.id}, code: '#{failure.code}', message: '#{failure.message}', sender_fault: #{failure.sender_fault}\"\n        end\n      end\n    end\n\n    # Sends a single message to the queue\n    #\n    # @param options [Hash, String] message options or message body string\n    # @option options [String] :message_body the message body\n    # @option options [Integer] :delay_seconds delay before message becomes visible\n    # @option options [Hash] :message_attributes custom message attributes\n    # @option options [String] :message_group_id FIFO queue message group ID\n    # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n    # @return [Aws::SQS::Types::SendMessageResult] the send result\n    def send_message(options)\n      options = sanitize_message!(options).merge(queue_url: url)\n\n      Shoryuken.client_middleware.invoke(options) do\n        client.send_message(options)\n      end\n    end\n\n    # Sends multiple messages to the queue in batch\n    #\n    # @param options [Hash, Array] batch options or array of message bodies/hashes\n    # @option options [Array<Hash>] :entries message entries to send\n    # @return [Aws::SQS::Types::SendMessageBatchResult] the batch send result\n    def send_messages(options)\n      client.send_message_batch(sanitize_messages!(options).merge(queue_url: url))\n    end\n\n    # Receives messages from the queue\n    #\n    # @param options [Hash] options for receive_message\n    # @option options [Integer] :max_number_of_messages maximum messages to receive\n    # @option options [Integer] :visibility_timeout visibility timeout for received messages\n    # @option options [Integer] :wait_time_seconds long polling wait time\n    # @option options [Array<String>] :attribute_names SQS attributes to retrieve\n    # @option options [Array<String>] :message_attribute_names message attributes to retrieve\n    # @return [Array<Shoryuken::Message>] the received messages\n    def receive_messages(options)\n      messages = client.receive_message(options.merge(queue_url: url)).messages || []\n      messages.map { |m| Message.new(client, self, m) }\n    end\n\n    # Checks if the queue is a FIFO queue\n    #\n    # @return [Boolean] true if the queue is a FIFO queue\n    def fifo?\n      # Make sure the memoization work with boolean to avoid multiple calls to SQS\n      # see https://github.com/ruby-shoryuken/shoryuken/pull/529\n      return @_fifo if defined?(@_fifo)\n\n      @_fifo = queue_attributes.attributes[FIFO_ATTR] == 'true'\n      @_fifo\n    end\n\n    private\n\n    # Initializes the FIFO attribute by calling fifo?\n    #\n    # @return [Boolean] whether the queue is FIFO\n    def initialize_fifo_attribute\n      # calling fifo? will also initialize it\n      fifo?\n    end\n\n    # Sets the queue name and URL from a queue name\n    #\n    # @param name [String] the queue name\n    # @return [void]\n    def set_by_name(name) # rubocop:disable Naming/AccessorMethodName\n      self.name = name\n      self.url  = client.get_queue_url(queue_name: name).queue_url\n    end\n\n    # Sets the queue name and URL from a queue URL\n    #\n    # @param url [String] the queue URL\n    # @return [void]\n    def set_by_url(url) # rubocop:disable Naming/AccessorMethodName\n      self.name = url.split('/').last\n      self.url  = url\n    end\n\n    # Converts an ARN to a queue URL\n    #\n    # @param arn_str [String] the ARN string\n    # @return [String] the queue URL\n    def arn_to_url(arn_str)\n      *, region, account_id, resource = arn_str.split(':')\n\n      required = [region, account_id, resource].map(&:to_s)\n      valid = required.none?(&:empty?)\n\n      raise Errors::InvalidArnError, \"Invalid ARN: #{arn_str}. A valid ARN must include: region, account_id and resource.\" unless valid\n\n      \"https://sqs.#{region}.amazonaws.com/#{account_id}/#{resource}\"\n    end\n\n    # Sets the queue name and URL from a name, URL, or ARN\n    #\n    # @param name_or_url_or_arn [String] the queue identifier\n    # @return [void]\n    def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName\n      if name_or_url_or_arn.include?('://')\n        set_by_url(name_or_url_or_arn)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      if name_or_url_or_arn.start_with?('arn:')\n        url = arn_to_url(name_or_url_or_arn)\n        set_by_url(url)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      set_by_name(name_or_url_or_arn)\n    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n      raise Errors::QueueNotFoundError, \"The specified queue #{name_or_url_or_arn} does not exist.\"\n    end\n\n    # Returns the queue attributes from SQS\n    #\n    # @return [Aws::SQS::Types::GetQueueAttributesResult] the queue attributes\n    def queue_attributes\n      # Note: Retrieving all queue attributes as requesting `FifoQueue` on non-FIFO queue raises error.\n      # See issue: https://github.com/aws/aws-sdk-ruby/issues/1350\n      client.get_queue_attributes(queue_url: url, attribute_names: ['All'])\n    end\n\n    # Sanitizes a batch of messages, converting to proper format\n    #\n    # @param options [Hash, Array] batch options or array of messages\n    # @option options [Array<Hash>] :entries message entries\n    # @return [Hash] the sanitized options with entries key\n    def sanitize_messages!(options)\n      if options.is_a?(Array)\n        entries = options.map.with_index do |m, index|\n          { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })\n        end\n\n        options = { entries: entries }\n      end\n\n      options[:entries].each(&method(:sanitize_message!))\n\n      options\n    end\n\n    # Adds FIFO attributes to message options if needed\n    #\n    # @param options [Hash] the message options\n    # @option options [String] :message_body the message body\n    # @return [Hash] the options with FIFO attributes added\n    def add_fifo_attributes!(options)\n      return unless fifo?\n\n      options[:message_group_id]         ||= MESSAGE_GROUP_ID\n      options[:message_deduplication_id] ||= Digest::SHA256.hexdigest(options[:message_body].to_s)\n\n      options\n    end\n\n    # Sanitizes a single message, converting body to JSON if needed\n    #\n    # @param options [Hash, String] message options or body string\n    # @option options [String, Hash] :message_body the message body\n    # @return [Hash] the sanitized message options\n    def sanitize_message!(options)\n      options = { message_body: options } if options.is_a?(String)\n\n      if (body = options[:message_body]).is_a?(Hash)\n        options[:message_body] = JSON.dump(body)\n      end\n\n      add_fifo_attributes!(options)\n\n      options\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "delete_messages", "signature": "def delete_messages(options)", "start_line": 51, "end_line": 60}, "metadata": {"module": "Shoryuken", "class_name": "Queue", "class_signature": "class Queue"}, "task_id": 353}
{"function_name": "set_name_and_url", "file_path": "shoryuken/lib/shoryuken/queue.rb", "focal_code": "def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName\n      if name_or_url_or_arn.include?('://')\n        set_by_url(name_or_url_or_arn)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      if name_or_url_or_arn.start_with?('arn:')\n        url = arn_to_url(name_or_url_or_arn)\n        set_by_url(url)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      set_by_name(name_or_url_or_arn)\n    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n      raise Errors::QueueNotFoundError, \"The specified queue #{name_or_url_or_arn} does not exist.\"\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Represents an SQS queue and provides methods for sending and receiving messages.\n  # Handles both standard and FIFO queues, automatically adding required FIFO attributes.\n  class Queue\n    include Util\n\n    # SQS attribute name for FIFO queue identification\n    FIFO_ATTR               = 'FifoQueue'\n\n    # Default message group ID used for FIFO queues\n    MESSAGE_GROUP_ID        = 'ShoryukenMessage'\n\n    # SQS attribute name for visibility timeout\n    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'\n\n    # @return [String] the queue name\n    attr_accessor :name\n\n    # @return [Aws::SQS::Client] the SQS client\n    attr_accessor :client\n\n    # @return [String] the queue URL\n    attr_accessor :url\n\n    # Initializes a new Queue instance\n    #\n    # @param client [Aws::SQS::Client] the SQS client\n    # @param name_or_url_or_arn [String] the queue name, URL, or ARN\n    def initialize(client, name_or_url_or_arn)\n      self.client = client\n      set_name_and_url(name_or_url_or_arn)\n    end\n\n    # Returns the visibility timeout for the queue\n    #\n    # @return [Integer] the visibility timeout in seconds\n    def visibility_timeout\n      # Always lookup for the latest visibility when cache is disabled\n      # setting it to nil, forces re-lookup\n      @_visibility_timeout = nil unless Shoryuken.cache_visibility_timeout?\n      @_visibility_timeout ||= queue_attributes.attributes[VISIBILITY_TIMEOUT_ATTR].to_i\n    end\n\n    # Deletes messages from the queue in batch\n    #\n    # @param options [Hash] options for delete_message_batch\n    # @option options [Array<Hash>] :entries entries to delete with id and receipt_handle\n    # @return [Boolean] true if any messages failed to delete\n    def delete_messages(options)\n      failed_messages = client.delete_message_batch(\n        options.merge(queue_url: url)\n      ).failed || []\n      failed_messages.any? do |failure|\n        logger.error do\n          \"Could not delete #{failure.id}, code: '#{failure.code}', message: '#{failure.message}', sender_fault: #{failure.sender_fault}\"\n        end\n      end\n    end\n\n    # Sends a single message to the queue\n    #\n    # @param options [Hash, String] message options or message body string\n    # @option options [String] :message_body the message body\n    # @option options [Integer] :delay_seconds delay before message becomes visible\n    # @option options [Hash] :message_attributes custom message attributes\n    # @option options [String] :message_group_id FIFO queue message group ID\n    # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n    # @return [Aws::SQS::Types::SendMessageResult] the send result\n    def send_message(options)\n      options = sanitize_message!(options).merge(queue_url: url)\n\n      Shoryuken.client_middleware.invoke(options) do\n        client.send_message(options)\n      end\n    end\n\n    # Sends multiple messages to the queue in batch\n    #\n    # @param options [Hash, Array] batch options or array of message bodies/hashes\n    # @option options [Array<Hash>] :entries message entries to send\n    # @return [Aws::SQS::Types::SendMessageBatchResult] the batch send result\n    def send_messages(options)\n      client.send_message_batch(sanitize_messages!(options).merge(queue_url: url))\n    end\n\n    # Receives messages from the queue\n    #\n    # @param options [Hash] options for receive_message\n    # @option options [Integer] :max_number_of_messages maximum messages to receive\n    # @option options [Integer] :visibility_timeout visibility timeout for received messages\n    # @option options [Integer] :wait_time_seconds long polling wait time\n    # @option options [Array<String>] :attribute_names SQS attributes to retrieve\n    # @option options [Array<String>] :message_attribute_names message attributes to retrieve\n    # @return [Array<Shoryuken::Message>] the received messages\n    def receive_messages(options)\n      messages = client.receive_message(options.merge(queue_url: url)).messages || []\n      messages.map { |m| Message.new(client, self, m) }\n    end\n\n    # Checks if the queue is a FIFO queue\n    #\n    # @return [Boolean] true if the queue is a FIFO queue\n    def fifo?\n      # Make sure the memoization work with boolean to avoid multiple calls to SQS\n      # see https://github.com/ruby-shoryuken/shoryuken/pull/529\n      return @_fifo if defined?(@_fifo)\n\n      @_fifo = queue_attributes.attributes[FIFO_ATTR] == 'true'\n      @_fifo\n    end\n\n    private\n\n    # Initializes the FIFO attribute by calling fifo?\n    #\n    # @return [Boolean] whether the queue is FIFO\n    def initialize_fifo_attribute\n      # calling fifo? will also initialize it\n      fifo?\n    end\n\n    # Sets the queue name and URL from a queue name\n    #\n    # @param name [String] the queue name\n    # @return [void]\n    def set_by_name(name) # rubocop:disable Naming/AccessorMethodName\n      self.name = name\n      self.url  = client.get_queue_url(queue_name: name).queue_url\n    end\n\n    # Sets the queue name and URL from a queue URL\n    #\n    # @param url [String] the queue URL\n    # @return [void]\n    def set_by_url(url) # rubocop:disable Naming/AccessorMethodName\n      self.name = url.split('/').last\n      self.url  = url\n    end\n\n    # Converts an ARN to a queue URL\n    #\n    # @param arn_str [String] the ARN string\n    # @return [String] the queue URL\n    def arn_to_url(arn_str)\n      *, region, account_id, resource = arn_str.split(':')\n\n      required = [region, account_id, resource].map(&:to_s)\n      valid = required.none?(&:empty?)\n\n      raise Errors::InvalidArnError, \"Invalid ARN: #{arn_str}. A valid ARN must include: region, account_id and resource.\" unless valid\n\n      \"https://sqs.#{region}.amazonaws.com/#{account_id}/#{resource}\"\n    end\n\n    # Sets the queue name and URL from a name, URL, or ARN\n    #\n    # @param name_or_url_or_arn [String] the queue identifier\n    # @return [void]\n    def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName\n      if name_or_url_or_arn.include?('://')\n        set_by_url(name_or_url_or_arn)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      if name_or_url_or_arn.start_with?('arn:')\n        url = arn_to_url(name_or_url_or_arn)\n        set_by_url(url)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      set_by_name(name_or_url_or_arn)\n    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n      raise Errors::QueueNotFoundError, \"The specified queue #{name_or_url_or_arn} does not exist.\"\n    end\n\n    # Returns the queue attributes from SQS\n    #\n    # @return [Aws::SQS::Types::GetQueueAttributesResult] the queue attributes\n    def queue_attributes\n      # Note: Retrieving all queue attributes as requesting `FifoQueue` on non-FIFO queue raises error.\n      # See issue: https://github.com/aws/aws-sdk-ruby/issues/1350\n      client.get_queue_attributes(queue_url: url, attribute_names: ['All'])\n    end\n\n    # Sanitizes a batch of messages, converting to proper format\n    #\n    # @param options [Hash, Array] batch options or array of messages\n    # @option options [Array<Hash>] :entries message entries\n    # @return [Hash] the sanitized options with entries key\n    def sanitize_messages!(options)\n      if options.is_a?(Array)\n        entries = options.map.with_index do |m, index|\n          { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })\n        end\n\n        options = { entries: entries }\n      end\n\n      options[:entries].each(&method(:sanitize_message!))\n\n      options\n    end\n\n    # Adds FIFO attributes to message options if needed\n    #\n    # @param options [Hash] the message options\n    # @option options [String] :message_body the message body\n    # @return [Hash] the options with FIFO attributes added\n    def add_fifo_attributes!(options)\n      return unless fifo?\n\n      options[:message_group_id]         ||= MESSAGE_GROUP_ID\n      options[:message_deduplication_id] ||= Digest::SHA256.hexdigest(options[:message_body].to_s)\n\n      options\n    end\n\n    # Sanitizes a single message, converting body to JSON if needed\n    #\n    # @param options [Hash, String] message options or body string\n    # @option options [String, Hash] :message_body the message body\n    # @return [Hash] the sanitized message options\n    def sanitize_message!(options)\n      options = { message_body: options } if options.is_a?(String)\n\n      if (body = options[:message_body]).is_a?(Hash)\n        options[:message_body] = JSON.dump(body)\n      end\n\n      add_fifo_attributes!(options)\n\n      options\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "set_name_and_url", "signature": "def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName", "start_line": 161, "end_line": 182}, "metadata": {"module": "Shoryuken", "class_name": "Queue", "class_signature": "class Queue"}, "task_id": 354}
{"function_name": "sanitize_messages!", "file_path": "shoryuken/lib/shoryuken/queue.rb", "focal_code": "def sanitize_messages!(options)\n      if options.is_a?(Array)\n        entries = options.map.with_index do |m, index|\n          { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })\n        end\n\n        options = { entries: entries }\n      end\n\n      options[:entries].each(&method(:sanitize_message!))\n\n      options\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Represents an SQS queue and provides methods for sending and receiving messages.\n  # Handles both standard and FIFO queues, automatically adding required FIFO attributes.\n  class Queue\n    include Util\n\n    # SQS attribute name for FIFO queue identification\n    FIFO_ATTR               = 'FifoQueue'\n\n    # Default message group ID used for FIFO queues\n    MESSAGE_GROUP_ID        = 'ShoryukenMessage'\n\n    # SQS attribute name for visibility timeout\n    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'\n\n    # @return [String] the queue name\n    attr_accessor :name\n\n    # @return [Aws::SQS::Client] the SQS client\n    attr_accessor :client\n\n    # @return [String] the queue URL\n    attr_accessor :url\n\n    # Initializes a new Queue instance\n    #\n    # @param client [Aws::SQS::Client] the SQS client\n    # @param name_or_url_or_arn [String] the queue name, URL, or ARN\n    def initialize(client, name_or_url_or_arn)\n      self.client = client\n      set_name_and_url(name_or_url_or_arn)\n    end\n\n    # Returns the visibility timeout for the queue\n    #\n    # @return [Integer] the visibility timeout in seconds\n    def visibility_timeout\n      # Always lookup for the latest visibility when cache is disabled\n      # setting it to nil, forces re-lookup\n      @_visibility_timeout = nil unless Shoryuken.cache_visibility_timeout?\n      @_visibility_timeout ||= queue_attributes.attributes[VISIBILITY_TIMEOUT_ATTR].to_i\n    end\n\n    # Deletes messages from the queue in batch\n    #\n    # @param options [Hash] options for delete_message_batch\n    # @option options [Array<Hash>] :entries entries to delete with id and receipt_handle\n    # @return [Boolean] true if any messages failed to delete\n    def delete_messages(options)\n      failed_messages = client.delete_message_batch(\n        options.merge(queue_url: url)\n      ).failed || []\n      failed_messages.any? do |failure|\n        logger.error do\n          \"Could not delete #{failure.id}, code: '#{failure.code}', message: '#{failure.message}', sender_fault: #{failure.sender_fault}\"\n        end\n      end\n    end\n\n    # Sends a single message to the queue\n    #\n    # @param options [Hash, String] message options or message body string\n    # @option options [String] :message_body the message body\n    # @option options [Integer] :delay_seconds delay before message becomes visible\n    # @option options [Hash] :message_attributes custom message attributes\n    # @option options [String] :message_group_id FIFO queue message group ID\n    # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n    # @return [Aws::SQS::Types::SendMessageResult] the send result\n    def send_message(options)\n      options = sanitize_message!(options).merge(queue_url: url)\n\n      Shoryuken.client_middleware.invoke(options) do\n        client.send_message(options)\n      end\n    end\n\n    # Sends multiple messages to the queue in batch\n    #\n    # @param options [Hash, Array] batch options or array of message bodies/hashes\n    # @option options [Array<Hash>] :entries message entries to send\n    # @return [Aws::SQS::Types::SendMessageBatchResult] the batch send result\n    def send_messages(options)\n      client.send_message_batch(sanitize_messages!(options).merge(queue_url: url))\n    end\n\n    # Receives messages from the queue\n    #\n    # @param options [Hash] options for receive_message\n    # @option options [Integer] :max_number_of_messages maximum messages to receive\n    # @option options [Integer] :visibility_timeout visibility timeout for received messages\n    # @option options [Integer] :wait_time_seconds long polling wait time\n    # @option options [Array<String>] :attribute_names SQS attributes to retrieve\n    # @option options [Array<String>] :message_attribute_names message attributes to retrieve\n    # @return [Array<Shoryuken::Message>] the received messages\n    def receive_messages(options)\n      messages = client.receive_message(options.merge(queue_url: url)).messages || []\n      messages.map { |m| Message.new(client, self, m) }\n    end\n\n    # Checks if the queue is a FIFO queue\n    #\n    # @return [Boolean] true if the queue is a FIFO queue\n    def fifo?\n      # Make sure the memoization work with boolean to avoid multiple calls to SQS\n      # see https://github.com/ruby-shoryuken/shoryuken/pull/529\n      return @_fifo if defined?(@_fifo)\n\n      @_fifo = queue_attributes.attributes[FIFO_ATTR] == 'true'\n      @_fifo\n    end\n\n    private\n\n    # Initializes the FIFO attribute by calling fifo?\n    #\n    # @return [Boolean] whether the queue is FIFO\n    def initialize_fifo_attribute\n      # calling fifo? will also initialize it\n      fifo?\n    end\n\n    # Sets the queue name and URL from a queue name\n    #\n    # @param name [String] the queue name\n    # @return [void]\n    def set_by_name(name) # rubocop:disable Naming/AccessorMethodName\n      self.name = name\n      self.url  = client.get_queue_url(queue_name: name).queue_url\n    end\n\n    # Sets the queue name and URL from a queue URL\n    #\n    # @param url [String] the queue URL\n    # @return [void]\n    def set_by_url(url) # rubocop:disable Naming/AccessorMethodName\n      self.name = url.split('/').last\n      self.url  = url\n    end\n\n    # Converts an ARN to a queue URL\n    #\n    # @param arn_str [String] the ARN string\n    # @return [String] the queue URL\n    def arn_to_url(arn_str)\n      *, region, account_id, resource = arn_str.split(':')\n\n      required = [region, account_id, resource].map(&:to_s)\n      valid = required.none?(&:empty?)\n\n      raise Errors::InvalidArnError, \"Invalid ARN: #{arn_str}. A valid ARN must include: region, account_id and resource.\" unless valid\n\n      \"https://sqs.#{region}.amazonaws.com/#{account_id}/#{resource}\"\n    end\n\n    # Sets the queue name and URL from a name, URL, or ARN\n    #\n    # @param name_or_url_or_arn [String] the queue identifier\n    # @return [void]\n    def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName\n      if name_or_url_or_arn.include?('://')\n        set_by_url(name_or_url_or_arn)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      if name_or_url_or_arn.start_with?('arn:')\n        url = arn_to_url(name_or_url_or_arn)\n        set_by_url(url)\n\n        # anticipate the fifo? checker for validating the queue URL\n        initialize_fifo_attribute\n        return\n      end\n\n      set_by_name(name_or_url_or_arn)\n    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n      raise Errors::QueueNotFoundError, \"The specified queue #{name_or_url_or_arn} does not exist.\"\n    end\n\n    # Returns the queue attributes from SQS\n    #\n    # @return [Aws::SQS::Types::GetQueueAttributesResult] the queue attributes\n    def queue_attributes\n      # Note: Retrieving all queue attributes as requesting `FifoQueue` on non-FIFO queue raises error.\n      # See issue: https://github.com/aws/aws-sdk-ruby/issues/1350\n      client.get_queue_attributes(queue_url: url, attribute_names: ['All'])\n    end\n\n    # Sanitizes a batch of messages, converting to proper format\n    #\n    # @param options [Hash, Array] batch options or array of messages\n    # @option options [Array<Hash>] :entries message entries\n    # @return [Hash] the sanitized options with entries key\n    def sanitize_messages!(options)\n      if options.is_a?(Array)\n        entries = options.map.with_index do |m, index|\n          { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })\n        end\n\n        options = { entries: entries }\n      end\n\n      options[:entries].each(&method(:sanitize_message!))\n\n      options\n    end\n\n    # Adds FIFO attributes to message options if needed\n    #\n    # @param options [Hash] the message options\n    # @option options [String] :message_body the message body\n    # @return [Hash] the options with FIFO attributes added\n    def add_fifo_attributes!(options)\n      return unless fifo?\n\n      options[:message_group_id]         ||= MESSAGE_GROUP_ID\n      options[:message_deduplication_id] ||= Digest::SHA256.hexdigest(options[:message_body].to_s)\n\n      options\n    end\n\n    # Sanitizes a single message, converting body to JSON if needed\n    #\n    # @param options [Hash, String] message options or body string\n    # @option options [String, Hash] :message_body the message body\n    # @return [Hash] the sanitized message options\n    def sanitize_message!(options)\n      options = { message_body: options } if options.is_a?(String)\n\n      if (body = options[:message_body]).is_a?(Hash)\n        options[:message_body] = JSON.dump(body)\n      end\n\n      add_fifo_attributes!(options)\n\n      options\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "sanitize_messages!", "signature": "def sanitize_messages!(options)", "start_line": 198, "end_line": 210}, "metadata": {"module": "Shoryuken", "class_name": "Queue", "class_signature": "class Queue"}, "task_id": 355}
{"function_name": "fire_event", "file_path": "shoryuken/lib/shoryuken/util.rb", "focal_code": "def fire_event(event, reverse = false, event_options = {})\n      logger.debug { \"Firing '#{event}' lifecycle event\" }\n      arr = Shoryuken.options[:lifecycle_events][event]\n      arr.reverse! if reverse\n      arr.each do |block|\n        block.call(event_options)\n      rescue => e\n        logger.warn(event: event)\n        logger.warn \"#{e.class.name}: #{e.message}\"\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Utility methods shared across Shoryuken classes.\n  # Provides logging, event firing, and helper methods.\n  module Util\n    # Returns the Shoryuken logger\n    #\n    # @return [Logger] the configured logger\n    def logger\n      Shoryuken.logger\n    end\n\n    # Fires a lifecycle event to all registered handlers\n    #\n    # @param event [Symbol] the event name to fire\n    # @param reverse [Boolean] whether to call handlers in reverse order\n    # @param event_options [Hash] options to pass to event handlers\n    # @return [void]\n    def fire_event(event, reverse = false, event_options = {})\n      logger.debug { \"Firing '#{event}' lifecycle event\" }\n      arr = Shoryuken.options[:lifecycle_events][event]\n      arr.reverse! if reverse\n      arr.each do |block|\n        block.call(event_options)\n      rescue => e\n        logger.warn(event: event)\n        logger.warn \"#{e.class.name}: #{e.message}\"\n      end\n    end\n\n    # Calculates elapsed time in milliseconds\n    #\n    # @param started_at [Time] the start time\n    # @return [Float] elapsed time in milliseconds\n    def elapsed(started_at)\n      # elapsed in ms\n      (Time.now - started_at) * 1000\n    end\n\n    # Converts a queue array to a hash of queue names and weights\n    #\n    # @param queues [Array<String>] array of queue names with possible duplicates\n    # @return [Array<Array>] array of [queue_name, weight] pairs\n    def unparse_queues(queues)\n      queues.each_with_object({}) do |name, queue_and_weights|\n        queue_and_weights[name] = queue_and_weights[name].to_i + 1\n      end.to_a\n    end\n\n    # Returns a display name for the worker processing a message\n    #\n    # @param worker_class [Class] the worker class\n    # @param sqs_msg [Aws::SQS::Types::Message, Array] the message or batch\n    # @param body [Object, nil] the parsed message body\n    # @return [String] the worker display name\n    def worker_name(worker_class, sqs_msg, body = nil)\n      if Shoryuken.active_job? \\\n          && !sqs_msg.is_a?(Array) \\\n          && sqs_msg.message_attributes \\\n          && sqs_msg.message_attributes['shoryuken_class'] \\\n          && sqs_msg.message_attributes['shoryuken_class'][:string_value] \\\n          == 'Shoryuken::ActiveJob::JobWrapper' \\\n          && body\n\n        \"ActiveJob/#{body['job_class']}\"\n      else\n        worker_class.to_s\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "fire_event", "signature": "def fire_event(event, reverse = false, event_options = {})", "start_line": 20, "end_line": 30}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 356}
{"function_name": "worker_name", "file_path": "shoryuken/lib/shoryuken/util.rb", "focal_code": "def worker_name(worker_class, sqs_msg, body = nil)\n      if Shoryuken.active_job? \\\n          && !sqs_msg.is_a?(Array) \\\n          && sqs_msg.message_attributes \\\n          && sqs_msg.message_attributes['shoryuken_class'] \\\n          && sqs_msg.message_attributes['shoryuken_class'][:string_value] \\\n          == 'Shoryuken::ActiveJob::JobWrapper' \\\n          && body\n\n        \"ActiveJob/#{body['job_class']}\"\n      else\n        worker_class.to_s\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Utility methods shared across Shoryuken classes.\n  # Provides logging, event firing, and helper methods.\n  module Util\n    # Returns the Shoryuken logger\n    #\n    # @return [Logger] the configured logger\n    def logger\n      Shoryuken.logger\n    end\n\n    # Fires a lifecycle event to all registered handlers\n    #\n    # @param event [Symbol] the event name to fire\n    # @param reverse [Boolean] whether to call handlers in reverse order\n    # @param event_options [Hash] options to pass to event handlers\n    # @return [void]\n    def fire_event(event, reverse = false, event_options = {})\n      logger.debug { \"Firing '#{event}' lifecycle event\" }\n      arr = Shoryuken.options[:lifecycle_events][event]\n      arr.reverse! if reverse\n      arr.each do |block|\n        block.call(event_options)\n      rescue => e\n        logger.warn(event: event)\n        logger.warn \"#{e.class.name}: #{e.message}\"\n      end\n    end\n\n    # Calculates elapsed time in milliseconds\n    #\n    # @param started_at [Time] the start time\n    # @return [Float] elapsed time in milliseconds\n    def elapsed(started_at)\n      # elapsed in ms\n      (Time.now - started_at) * 1000\n    end\n\n    # Converts a queue array to a hash of queue names and weights\n    #\n    # @param queues [Array<String>] array of queue names with possible duplicates\n    # @return [Array<Array>] array of [queue_name, weight] pairs\n    def unparse_queues(queues)\n      queues.each_with_object({}) do |name, queue_and_weights|\n        queue_and_weights[name] = queue_and_weights[name].to_i + 1\n      end.to_a\n    end\n\n    # Returns a display name for the worker processing a message\n    #\n    # @param worker_class [Class] the worker class\n    # @param sqs_msg [Aws::SQS::Types::Message, Array] the message or batch\n    # @param body [Object, nil] the parsed message body\n    # @return [String] the worker display name\n    def worker_name(worker_class, sqs_msg, body = nil)\n      if Shoryuken.active_job? \\\n          && !sqs_msg.is_a?(Array) \\\n          && sqs_msg.message_attributes \\\n          && sqs_msg.message_attributes['shoryuken_class'] \\\n          && sqs_msg.message_attributes['shoryuken_class'][:string_value] \\\n          == 'Shoryuken::ActiveJob::JobWrapper' \\\n          && body\n\n        \"ActiveJob/#{body['job_class']}\"\n      else\n        worker_class.to_s\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "worker_name", "signature": "def worker_name(worker_class, sqs_msg, body = nil)", "start_line": 57, "end_line": 70}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 357}
{"function_name": "process", "file_path": "shoryuken/lib/shoryuken/processor.rb", "focal_code": "def process\n      worker_perform = proc do\n        return logger.error { \"No worker found for #{queue}\" } unless worker\n\n        Shoryuken::Logging.with_context(\"#{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id}\") do\n          worker.class.server_middleware.invoke(worker, queue, sqs_msg, body) do\n            worker.perform(sqs_msg, body)\n          end\n        end\n      end\n\n      if Shoryuken.enable_reloading\n        Shoryuken.reloader.call do\n          worker_perform.call\n        end\n      else\n        worker_perform.call\n      end\n    rescue Exception => e\n      Array(Shoryuken.exception_handlers).each { |handler| handler.call(e, queue, sqs_msg) }\n\n      raise\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Processes SQS messages by invoking the appropriate worker.\n  # Handles middleware chain execution and exception handling.\n  class Processor\n    include Util\n\n    # @return [String] the queue name\n    attr_reader :queue\n\n    # @return [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    attr_reader :sqs_msg\n\n    # Processes a message from a queue\n    #\n    # @param queue [String] the queue name\n    # @param sqs_msg [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    # @return [Object] the result of the worker's perform method\n    def self.process(queue, sqs_msg)\n      new(queue, sqs_msg).process\n    end\n\n    # Initializes a new Processor\n    #\n    # @param queue [String] the queue name\n    # @param sqs_msg [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    def initialize(queue, sqs_msg)\n      @queue   = queue\n      @sqs_msg = sqs_msg\n    end\n\n    # Processes the message through the middleware chain and worker\n    #\n    # @return [Object] the result of the worker's perform method\n    def process\n      worker_perform = proc do\n        return logger.error { \"No worker found for #{queue}\" } unless worker\n\n        Shoryuken::Logging.with_context(\"#{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id}\") do\n          worker.class.server_middleware.invoke(worker, queue, sqs_msg, body) do\n            worker.perform(sqs_msg, body)\n          end\n        end\n      end\n\n      if Shoryuken.enable_reloading\n        Shoryuken.reloader.call do\n          worker_perform.call\n        end\n      else\n        worker_perform.call\n      end\n    rescue Exception => e\n      Array(Shoryuken.exception_handlers).each { |handler| handler.call(e, queue, sqs_msg) }\n\n      raise\n    end\n\n    private\n\n    # Fetches the worker instance for processing\n    #\n    # @return [Object, nil] the worker instance or nil if not found\n    def worker\n      @_worker ||= Shoryuken.worker_registry.fetch_worker(queue, sqs_msg)\n    end\n\n    # Returns the worker class\n    #\n    # @return [Class] the worker class\n    def worker_class\n      worker.class\n    end\n\n    # Parses the message body or bodies for batch processing\n    #\n    # @return [Object, Array<Object>] the parsed body or array of bodies\n    def body\n      @_body ||= sqs_msg.is_a?(Array) ? sqs_msg.map(&method(:parse_body)) : parse_body(sqs_msg)\n    end\n\n    # Parses a single message body\n    #\n    # @param sqs_msg [Aws::SQS::Types::Message] the message to parse\n    # @return [Object] the parsed message body\n    def parse_body(sqs_msg)\n      BodyParser.parse(worker_class, sqs_msg)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "process", "signature": "def process worker_perform = proc do", "start_line": 36, "end_line": 58}, "metadata": {"module": "Shoryuken", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 358}
{"function_name": "shoryuken_class_attribute", "file_path": "shoryuken/lib/shoryuken/worker.rb", "focal_code": "def shoryuken_class_attribute(*attrs) # :nodoc:\n        attrs.each do |name|\n          singleton_class.instance_eval do\n            undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          end\n          define_singleton_method(name) { nil }\n\n          ivar = \"@#{name}\"\n\n          singleton_class.instance_eval do\n            m = \"#{name}=\"\n            undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          end\n\n          define_singleton_method(\"#{name}=\") do |val|\n            singleton_class.class_eval do\n              undef_method(name) if method_defined?(name) || private_method_defined?(name)\n              define_method(name) { val }\n            end\n\n            # singleton? backwards compatibility for ruby < 2.1\n            singleton_klass = respond_to?(:singleton?) ? singleton? : self != ancestors.first\n\n            if singleton_klass\n              class_eval do\n                undef_method(name) if method_defined?(name) || private_method_defined?(name)\n                define_method(name) do\n                  if instance_variable_defined? ivar\n                    instance_variable_get ivar\n                  else\n                    singleton_class.send name\n                  end\n                end\n              end\n            end\n            val\n          end\n\n          # instance reader\n          undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          define_method(name) do\n            if instance_variable_defined?(ivar)\n              instance_variable_get ivar\n            else\n              self.class.public_send name\n            end\n          end\n\n          # instance writer\n          m = \"#{name}=\"\n          undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          attr_writer name\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Worker module provides the core functionality for creating Shoryuken workers\n  # that process messages from Amazon SQS queues.\n  #\n  # Including this module in a class provides methods for configuring queue processing,\n  # enqueueing jobs, and setting up middleware. Workers can be configured for different\n  # processing patterns including single message processing, batch processing, and\n  # various retry and visibility timeout strategies.\n  #\n  # @example Basic worker implementation\n  #   class EmailWorker\n  #     include Shoryuken::Worker\n  #     shoryuken_options queue: 'emails'\n  #\n  #     def perform(sqs_msg, body)\n  #       send_email(body['recipient'], body['subject'], body['content'])\n  #     end\n  #   end\n  #\n  # @example Advanced worker with all options\n  #   class AdvancedWorker\n  #     include Shoryuken::Worker\n  #\n  #     shoryuken_options queue: 'advanced_queue',\n  #                       batch: false,\n  #                       auto_delete: true,\n  #                       auto_visibility_timeout: true,\n  #                       retry_intervals: [1, 5, 25, 125, 625]\n  #\n  #     server_middleware do |chain|\n  #       chain.add MyCustomMiddleware\n  #     end\n  #\n  #     def perform(sqs_msg, body)\n  #       # Worker implementation\n  #     end\n  #   end\n  #\n  # @see ClassMethods#shoryuken_options Primary configuration method\n  # @see ClassMethods#perform_async For enqueueing jobs\n  # @see https://github.com/ruby-shoryuken/shoryuken/wiki/Workers Comprehensive worker documentation\n  module Worker\n    # Sets up the including class with Shoryuken worker functionality\n    #\n    # @param base [Class] the class including this module\n    # @return [void]\n    def self.included(base)\n      base.extend(ClassMethods)\n      base.shoryuken_class_attribute :shoryuken_options_hash\n    end\n\n    # Class methods added to classes that include Shoryuken::Worker.\n    # Provides methods for configuring the worker, enqueueing jobs, and managing middleware.\n    module ClassMethods\n      # Enqueues a job to be processed asynchronously by a Shoryuken worker.\n      #\n      # @param body [Object] The job payload that will be passed to the worker's perform method\n      # @param options [Hash] Additional options for job enqueueing\n      # @option options [String] :message_group_id FIFO queue group ID for message ordering\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @option options [Hash] :message_attributes Custom SQS message attributes\n      # @return [String] The message ID of the enqueued job\n      #\n      # @example Basic job enqueueing\n      #   MyWorker.perform_async({ user_id: 123, action: 'send_email' })\n      #\n      # @example FIFO queue with ordering\n      #   MyWorker.perform_async(data, message_group_id: 'user_123')\n      def perform_async(body, options = {})\n        Shoryuken.worker_executor.perform_async(self, body, options)\n      end\n\n      # Enqueues a job to be processed after a specified time interval.\n      #\n      # @param interval [Integer, ActiveSupport::Duration] Delay in seconds, or duration object\n      # @param body [Object] The job payload that will be passed to the worker's perform method\n      # @param options [Hash] SQS message options for the delayed job\n      # @option options [String] :message_group_id FIFO queue group ID for message ordering\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @option options [Hash] :message_attributes Custom SQS message attributes\n      # @return [String] The message ID of the enqueued job\n      #\n      # @example Delay job by 5 minutes\n      #   MyWorker.perform_in(5.minutes, { user_id: 123 })\n      #\n      # @example Delay job by specific number of seconds\n      #   MyWorker.perform_in(300, { user_id: 123 })\n      def perform_in(interval, body, options = {})\n        Shoryuken.worker_executor.perform_in(self, interval, body, options)\n      end\n\n      alias_method :perform_at, :perform_in\n\n      # Configures server-side middleware chain for this worker class.\n      # Middleware runs before and after job processing, similar to Rack middleware.\n      #\n      # @yield [Shoryuken::Middleware::Chain] The middleware chain for configuration\n      # @return [Shoryuken::Middleware::Chain] The configured middleware chain\n      #\n      # @example Adding custom middleware\n      #   class MyWorker\n      #     include Shoryuken::Worker\n      #\n      #     server_middleware do |chain|\n      #       chain.add MyCustomMiddleware\n      #       chain.remove Shoryuken::Middleware::Server::ActiveRecord\n      #     end\n      #   end\n      def server_middleware\n        @_server_chain ||= Shoryuken.server_middleware.dup\n        yield @_server_chain if block_given?\n        @_server_chain\n      end\n\n      # Configures worker options including queue assignment, processing behavior,\n      # and SQS-specific settings. This is the main configuration method for workers.\n      #\n      # @param opts [Hash] Configuration options for the worker\n      # @option opts [String, Array<String>] :queue Queue name(s) this worker processes\n      # @option opts [Boolean] :batch (false) Process messages in batches of up to 10\n      # @option opts [Boolean] :auto_delete (false) Automatically delete messages after processing\n      # @option opts [Boolean] :auto_visibility_timeout (false) Automatically extend message visibility\n      # @option opts [Array<Integer>] :retry_intervals Exponential backoff retry intervals in seconds\n      # @option opts [Array<Class>, Proc] :non_retryable_exceptions Exception classes or lambda that should skip retries and delete message immediately\n      # @option opts [Hash] :sqs Additional SQS client options\n      #\n      # @example Basic worker configuration\n      #   class MyWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'my_queue'\n      #\n      #     def perform(sqs_msg, body)\n      #       # Process the message\n      #     end\n      #   end\n      #\n      # @example Worker with auto-delete and retries\n      #   class ReliableWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'important_queue',\n      #                       auto_delete: true,\n      #                       retry_intervals: [1, 5, 25, 125]\n      #   end\n      #\n      # @example Batch processing worker\n      #   class BatchWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'batch_queue', batch: true\n      #\n      #     def perform(sqs_msgs, bodies)\n      #       # Process array of up to 10 messages\n      #       bodies.each { |body| process_item(body) }\n      #     end\n      #   end\n      #\n      # @example Multiple queues with priorities\n      #   class MultiQueueWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: ['high_priority', 'low_priority']\n      #   end\n      #\n      # @example Auto-extending visibility timeout for long-running jobs\n      #   class LongRunningWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'slow_queue',\n      #                       auto_visibility_timeout: true\n      #\n      #     def perform(sqs_msg, body)\n      #       # Long processing that might exceed visibility timeout\n      #       complex_processing(body)\n      #     end\n      #   end\n      #\n      # @example Worker with non-retryable exceptions\n      #   class ValidationWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'validation_queue',\n      #                       non_retryable_exceptions: [InvalidInputError, RecordNotFoundError]\n      #\n      #     def perform(sqs_msg, body)\n      #       # If InvalidInputError or RecordNotFoundError is raised,\n      #       # the message will be deleted immediately instead of retrying\n      #       validate_and_process(body)\n      #     end\n      #   end\n      #\n      # @example Worker with lambda for dynamic exception classification\n      #   class SmartWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'smart_queue',\n      #                       non_retryable_exceptions: ->(error) {\n      #                         error.is_a?(ValidationError) || \n      #                         (error.is_a?(NetworkError) && error.message.include?('permanent'))\n      #                       }\n      #\n      #     def perform(sqs_msg, body)\n      #       # Lambda receives the exception and returns true if non-retryable\n      #       process_with_validation(body)\n      #     end\n      #   end\n      def shoryuken_options(opts = {})\n        self.shoryuken_options_hash = get_shoryuken_options.merge(stringify_keys(opts || {}))\n        normalize_worker_queue!\n      end\n\n      # Checks if automatic visibility timeout extension is enabled for this worker.\n      # When enabled, Shoryuken automatically extends the message visibility timeout\n      # during processing to prevent the message from becoming visible to other consumers.\n      #\n      # @return [Boolean] true if auto visibility timeout is enabled\n      #\n      # @see #shoryuken_options Documentation for enabling auto_visibility_timeout\n      def auto_visibility_timeout?\n        !!get_shoryuken_options['auto_visibility_timeout']\n      end\n\n      # Checks if exponential backoff retry is configured for this worker.\n      # When retry intervals are specified, failed jobs will be retried with\n      # increasing delays between attempts.\n      #\n      # @return [Boolean] true if retry intervals are configured\n      #\n      # @example Configuring exponential backoff\n      #   shoryuken_options retry_intervals: [1, 5, 25, 125, 625]\n      #   # Will retry after 1s, 5s, 25s, 125s, then 625s before giving up\n      #\n      # @see #shoryuken_options Documentation for configuring retry_intervals\n      def exponential_backoff?\n        !!get_shoryuken_options['retry_intervals']\n      end\n\n      # Checks if automatic message deletion is enabled for this worker.\n      # When enabled, successfully processed messages are automatically deleted\n      # from the SQS queue. When disabled, you must manually delete messages\n      # or they will become visible again after the visibility timeout.\n      #\n      # @return [Boolean] true if auto delete is enabled\n      #\n      # @example Manual message deletion when auto_delete is false\n      #   def perform(sqs_msg, body)\n      #     process_message(body)\n      #     # Manually delete the message after successful processing\n      #     sqs_msg.delete\n      #   end\n      #\n      # @see #shoryuken_options Documentation for enabling auto_delete\n      def auto_delete?\n        !!(get_shoryuken_options['delete'] || get_shoryuken_options['auto_delete'])\n      end\n\n      # Returns the shoryuken options for this worker class\n      # @return [Hash] the options hash\n      def get_shoryuken_options # :nodoc:\n        shoryuken_options_hash || Shoryuken.default_worker_options\n      end\n\n      # Converts hash keys to strings\n      # @param hash [Hash] the hash to convert\n      # @return [Hash] hash with string keys\n      def stringify_keys(hash) # :nodoc:\n        new_hash = {}\n        hash.each { |key, value| new_hash[key.to_s] = value }\n        new_hash\n      end\n\n      # Defines inheritable class attributes for workers\n      # @param attrs [Array<Symbol>] attribute names to define\n      # @return [void]\n      def shoryuken_class_attribute(*attrs) # :nodoc:\n        attrs.each do |name|\n          singleton_class.instance_eval do\n            undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          end\n          define_singleton_method(name) { nil }\n\n          ivar = \"@#{name}\"\n\n          singleton_class.instance_eval do\n            m = \"#{name}=\"\n            undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          end\n\n          define_singleton_method(\"#{name}=\") do |val|\n            singleton_class.class_eval do\n              undef_method(name) if method_defined?(name) || private_method_defined?(name)\n              define_method(name) { val }\n            end\n\n            # singleton? backwards compatibility for ruby < 2.1\n            singleton_klass = respond_to?(:singleton?) ? singleton? : self != ancestors.first\n\n            if singleton_klass\n              class_eval do\n                undef_method(name) if method_defined?(name) || private_method_defined?(name)\n                define_method(name) do\n                  if instance_variable_defined? ivar\n                    instance_variable_get ivar\n                  else\n                    singleton_class.send name\n                  end\n                end\n              end\n            end\n            val\n          end\n\n          # instance reader\n          undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          define_method(name) do\n            if instance_variable_defined?(ivar)\n              instance_variable_get ivar\n            else\n              self.class.public_send name\n            end\n          end\n\n          # instance writer\n          m = \"#{name}=\"\n          undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          attr_writer name\n        end\n      end\n\n      private\n\n      # Normalizes the queue option and registers the worker\n      # @return [void]\n      def normalize_worker_queue!\n        queue = shoryuken_options_hash['queue']\n        if queue.respond_to?(:call)\n          queue = queue.call\n          shoryuken_options_hash['queue'] = queue\n        end\n\n        case shoryuken_options_hash['queue']\n        when Array\n          shoryuken_options_hash['queue'].map!(&:to_s)\n        when Symbol\n          shoryuken_options_hash['queue'] = shoryuken_options_hash['queue'].to_s\n        end\n\n        [shoryuken_options_hash['queue']].flatten.compact.each(&method(:register_worker))\n      end\n\n      # Registers this worker class for a queue\n      # @param queue [String] the queue name\n      # @return [void]\n      def register_worker(queue)\n        Shoryuken.register_worker(queue, self)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "shoryuken_class_attribute", "signature": "def shoryuken_class_attribute(*attrs) # :nodoc:", "start_line": 271, "end_line": 324}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 359}
{"function_name": "normalize_worker_queue!", "file_path": "shoryuken/lib/shoryuken/worker.rb", "focal_code": "def normalize_worker_queue!\n        queue = shoryuken_options_hash['queue']\n        if queue.respond_to?(:call)\n          queue = queue.call\n          shoryuken_options_hash['queue'] = queue\n        end\n\n        case shoryuken_options_hash['queue']\n        when Array\n          shoryuken_options_hash['queue'].map!(&:to_s)\n        when Symbol\n          shoryuken_options_hash['queue'] = shoryuken_options_hash['queue'].to_s\n        end\n\n        [shoryuken_options_hash['queue']].flatten.compact.each(&method(:register_worker))\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Worker module provides the core functionality for creating Shoryuken workers\n  # that process messages from Amazon SQS queues.\n  #\n  # Including this module in a class provides methods for configuring queue processing,\n  # enqueueing jobs, and setting up middleware. Workers can be configured for different\n  # processing patterns including single message processing, batch processing, and\n  # various retry and visibility timeout strategies.\n  #\n  # @example Basic worker implementation\n  #   class EmailWorker\n  #     include Shoryuken::Worker\n  #     shoryuken_options queue: 'emails'\n  #\n  #     def perform(sqs_msg, body)\n  #       send_email(body['recipient'], body['subject'], body['content'])\n  #     end\n  #   end\n  #\n  # @example Advanced worker with all options\n  #   class AdvancedWorker\n  #     include Shoryuken::Worker\n  #\n  #     shoryuken_options queue: 'advanced_queue',\n  #                       batch: false,\n  #                       auto_delete: true,\n  #                       auto_visibility_timeout: true,\n  #                       retry_intervals: [1, 5, 25, 125, 625]\n  #\n  #     server_middleware do |chain|\n  #       chain.add MyCustomMiddleware\n  #     end\n  #\n  #     def perform(sqs_msg, body)\n  #       # Worker implementation\n  #     end\n  #   end\n  #\n  # @see ClassMethods#shoryuken_options Primary configuration method\n  # @see ClassMethods#perform_async For enqueueing jobs\n  # @see https://github.com/ruby-shoryuken/shoryuken/wiki/Workers Comprehensive worker documentation\n  module Worker\n    # Sets up the including class with Shoryuken worker functionality\n    #\n    # @param base [Class] the class including this module\n    # @return [void]\n    def self.included(base)\n      base.extend(ClassMethods)\n      base.shoryuken_class_attribute :shoryuken_options_hash\n    end\n\n    # Class methods added to classes that include Shoryuken::Worker.\n    # Provides methods for configuring the worker, enqueueing jobs, and managing middleware.\n    module ClassMethods\n      # Enqueues a job to be processed asynchronously by a Shoryuken worker.\n      #\n      # @param body [Object] The job payload that will be passed to the worker's perform method\n      # @param options [Hash] Additional options for job enqueueing\n      # @option options [String] :message_group_id FIFO queue group ID for message ordering\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @option options [Hash] :message_attributes Custom SQS message attributes\n      # @return [String] The message ID of the enqueued job\n      #\n      # @example Basic job enqueueing\n      #   MyWorker.perform_async({ user_id: 123, action: 'send_email' })\n      #\n      # @example FIFO queue with ordering\n      #   MyWorker.perform_async(data, message_group_id: 'user_123')\n      def perform_async(body, options = {})\n        Shoryuken.worker_executor.perform_async(self, body, options)\n      end\n\n      # Enqueues a job to be processed after a specified time interval.\n      #\n      # @param interval [Integer, ActiveSupport::Duration] Delay in seconds, or duration object\n      # @param body [Object] The job payload that will be passed to the worker's perform method\n      # @param options [Hash] SQS message options for the delayed job\n      # @option options [String] :message_group_id FIFO queue group ID for message ordering\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @option options [Hash] :message_attributes Custom SQS message attributes\n      # @return [String] The message ID of the enqueued job\n      #\n      # @example Delay job by 5 minutes\n      #   MyWorker.perform_in(5.minutes, { user_id: 123 })\n      #\n      # @example Delay job by specific number of seconds\n      #   MyWorker.perform_in(300, { user_id: 123 })\n      def perform_in(interval, body, options = {})\n        Shoryuken.worker_executor.perform_in(self, interval, body, options)\n      end\n\n      alias_method :perform_at, :perform_in\n\n      # Configures server-side middleware chain for this worker class.\n      # Middleware runs before and after job processing, similar to Rack middleware.\n      #\n      # @yield [Shoryuken::Middleware::Chain] The middleware chain for configuration\n      # @return [Shoryuken::Middleware::Chain] The configured middleware chain\n      #\n      # @example Adding custom middleware\n      #   class MyWorker\n      #     include Shoryuken::Worker\n      #\n      #     server_middleware do |chain|\n      #       chain.add MyCustomMiddleware\n      #       chain.remove Shoryuken::Middleware::Server::ActiveRecord\n      #     end\n      #   end\n      def server_middleware\n        @_server_chain ||= Shoryuken.server_middleware.dup\n        yield @_server_chain if block_given?\n        @_server_chain\n      end\n\n      # Configures worker options including queue assignment, processing behavior,\n      # and SQS-specific settings. This is the main configuration method for workers.\n      #\n      # @param opts [Hash] Configuration options for the worker\n      # @option opts [String, Array<String>] :queue Queue name(s) this worker processes\n      # @option opts [Boolean] :batch (false) Process messages in batches of up to 10\n      # @option opts [Boolean] :auto_delete (false) Automatically delete messages after processing\n      # @option opts [Boolean] :auto_visibility_timeout (false) Automatically extend message visibility\n      # @option opts [Array<Integer>] :retry_intervals Exponential backoff retry intervals in seconds\n      # @option opts [Array<Class>, Proc] :non_retryable_exceptions Exception classes or lambda that should skip retries and delete message immediately\n      # @option opts [Hash] :sqs Additional SQS client options\n      #\n      # @example Basic worker configuration\n      #   class MyWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'my_queue'\n      #\n      #     def perform(sqs_msg, body)\n      #       # Process the message\n      #     end\n      #   end\n      #\n      # @example Worker with auto-delete and retries\n      #   class ReliableWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'important_queue',\n      #                       auto_delete: true,\n      #                       retry_intervals: [1, 5, 25, 125]\n      #   end\n      #\n      # @example Batch processing worker\n      #   class BatchWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'batch_queue', batch: true\n      #\n      #     def perform(sqs_msgs, bodies)\n      #       # Process array of up to 10 messages\n      #       bodies.each { |body| process_item(body) }\n      #     end\n      #   end\n      #\n      # @example Multiple queues with priorities\n      #   class MultiQueueWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: ['high_priority', 'low_priority']\n      #   end\n      #\n      # @example Auto-extending visibility timeout for long-running jobs\n      #   class LongRunningWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'slow_queue',\n      #                       auto_visibility_timeout: true\n      #\n      #     def perform(sqs_msg, body)\n      #       # Long processing that might exceed visibility timeout\n      #       complex_processing(body)\n      #     end\n      #   end\n      #\n      # @example Worker with non-retryable exceptions\n      #   class ValidationWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'validation_queue',\n      #                       non_retryable_exceptions: [InvalidInputError, RecordNotFoundError]\n      #\n      #     def perform(sqs_msg, body)\n      #       # If InvalidInputError or RecordNotFoundError is raised,\n      #       # the message will be deleted immediately instead of retrying\n      #       validate_and_process(body)\n      #     end\n      #   end\n      #\n      # @example Worker with lambda for dynamic exception classification\n      #   class SmartWorker\n      #     include Shoryuken::Worker\n      #     shoryuken_options queue: 'smart_queue',\n      #                       non_retryable_exceptions: ->(error) {\n      #                         error.is_a?(ValidationError) || \n      #                         (error.is_a?(NetworkError) && error.message.include?('permanent'))\n      #                       }\n      #\n      #     def perform(sqs_msg, body)\n      #       # Lambda receives the exception and returns true if non-retryable\n      #       process_with_validation(body)\n      #     end\n      #   end\n      def shoryuken_options(opts = {})\n        self.shoryuken_options_hash = get_shoryuken_options.merge(stringify_keys(opts || {}))\n        normalize_worker_queue!\n      end\n\n      # Checks if automatic visibility timeout extension is enabled for this worker.\n      # When enabled, Shoryuken automatically extends the message visibility timeout\n      # during processing to prevent the message from becoming visible to other consumers.\n      #\n      # @return [Boolean] true if auto visibility timeout is enabled\n      #\n      # @see #shoryuken_options Documentation for enabling auto_visibility_timeout\n      def auto_visibility_timeout?\n        !!get_shoryuken_options['auto_visibility_timeout']\n      end\n\n      # Checks if exponential backoff retry is configured for this worker.\n      # When retry intervals are specified, failed jobs will be retried with\n      # increasing delays between attempts.\n      #\n      # @return [Boolean] true if retry intervals are configured\n      #\n      # @example Configuring exponential backoff\n      #   shoryuken_options retry_intervals: [1, 5, 25, 125, 625]\n      #   # Will retry after 1s, 5s, 25s, 125s, then 625s before giving up\n      #\n      # @see #shoryuken_options Documentation for configuring retry_intervals\n      def exponential_backoff?\n        !!get_shoryuken_options['retry_intervals']\n      end\n\n      # Checks if automatic message deletion is enabled for this worker.\n      # When enabled, successfully processed messages are automatically deleted\n      # from the SQS queue. When disabled, you must manually delete messages\n      # or they will become visible again after the visibility timeout.\n      #\n      # @return [Boolean] true if auto delete is enabled\n      #\n      # @example Manual message deletion when auto_delete is false\n      #   def perform(sqs_msg, body)\n      #     process_message(body)\n      #     # Manually delete the message after successful processing\n      #     sqs_msg.delete\n      #   end\n      #\n      # @see #shoryuken_options Documentation for enabling auto_delete\n      def auto_delete?\n        !!(get_shoryuken_options['delete'] || get_shoryuken_options['auto_delete'])\n      end\n\n      # Returns the shoryuken options for this worker class\n      # @return [Hash] the options hash\n      def get_shoryuken_options # :nodoc:\n        shoryuken_options_hash || Shoryuken.default_worker_options\n      end\n\n      # Converts hash keys to strings\n      # @param hash [Hash] the hash to convert\n      # @return [Hash] hash with string keys\n      def stringify_keys(hash) # :nodoc:\n        new_hash = {}\n        hash.each { |key, value| new_hash[key.to_s] = value }\n        new_hash\n      end\n\n      # Defines inheritable class attributes for workers\n      # @param attrs [Array<Symbol>] attribute names to define\n      # @return [void]\n      def shoryuken_class_attribute(*attrs) # :nodoc:\n        attrs.each do |name|\n          singleton_class.instance_eval do\n            undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          end\n          define_singleton_method(name) { nil }\n\n          ivar = \"@#{name}\"\n\n          singleton_class.instance_eval do\n            m = \"#{name}=\"\n            undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          end\n\n          define_singleton_method(\"#{name}=\") do |val|\n            singleton_class.class_eval do\n              undef_method(name) if method_defined?(name) || private_method_defined?(name)\n              define_method(name) { val }\n            end\n\n            # singleton? backwards compatibility for ruby < 2.1\n            singleton_klass = respond_to?(:singleton?) ? singleton? : self != ancestors.first\n\n            if singleton_klass\n              class_eval do\n                undef_method(name) if method_defined?(name) || private_method_defined?(name)\n                define_method(name) do\n                  if instance_variable_defined? ivar\n                    instance_variable_get ivar\n                  else\n                    singleton_class.send name\n                  end\n                end\n              end\n            end\n            val\n          end\n\n          # instance reader\n          undef_method(name) if method_defined?(name) || private_method_defined?(name)\n          define_method(name) do\n            if instance_variable_defined?(ivar)\n              instance_variable_get ivar\n            else\n              self.class.public_send name\n            end\n          end\n\n          # instance writer\n          m = \"#{name}=\"\n          undef_method(m) if method_defined?(m) || private_method_defined?(m)\n          attr_writer name\n        end\n      end\n\n      private\n\n      # Normalizes the queue option and registers the worker\n      # @return [void]\n      def normalize_worker_queue!\n        queue = shoryuken_options_hash['queue']\n        if queue.respond_to?(:call)\n          queue = queue.call\n          shoryuken_options_hash['queue'] = queue\n        end\n\n        case shoryuken_options_hash['queue']\n        when Array\n          shoryuken_options_hash['queue'].map!(&:to_s)\n        when Symbol\n          shoryuken_options_hash['queue'] = shoryuken_options_hash['queue'].to_s\n        end\n\n        [shoryuken_options_hash['queue']].flatten.compact.each(&method(:register_worker))\n      end\n\n      # Registers this worker class for a queue\n      # @param queue [String] the queue name\n      # @return [void]\n      def register_worker(queue)\n        Shoryuken.register_worker(queue, self)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "normalize_worker_queue!", "signature": "def normalize_worker_queue! queue = shoryuken_options_hash['queue']", "start_line": 330, "end_line": 345}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 360}
{"function_name": "fetch", "file_path": "shoryuken/lib/shoryuken/fetcher.rb", "focal_code": "def fetch(queue, limit)\n      fetch_with_auto_retry(3) do\n        started_at = Time.now\n\n        logger.debug { \"Looking for new messages in #{queue}\" }\n\n        sqs_msgs = Array(receive_messages(queue, limit))\n\n        logger.debug { \"Found #{sqs_msgs.size} messages for #{queue.name}\" } unless sqs_msgs.empty?\n        logger.debug { \"Fetcher for #{queue} completed in #{elapsed(started_at)} ms\" }\n\n        sqs_msgs\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Fetches messages from SQS queues.\n  # Handles message retrieval with automatic retry on connectivity errors.\n  class Fetcher\n    include Util\n\n    # Maximum number of messages that can be fetched in a single SQS request\n    FETCH_LIMIT = 10\n\n    # Initializes a new Fetcher for a processing group\n    #\n    # @param group [String] the processing group name\n    def initialize(group)\n      @group = group\n    end\n\n    # Fetches messages from a queue with automatic retry\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @param limit [Integer] the maximum number of messages to fetch\n    # @return [Array<Aws::SQS::Types::Message>] the fetched messages\n    def fetch(queue, limit)\n      fetch_with_auto_retry(3) do\n        started_at = Time.now\n\n        logger.debug { \"Looking for new messages in #{queue}\" }\n\n        sqs_msgs = Array(receive_messages(queue, limit))\n\n        logger.debug { \"Found #{sqs_msgs.size} messages for #{queue.name}\" } unless sqs_msgs.empty?\n        logger.debug { \"Fetcher for #{queue} completed in #{elapsed(started_at)} ms\" }\n\n        sqs_msgs\n      end\n    end\n\n    private\n\n    # Fetches with automatic retry on errors\n    #\n    # @param max_attempts [Integer] maximum number of retry attempts\n    # @yield the fetch operation to retry\n    # @return [Object] the result of the block\n    def fetch_with_auto_retry(max_attempts)\n      attempts = 0\n\n      begin\n        yield\n      rescue => e\n        # Tries to auto retry connectivity errors\n        raise if attempts >= max_attempts\n\n        attempts += 1\n\n        logger.debug { \"Retrying fetch attempt #{attempts} for #{e.message}\" }\n\n        sleep((1..5).to_a.sample)\n\n        retry\n      end\n    end\n\n    # Receives messages from an SQS queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @param limit [Integer] the maximum number of messages to receive\n    # @return [Array<Aws::SQS::Types::Message>, nil] the received messages\n    def receive_messages(queue, limit)\n      options = receive_options(queue)\n\n      shoryuken_queue = Shoryuken::Client.queues(queue.name)\n\n      options[:max_number_of_messages]  = max_number_of_messages(shoryuken_queue, limit, options)\n      options[:message_attribute_names] = %w[All]\n      options[:attribute_names]         = %w[All]\n\n      options.merge!(queue.options)\n\n      shoryuken_queue.receive_messages(options)\n    end\n\n    # Determines the maximum number of messages to fetch\n    #\n    # @param shoryuken_queue [Shoryuken::Queue] the queue instance\n    # @param limit [Integer] the requested limit\n    # @param options [Hash] receive options that may contain max_number_of_messages\n    # @option options [Integer] :max_number_of_messages optional override for max messages\n    # @return [Integer] the maximum number of messages to fetch\n    def max_number_of_messages(shoryuken_queue, limit, options)\n      # For FIFO queues we want to make sure we process one message per group at a time\n      # if we set max_number_of_messages greater than 1,\n      # SQS may return more than one message for the same message group\n      # since Shoryuken uses threads, it will try to process more than one message at once\n      # > The message group ID is the tag that specifies that a message belongs to a specific message group.\n      # > Messages that belong to the same message group are always processed one by one,\n      # > in a strict order relative to the message group\n      # > (however, messages that belong to different message groups might be processed out of order).\n      # > https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html\n      limit = 1 if shoryuken_queue.fifo? && !batched_queue?(shoryuken_queue)\n\n      [limit, FETCH_LIMIT, options[:max_number_of_messages]].compact.min\n    end\n\n    # Returns the receive options for a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [Hash] the receive options hash\n    def receive_options(queue)\n      options = Shoryuken.sqs_client_receive_message_opts[queue.name]\n      options ||= Shoryuken.sqs_client_receive_message_opts[@group]\n\n      options.to_h.dup\n    end\n\n    # Checks if a queue uses batch message processing\n    #\n    # @param queue [Shoryuken::Queue] the queue to check\n    # @return [Boolean] true if the queue is configured for batch processing\n    def batched_queue?(queue)\n      Shoryuken.worker_registry.batch_receive_messages?(queue.name)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "fetch", "signature": "def fetch(queue, limit)", "start_line": 24, "end_line": 37}, "metadata": {"module": "Shoryuken", "class_name": "Fetcher", "class_signature": "class Fetcher"}, "task_id": 361}
{"function_name": "fetch_with_auto_retry", "file_path": "shoryuken/lib/shoryuken/fetcher.rb", "focal_code": "def fetch_with_auto_retry(max_attempts)\n      attempts = 0\n\n      begin\n        yield\n      rescue => e\n        # Tries to auto retry connectivity errors\n        raise if attempts >= max_attempts\n\n        attempts += 1\n\n        logger.debug { \"Retrying fetch attempt #{attempts} for #{e.message}\" }\n\n        sleep((1..5).to_a.sample)\n\n        retry\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Fetches messages from SQS queues.\n  # Handles message retrieval with automatic retry on connectivity errors.\n  class Fetcher\n    include Util\n\n    # Maximum number of messages that can be fetched in a single SQS request\n    FETCH_LIMIT = 10\n\n    # Initializes a new Fetcher for a processing group\n    #\n    # @param group [String] the processing group name\n    def initialize(group)\n      @group = group\n    end\n\n    # Fetches messages from a queue with automatic retry\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @param limit [Integer] the maximum number of messages to fetch\n    # @return [Array<Aws::SQS::Types::Message>] the fetched messages\n    def fetch(queue, limit)\n      fetch_with_auto_retry(3) do\n        started_at = Time.now\n\n        logger.debug { \"Looking for new messages in #{queue}\" }\n\n        sqs_msgs = Array(receive_messages(queue, limit))\n\n        logger.debug { \"Found #{sqs_msgs.size} messages for #{queue.name}\" } unless sqs_msgs.empty?\n        logger.debug { \"Fetcher for #{queue} completed in #{elapsed(started_at)} ms\" }\n\n        sqs_msgs\n      end\n    end\n\n    private\n\n    # Fetches with automatic retry on errors\n    #\n    # @param max_attempts [Integer] maximum number of retry attempts\n    # @yield the fetch operation to retry\n    # @return [Object] the result of the block\n    def fetch_with_auto_retry(max_attempts)\n      attempts = 0\n\n      begin\n        yield\n      rescue => e\n        # Tries to auto retry connectivity errors\n        raise if attempts >= max_attempts\n\n        attempts += 1\n\n        logger.debug { \"Retrying fetch attempt #{attempts} for #{e.message}\" }\n\n        sleep((1..5).to_a.sample)\n\n        retry\n      end\n    end\n\n    # Receives messages from an SQS queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @param limit [Integer] the maximum number of messages to receive\n    # @return [Array<Aws::SQS::Types::Message>, nil] the received messages\n    def receive_messages(queue, limit)\n      options = receive_options(queue)\n\n      shoryuken_queue = Shoryuken::Client.queues(queue.name)\n\n      options[:max_number_of_messages]  = max_number_of_messages(shoryuken_queue, limit, options)\n      options[:message_attribute_names] = %w[All]\n      options[:attribute_names]         = %w[All]\n\n      options.merge!(queue.options)\n\n      shoryuken_queue.receive_messages(options)\n    end\n\n    # Determines the maximum number of messages to fetch\n    #\n    # @param shoryuken_queue [Shoryuken::Queue] the queue instance\n    # @param limit [Integer] the requested limit\n    # @param options [Hash] receive options that may contain max_number_of_messages\n    # @option options [Integer] :max_number_of_messages optional override for max messages\n    # @return [Integer] the maximum number of messages to fetch\n    def max_number_of_messages(shoryuken_queue, limit, options)\n      # For FIFO queues we want to make sure we process one message per group at a time\n      # if we set max_number_of_messages greater than 1,\n      # SQS may return more than one message for the same message group\n      # since Shoryuken uses threads, it will try to process more than one message at once\n      # > The message group ID is the tag that specifies that a message belongs to a specific message group.\n      # > Messages that belong to the same message group are always processed one by one,\n      # > in a strict order relative to the message group\n      # > (however, messages that belong to different message groups might be processed out of order).\n      # > https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html\n      limit = 1 if shoryuken_queue.fifo? && !batched_queue?(shoryuken_queue)\n\n      [limit, FETCH_LIMIT, options[:max_number_of_messages]].compact.min\n    end\n\n    # Returns the receive options for a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [Hash] the receive options hash\n    def receive_options(queue)\n      options = Shoryuken.sqs_client_receive_message_opts[queue.name]\n      options ||= Shoryuken.sqs_client_receive_message_opts[@group]\n\n      options.to_h.dup\n    end\n\n    # Checks if a queue uses batch message processing\n    #\n    # @param queue [Shoryuken::Queue] the queue to check\n    # @return [Boolean] true if the queue is configured for batch processing\n    def batched_queue?(queue)\n      Shoryuken.worker_registry.batch_receive_messages?(queue.name)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "fetch_with_auto_retry", "signature": "def fetch_with_auto_retry(max_attempts)", "start_line": 46, "end_line": 63}, "metadata": {"module": "Shoryuken", "class_name": "Fetcher", "class_signature": "class Fetcher"}, "task_id": 362}
{"function_name": "initialize_rails", "file_path": "shoryuken/lib/shoryuken/environment_loader.rb", "focal_code": "def initialize_rails\n      # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb\n\n      require 'rails'\n      if ::Rails::VERSION::MAJOR < 4\n        require File.expand_path('config/environment.rb')\n        ::Rails.application.eager_load!\n      else\n        # Painful contortions, see 1791 for discussion\n        require File.expand_path('config/application.rb')\n        if ::Rails::VERSION::MAJOR == 4\n          ::Rails::Application.initializer 'shoryuken.eager_load' do\n            ::Rails.application.config.eager_load = true\n          end\n        end\n        ::Rails::Application.initializer 'shoryuken.set_reloader_hook' do |app|\n          Shoryuken.reloader = proc do |&block|\n            app.reloader.wrap do\n              block.call\n            end\n          end\n        end\n        if Shoryuken.active_job?\n          require 'active_job/extensions'\n          require 'active_job/queue_adapters/shoryuken_adapter'\n          require 'active_job/queue_adapters/shoryuken_concurrent_send_adapter'\n        end\n        require File.expand_path('config/environment.rb')\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Loads and configures the Shoryuken environment from configuration files\n  # and command line options. Handles Rails integration and queue setup.\n  class EnvironmentLoader\n    # @return [Hash] the configuration options\n    attr_reader :options\n\n    # Sets up a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    # @return [Shoryuken::EnvironmentLoader] the configured instance\n    def self.setup_options(options)\n      instance = new(options)\n      instance.setup_options\n      instance\n    end\n\n    # Loads the environment for Rails console usage\n    #\n    # @return [void]\n    def self.load_for_rails_console\n      instance = setup_options(config_file: (Rails.root + 'config' + 'shoryuken.yml'))\n      instance.load\n    end\n\n    # Initializes a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    def initialize(options)\n      @options = options\n    end\n\n    # Sets up configuration options from file and initializes components\n    #\n    # @return [void]\n    def setup_options\n      initialize_rails if load_rails?\n      initialize_options\n      initialize_logger\n    end\n\n    # Loads the environment including queues and workers\n    #\n    # @return [void]\n    def load\n      prefix_active_job_queue_names\n      parse_queues\n      require_workers\n      validate_queues\n      validate_workers\n    end\n\n    private\n\n    # Merges configuration file options with runtime options\n    #\n    # @return [void]\n    def initialize_options\n      Shoryuken.options.merge!(config_file_options)\n      Shoryuken.options.merge!(options)\n    end\n\n    # Reads and parses the configuration file\n    #\n    # @return [Hash] the parsed configuration options\n    def config_file_options\n      return {} unless (path = options[:config_file])\n\n      raise Errors::InvalidConfigurationError, \"The supplied config file #{path} does not exist\" unless File.exist?(path)\n\n      if (result = YAML.load(ERB.new(IO.read(path)).result))\n        Shoryuken::Helpers::HashUtils.deep_symbolize_keys(result)\n      else\n        {}\n      end\n    end\n\n    # Initializes the logger with file output and verbosity settings\n    #\n    # @return [void]\n    def initialize_logger\n      Shoryuken::Logging.initialize_logger(Shoryuken.options[:logfile]) if Shoryuken.options[:logfile]\n      Shoryuken.logger.level = Logger::DEBUG if Shoryuken.options[:verbose]\n    end\n\n    # Initializes the Rails environment\n    #\n    # @return [void]\n    def initialize_rails\n      # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb\n\n      require 'rails'\n      if ::Rails::VERSION::MAJOR < 4\n        require File.expand_path('config/environment.rb')\n        ::Rails.application.eager_load!\n      else\n        # Painful contortions, see 1791 for discussion\n        require File.expand_path('config/application.rb')\n        if ::Rails::VERSION::MAJOR == 4\n          ::Rails::Application.initializer 'shoryuken.eager_load' do\n            ::Rails.application.config.eager_load = true\n          end\n        end\n        ::Rails::Application.initializer 'shoryuken.set_reloader_hook' do |app|\n          Shoryuken.reloader = proc do |&block|\n            app.reloader.wrap do\n              block.call\n            end\n          end\n        end\n        if Shoryuken.active_job?\n          require 'active_job/extensions'\n          require 'active_job/queue_adapters/shoryuken_adapter'\n          require 'active_job/queue_adapters/shoryuken_concurrent_send_adapter'\n        end\n        require File.expand_path('config/environment.rb')\n      end\n    end\n\n    # Checks if Rails should be loaded\n    #\n    # @return [Boolean] true if Rails should be initialized\n    def load_rails?\n      options[:rails]\n    end\n\n    # Prefixes a queue name with ActiveJob queue name prefix\n    #\n    # @param queue_name [String] the queue name to prefix\n    # @param weight [Integer] the queue weight\n    # @return [Array<String, Integer>] the prefixed queue name and weight\n    def prefix_active_job_queue_name(queue_name, weight)\n      return [queue_name, weight] if queue_name.start_with?('https://', 'arn:')\n\n      queue_name_prefix = ::ActiveJob::Base.queue_name_prefix\n      queue_name_delimiter = ::ActiveJob::Base.queue_name_delimiter\n\n      # See https://github.com/rails/rails/blob/master/activejob/lib/active_job/queue_name.rb#L27\n      name_parts = [queue_name_prefix.presence, queue_name]\n      prefixed_queue_name = name_parts.compact.join(queue_name_delimiter)\n      [prefixed_queue_name, weight]\n    end\n\n    # Prefixes all queue names with ActiveJob prefix if enabled\n    #\n    # @return [void]\n    def prefix_active_job_queue_names\n      return unless Shoryuken.active_job?\n      return unless Shoryuken.active_job_queue_name_prefixing?\n\n      Shoryuken.options[:queues].to_a.map! do |queue_name, weight|\n        prefix_active_job_queue_name(queue_name, weight)\n      end\n\n      Shoryuken.options[:groups].to_a.map! do |group, options|\n        if options[:queues]\n          options[:queues].map! do |queue_name, weight|\n            prefix_active_job_queue_name(queue_name, weight)\n          end\n        end\n\n        [group, options]\n      end\n    end\n\n    # Parses a single queue and adds it to a group\n    #\n    # @param queue [String] the queue name\n    # @param weight [Integer] the queue weight\n    # @param group [String] the group name\n    # @return [void]\n    def parse_queue(queue, weight, group)\n      Shoryuken.add_queue(queue, [weight.to_i, 1].max, group)\n    end\n\n    # Parses all queues from configuration and adds them to groups\n    #\n    # @return [void]\n    def parse_queues\n      if Shoryuken.options[:queues].to_a.any?\n        Shoryuken.add_group('default', Shoryuken.options[:concurrency])\n\n        Shoryuken.options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, 'default')\n        end\n      end\n\n      Shoryuken.options[:groups].to_a.each do |group, options|\n        Shoryuken.add_group(group, options[:concurrency], delay: options[:delay], polling_strategy: options[:polling_strategy])\n\n        options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, group)\n        end\n      end\n    end\n\n    # Requires worker files from the configured path\n    #\n    # @return [void]\n    def require_workers\n      required = Shoryuken.options[:require]\n\n      return unless required\n\n      if File.directory?(required)\n        Dir[File.join(required, '**', '*.rb')].each(&method(:require))\n      else\n        require required\n      end\n    end\n\n    # Validates that all configured queues exist in SQS\n    #\n    # @return [void]\n    # @raise [ArgumentError] if any queues do not exist\n    def validate_queues\n      return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?\n\n      non_existent_queues = []\n\n      Shoryuken.ungrouped_queues.uniq.each do |queue|\n        Shoryuken::Client.queues(queue)\n      rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n        non_existent_queues << queue\n      end\n\n      return if non_existent_queues.none?\n\n      # NOTE: HEREDOC's ~ operator removes indents, but is only available Ruby 2.3+\n      # See github PR: https://github.com/ruby-shoryuken/shoryuken/pull/691#issuecomment-1007653595\n      error_msg = <<-MSG.gsub(/^\\s+/, '')\n        The specified queue(s) #{non_existent_queues.join(', ')} do not exist.\n        Try 'shoryuken sqs create QUEUE-NAME' for creating a queue with default settings.\n        It's also possible that you don't have permission to access the specified queues.\n      MSG\n\n      raise Errors::QueueNotFoundError, error_msg\n    end\n\n    # Validates that all queues have registered workers\n    #\n    # @return [void]\n    def validate_workers\n      return if Shoryuken.active_job?\n\n      all_queues = Shoryuken.ungrouped_queues\n      queues_with_workers = Shoryuken.worker_registry.queues\n\n      (all_queues - queues_with_workers).each do |queue|\n        Shoryuken.logger.warn { \"No worker supplied for #{queue}\" }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize_rails", "signature": "def initialize_rails # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb", "start_line": 103, "end_line": 132}, "metadata": {"module": "Shoryuken", "class_name": "EnvironmentLoader", "class_signature": "class EnvironmentLoader"}, "task_id": 363}
{"function_name": "prefix_active_job_queue_names", "file_path": "shoryuken/lib/shoryuken/environment_loader.rb", "focal_code": "def prefix_active_job_queue_names\n      return unless Shoryuken.active_job?\n      return unless Shoryuken.active_job_queue_name_prefixing?\n\n      Shoryuken.options[:queues].to_a.map! do |queue_name, weight|\n        prefix_active_job_queue_name(queue_name, weight)\n      end\n\n      Shoryuken.options[:groups].to_a.map! do |group, options|\n        if options[:queues]\n          options[:queues].map! do |queue_name, weight|\n            prefix_active_job_queue_name(queue_name, weight)\n          end\n        end\n\n        [group, options]\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Loads and configures the Shoryuken environment from configuration files\n  # and command line options. Handles Rails integration and queue setup.\n  class EnvironmentLoader\n    # @return [Hash] the configuration options\n    attr_reader :options\n\n    # Sets up a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    # @return [Shoryuken::EnvironmentLoader] the configured instance\n    def self.setup_options(options)\n      instance = new(options)\n      instance.setup_options\n      instance\n    end\n\n    # Loads the environment for Rails console usage\n    #\n    # @return [void]\n    def self.load_for_rails_console\n      instance = setup_options(config_file: (Rails.root + 'config' + 'shoryuken.yml'))\n      instance.load\n    end\n\n    # Initializes a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    def initialize(options)\n      @options = options\n    end\n\n    # Sets up configuration options from file and initializes components\n    #\n    # @return [void]\n    def setup_options\n      initialize_rails if load_rails?\n      initialize_options\n      initialize_logger\n    end\n\n    # Loads the environment including queues and workers\n    #\n    # @return [void]\n    def load\n      prefix_active_job_queue_names\n      parse_queues\n      require_workers\n      validate_queues\n      validate_workers\n    end\n\n    private\n\n    # Merges configuration file options with runtime options\n    #\n    # @return [void]\n    def initialize_options\n      Shoryuken.options.merge!(config_file_options)\n      Shoryuken.options.merge!(options)\n    end\n\n    # Reads and parses the configuration file\n    #\n    # @return [Hash] the parsed configuration options\n    def config_file_options\n      return {} unless (path = options[:config_file])\n\n      raise Errors::InvalidConfigurationError, \"The supplied config file #{path} does not exist\" unless File.exist?(path)\n\n      if (result = YAML.load(ERB.new(IO.read(path)).result))\n        Shoryuken::Helpers::HashUtils.deep_symbolize_keys(result)\n      else\n        {}\n      end\n    end\n\n    # Initializes the logger with file output and verbosity settings\n    #\n    # @return [void]\n    def initialize_logger\n      Shoryuken::Logging.initialize_logger(Shoryuken.options[:logfile]) if Shoryuken.options[:logfile]\n      Shoryuken.logger.level = Logger::DEBUG if Shoryuken.options[:verbose]\n    end\n\n    # Initializes the Rails environment\n    #\n    # @return [void]\n    def initialize_rails\n      # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb\n\n      require 'rails'\n      if ::Rails::VERSION::MAJOR < 4\n        require File.expand_path('config/environment.rb')\n        ::Rails.application.eager_load!\n      else\n        # Painful contortions, see 1791 for discussion\n        require File.expand_path('config/application.rb')\n        if ::Rails::VERSION::MAJOR == 4\n          ::Rails::Application.initializer 'shoryuken.eager_load' do\n            ::Rails.application.config.eager_load = true\n          end\n        end\n        ::Rails::Application.initializer 'shoryuken.set_reloader_hook' do |app|\n          Shoryuken.reloader = proc do |&block|\n            app.reloader.wrap do\n              block.call\n            end\n          end\n        end\n        if Shoryuken.active_job?\n          require 'active_job/extensions'\n          require 'active_job/queue_adapters/shoryuken_adapter'\n          require 'active_job/queue_adapters/shoryuken_concurrent_send_adapter'\n        end\n        require File.expand_path('config/environment.rb')\n      end\n    end\n\n    # Checks if Rails should be loaded\n    #\n    # @return [Boolean] true if Rails should be initialized\n    def load_rails?\n      options[:rails]\n    end\n\n    # Prefixes a queue name with ActiveJob queue name prefix\n    #\n    # @param queue_name [String] the queue name to prefix\n    # @param weight [Integer] the queue weight\n    # @return [Array<String, Integer>] the prefixed queue name and weight\n    def prefix_active_job_queue_name(queue_name, weight)\n      return [queue_name, weight] if queue_name.start_with?('https://', 'arn:')\n\n      queue_name_prefix = ::ActiveJob::Base.queue_name_prefix\n      queue_name_delimiter = ::ActiveJob::Base.queue_name_delimiter\n\n      # See https://github.com/rails/rails/blob/master/activejob/lib/active_job/queue_name.rb#L27\n      name_parts = [queue_name_prefix.presence, queue_name]\n      prefixed_queue_name = name_parts.compact.join(queue_name_delimiter)\n      [prefixed_queue_name, weight]\n    end\n\n    # Prefixes all queue names with ActiveJob prefix if enabled\n    #\n    # @return [void]\n    def prefix_active_job_queue_names\n      return unless Shoryuken.active_job?\n      return unless Shoryuken.active_job_queue_name_prefixing?\n\n      Shoryuken.options[:queues].to_a.map! do |queue_name, weight|\n        prefix_active_job_queue_name(queue_name, weight)\n      end\n\n      Shoryuken.options[:groups].to_a.map! do |group, options|\n        if options[:queues]\n          options[:queues].map! do |queue_name, weight|\n            prefix_active_job_queue_name(queue_name, weight)\n          end\n        end\n\n        [group, options]\n      end\n    end\n\n    # Parses a single queue and adds it to a group\n    #\n    # @param queue [String] the queue name\n    # @param weight [Integer] the queue weight\n    # @param group [String] the group name\n    # @return [void]\n    def parse_queue(queue, weight, group)\n      Shoryuken.add_queue(queue, [weight.to_i, 1].max, group)\n    end\n\n    # Parses all queues from configuration and adds them to groups\n    #\n    # @return [void]\n    def parse_queues\n      if Shoryuken.options[:queues].to_a.any?\n        Shoryuken.add_group('default', Shoryuken.options[:concurrency])\n\n        Shoryuken.options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, 'default')\n        end\n      end\n\n      Shoryuken.options[:groups].to_a.each do |group, options|\n        Shoryuken.add_group(group, options[:concurrency], delay: options[:delay], polling_strategy: options[:polling_strategy])\n\n        options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, group)\n        end\n      end\n    end\n\n    # Requires worker files from the configured path\n    #\n    # @return [void]\n    def require_workers\n      required = Shoryuken.options[:require]\n\n      return unless required\n\n      if File.directory?(required)\n        Dir[File.join(required, '**', '*.rb')].each(&method(:require))\n      else\n        require required\n      end\n    end\n\n    # Validates that all configured queues exist in SQS\n    #\n    # @return [void]\n    # @raise [ArgumentError] if any queues do not exist\n    def validate_queues\n      return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?\n\n      non_existent_queues = []\n\n      Shoryuken.ungrouped_queues.uniq.each do |queue|\n        Shoryuken::Client.queues(queue)\n      rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n        non_existent_queues << queue\n      end\n\n      return if non_existent_queues.none?\n\n      # NOTE: HEREDOC's ~ operator removes indents, but is only available Ruby 2.3+\n      # See github PR: https://github.com/ruby-shoryuken/shoryuken/pull/691#issuecomment-1007653595\n      error_msg = <<-MSG.gsub(/^\\s+/, '')\n        The specified queue(s) #{non_existent_queues.join(', ')} do not exist.\n        Try 'shoryuken sqs create QUEUE-NAME' for creating a queue with default settings.\n        It's also possible that you don't have permission to access the specified queues.\n      MSG\n\n      raise Errors::QueueNotFoundError, error_msg\n    end\n\n    # Validates that all queues have registered workers\n    #\n    # @return [void]\n    def validate_workers\n      return if Shoryuken.active_job?\n\n      all_queues = Shoryuken.ungrouped_queues\n      queues_with_workers = Shoryuken.worker_registry.queues\n\n      (all_queues - queues_with_workers).each do |queue|\n        Shoryuken.logger.warn { \"No worker supplied for #{queue}\" }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prefix_active_job_queue_names", "signature": "def prefix_active_job_queue_names return unless Shoryuken.active_job?", "start_line": 161, "end_line": 178}, "metadata": {"module": "Shoryuken", "class_name": "EnvironmentLoader", "class_signature": "class EnvironmentLoader"}, "task_id": 364}
{"function_name": "parse_queues", "file_path": "shoryuken/lib/shoryuken/environment_loader.rb", "focal_code": "def parse_queues\n      if Shoryuken.options[:queues].to_a.any?\n        Shoryuken.add_group('default', Shoryuken.options[:concurrency])\n\n        Shoryuken.options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, 'default')\n        end\n      end\n\n      Shoryuken.options[:groups].to_a.each do |group, options|\n        Shoryuken.add_group(group, options[:concurrency], delay: options[:delay], polling_strategy: options[:polling_strategy])\n\n        options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, group)\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Loads and configures the Shoryuken environment from configuration files\n  # and command line options. Handles Rails integration and queue setup.\n  class EnvironmentLoader\n    # @return [Hash] the configuration options\n    attr_reader :options\n\n    # Sets up a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    # @return [Shoryuken::EnvironmentLoader] the configured instance\n    def self.setup_options(options)\n      instance = new(options)\n      instance.setup_options\n      instance\n    end\n\n    # Loads the environment for Rails console usage\n    #\n    # @return [void]\n    def self.load_for_rails_console\n      instance = setup_options(config_file: (Rails.root + 'config' + 'shoryuken.yml'))\n      instance.load\n    end\n\n    # Initializes a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    def initialize(options)\n      @options = options\n    end\n\n    # Sets up configuration options from file and initializes components\n    #\n    # @return [void]\n    def setup_options\n      initialize_rails if load_rails?\n      initialize_options\n      initialize_logger\n    end\n\n    # Loads the environment including queues and workers\n    #\n    # @return [void]\n    def load\n      prefix_active_job_queue_names\n      parse_queues\n      require_workers\n      validate_queues\n      validate_workers\n    end\n\n    private\n\n    # Merges configuration file options with runtime options\n    #\n    # @return [void]\n    def initialize_options\n      Shoryuken.options.merge!(config_file_options)\n      Shoryuken.options.merge!(options)\n    end\n\n    # Reads and parses the configuration file\n    #\n    # @return [Hash] the parsed configuration options\n    def config_file_options\n      return {} unless (path = options[:config_file])\n\n      raise Errors::InvalidConfigurationError, \"The supplied config file #{path} does not exist\" unless File.exist?(path)\n\n      if (result = YAML.load(ERB.new(IO.read(path)).result))\n        Shoryuken::Helpers::HashUtils.deep_symbolize_keys(result)\n      else\n        {}\n      end\n    end\n\n    # Initializes the logger with file output and verbosity settings\n    #\n    # @return [void]\n    def initialize_logger\n      Shoryuken::Logging.initialize_logger(Shoryuken.options[:logfile]) if Shoryuken.options[:logfile]\n      Shoryuken.logger.level = Logger::DEBUG if Shoryuken.options[:verbose]\n    end\n\n    # Initializes the Rails environment\n    #\n    # @return [void]\n    def initialize_rails\n      # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb\n\n      require 'rails'\n      if ::Rails::VERSION::MAJOR < 4\n        require File.expand_path('config/environment.rb')\n        ::Rails.application.eager_load!\n      else\n        # Painful contortions, see 1791 for discussion\n        require File.expand_path('config/application.rb')\n        if ::Rails::VERSION::MAJOR == 4\n          ::Rails::Application.initializer 'shoryuken.eager_load' do\n            ::Rails.application.config.eager_load = true\n          end\n        end\n        ::Rails::Application.initializer 'shoryuken.set_reloader_hook' do |app|\n          Shoryuken.reloader = proc do |&block|\n            app.reloader.wrap do\n              block.call\n            end\n          end\n        end\n        if Shoryuken.active_job?\n          require 'active_job/extensions'\n          require 'active_job/queue_adapters/shoryuken_adapter'\n          require 'active_job/queue_adapters/shoryuken_concurrent_send_adapter'\n        end\n        require File.expand_path('config/environment.rb')\n      end\n    end\n\n    # Checks if Rails should be loaded\n    #\n    # @return [Boolean] true if Rails should be initialized\n    def load_rails?\n      options[:rails]\n    end\n\n    # Prefixes a queue name with ActiveJob queue name prefix\n    #\n    # @param queue_name [String] the queue name to prefix\n    # @param weight [Integer] the queue weight\n    # @return [Array<String, Integer>] the prefixed queue name and weight\n    def prefix_active_job_queue_name(queue_name, weight)\n      return [queue_name, weight] if queue_name.start_with?('https://', 'arn:')\n\n      queue_name_prefix = ::ActiveJob::Base.queue_name_prefix\n      queue_name_delimiter = ::ActiveJob::Base.queue_name_delimiter\n\n      # See https://github.com/rails/rails/blob/master/activejob/lib/active_job/queue_name.rb#L27\n      name_parts = [queue_name_prefix.presence, queue_name]\n      prefixed_queue_name = name_parts.compact.join(queue_name_delimiter)\n      [prefixed_queue_name, weight]\n    end\n\n    # Prefixes all queue names with ActiveJob prefix if enabled\n    #\n    # @return [void]\n    def prefix_active_job_queue_names\n      return unless Shoryuken.active_job?\n      return unless Shoryuken.active_job_queue_name_prefixing?\n\n      Shoryuken.options[:queues].to_a.map! do |queue_name, weight|\n        prefix_active_job_queue_name(queue_name, weight)\n      end\n\n      Shoryuken.options[:groups].to_a.map! do |group, options|\n        if options[:queues]\n          options[:queues].map! do |queue_name, weight|\n            prefix_active_job_queue_name(queue_name, weight)\n          end\n        end\n\n        [group, options]\n      end\n    end\n\n    # Parses a single queue and adds it to a group\n    #\n    # @param queue [String] the queue name\n    # @param weight [Integer] the queue weight\n    # @param group [String] the group name\n    # @return [void]\n    def parse_queue(queue, weight, group)\n      Shoryuken.add_queue(queue, [weight.to_i, 1].max, group)\n    end\n\n    # Parses all queues from configuration and adds them to groups\n    #\n    # @return [void]\n    def parse_queues\n      if Shoryuken.options[:queues].to_a.any?\n        Shoryuken.add_group('default', Shoryuken.options[:concurrency])\n\n        Shoryuken.options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, 'default')\n        end\n      end\n\n      Shoryuken.options[:groups].to_a.each do |group, options|\n        Shoryuken.add_group(group, options[:concurrency], delay: options[:delay], polling_strategy: options[:polling_strategy])\n\n        options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, group)\n        end\n      end\n    end\n\n    # Requires worker files from the configured path\n    #\n    # @return [void]\n    def require_workers\n      required = Shoryuken.options[:require]\n\n      return unless required\n\n      if File.directory?(required)\n        Dir[File.join(required, '**', '*.rb')].each(&method(:require))\n      else\n        require required\n      end\n    end\n\n    # Validates that all configured queues exist in SQS\n    #\n    # @return [void]\n    # @raise [ArgumentError] if any queues do not exist\n    def validate_queues\n      return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?\n\n      non_existent_queues = []\n\n      Shoryuken.ungrouped_queues.uniq.each do |queue|\n        Shoryuken::Client.queues(queue)\n      rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n        non_existent_queues << queue\n      end\n\n      return if non_existent_queues.none?\n\n      # NOTE: HEREDOC's ~ operator removes indents, but is only available Ruby 2.3+\n      # See github PR: https://github.com/ruby-shoryuken/shoryuken/pull/691#issuecomment-1007653595\n      error_msg = <<-MSG.gsub(/^\\s+/, '')\n        The specified queue(s) #{non_existent_queues.join(', ')} do not exist.\n        Try 'shoryuken sqs create QUEUE-NAME' for creating a queue with default settings.\n        It's also possible that you don't have permission to access the specified queues.\n      MSG\n\n      raise Errors::QueueNotFoundError, error_msg\n    end\n\n    # Validates that all queues have registered workers\n    #\n    # @return [void]\n    def validate_workers\n      return if Shoryuken.active_job?\n\n      all_queues = Shoryuken.ungrouped_queues\n      queues_with_workers = Shoryuken.worker_registry.queues\n\n      (all_queues - queues_with_workers).each do |queue|\n        Shoryuken.logger.warn { \"No worker supplied for #{queue}\" }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "parse_queues", "signature": "def parse_queues if Shoryuken.options[:queues].to_a.any?", "start_line": 193, "end_line": 209}, "metadata": {"module": "Shoryuken", "class_name": "EnvironmentLoader", "class_signature": "class EnvironmentLoader"}, "task_id": 365}
{"function_name": "validate_queues", "file_path": "shoryuken/lib/shoryuken/environment_loader.rb", "focal_code": "def validate_queues\n      return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?\n\n      non_existent_queues = []\n\n      Shoryuken.ungrouped_queues.uniq.each do |queue|\n        Shoryuken::Client.queues(queue)\n      rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n        non_existent_queues << queue\n      end\n\n      return if non_existent_queues.none?\n\n      # NOTE: HEREDOC's ~ operator removes indents, but is only available Ruby 2.3+\n      # See github PR: https://github.com/ruby-shoryuken/shoryuken/pull/691#issuecomment-1007653595\n      error_msg = <<-MSG.gsub(/^\\s+/, '')\n        The specified queue(s) #{non_existent_queues.join(', ')} do not exist.\n        Try 'shoryuken sqs create QUEUE-NAME' for creating a queue with default settings.\n        It's also possible that you don't have permission to access the specified queues.\n      MSG\n\n      raise Errors::QueueNotFoundError, error_msg\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Loads and configures the Shoryuken environment from configuration files\n  # and command line options. Handles Rails integration and queue setup.\n  class EnvironmentLoader\n    # @return [Hash] the configuration options\n    attr_reader :options\n\n    # Sets up a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    # @return [Shoryuken::EnvironmentLoader] the configured instance\n    def self.setup_options(options)\n      instance = new(options)\n      instance.setup_options\n      instance\n    end\n\n    # Loads the environment for Rails console usage\n    #\n    # @return [void]\n    def self.load_for_rails_console\n      instance = setup_options(config_file: (Rails.root + 'config' + 'shoryuken.yml'))\n      instance.load\n    end\n\n    # Initializes a new EnvironmentLoader with the given options\n    #\n    # @param options [Hash] configuration options\n    # @option options [String] :config_file path to the configuration file\n    # @option options [Boolean] :rails whether to initialize Rails\n    # @option options [String] :logfile path to the log file\n    # @option options [Boolean] :verbose whether to enable verbose logging\n    # @option options [String] :require path to require workers from\n    # @option options [Integer] :concurrency number of concurrent workers\n    def initialize(options)\n      @options = options\n    end\n\n    # Sets up configuration options from file and initializes components\n    #\n    # @return [void]\n    def setup_options\n      initialize_rails if load_rails?\n      initialize_options\n      initialize_logger\n    end\n\n    # Loads the environment including queues and workers\n    #\n    # @return [void]\n    def load\n      prefix_active_job_queue_names\n      parse_queues\n      require_workers\n      validate_queues\n      validate_workers\n    end\n\n    private\n\n    # Merges configuration file options with runtime options\n    #\n    # @return [void]\n    def initialize_options\n      Shoryuken.options.merge!(config_file_options)\n      Shoryuken.options.merge!(options)\n    end\n\n    # Reads and parses the configuration file\n    #\n    # @return [Hash] the parsed configuration options\n    def config_file_options\n      return {} unless (path = options[:config_file])\n\n      raise Errors::InvalidConfigurationError, \"The supplied config file #{path} does not exist\" unless File.exist?(path)\n\n      if (result = YAML.load(ERB.new(IO.read(path)).result))\n        Shoryuken::Helpers::HashUtils.deep_symbolize_keys(result)\n      else\n        {}\n      end\n    end\n\n    # Initializes the logger with file output and verbosity settings\n    #\n    # @return [void]\n    def initialize_logger\n      Shoryuken::Logging.initialize_logger(Shoryuken.options[:logfile]) if Shoryuken.options[:logfile]\n      Shoryuken.logger.level = Logger::DEBUG if Shoryuken.options[:verbose]\n    end\n\n    # Initializes the Rails environment\n    #\n    # @return [void]\n    def initialize_rails\n      # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb\n\n      require 'rails'\n      if ::Rails::VERSION::MAJOR < 4\n        require File.expand_path('config/environment.rb')\n        ::Rails.application.eager_load!\n      else\n        # Painful contortions, see 1791 for discussion\n        require File.expand_path('config/application.rb')\n        if ::Rails::VERSION::MAJOR == 4\n          ::Rails::Application.initializer 'shoryuken.eager_load' do\n            ::Rails.application.config.eager_load = true\n          end\n        end\n        ::Rails::Application.initializer 'shoryuken.set_reloader_hook' do |app|\n          Shoryuken.reloader = proc do |&block|\n            app.reloader.wrap do\n              block.call\n            end\n          end\n        end\n        if Shoryuken.active_job?\n          require 'active_job/extensions'\n          require 'active_job/queue_adapters/shoryuken_adapter'\n          require 'active_job/queue_adapters/shoryuken_concurrent_send_adapter'\n        end\n        require File.expand_path('config/environment.rb')\n      end\n    end\n\n    # Checks if Rails should be loaded\n    #\n    # @return [Boolean] true if Rails should be initialized\n    def load_rails?\n      options[:rails]\n    end\n\n    # Prefixes a queue name with ActiveJob queue name prefix\n    #\n    # @param queue_name [String] the queue name to prefix\n    # @param weight [Integer] the queue weight\n    # @return [Array<String, Integer>] the prefixed queue name and weight\n    def prefix_active_job_queue_name(queue_name, weight)\n      return [queue_name, weight] if queue_name.start_with?('https://', 'arn:')\n\n      queue_name_prefix = ::ActiveJob::Base.queue_name_prefix\n      queue_name_delimiter = ::ActiveJob::Base.queue_name_delimiter\n\n      # See https://github.com/rails/rails/blob/master/activejob/lib/active_job/queue_name.rb#L27\n      name_parts = [queue_name_prefix.presence, queue_name]\n      prefixed_queue_name = name_parts.compact.join(queue_name_delimiter)\n      [prefixed_queue_name, weight]\n    end\n\n    # Prefixes all queue names with ActiveJob prefix if enabled\n    #\n    # @return [void]\n    def prefix_active_job_queue_names\n      return unless Shoryuken.active_job?\n      return unless Shoryuken.active_job_queue_name_prefixing?\n\n      Shoryuken.options[:queues].to_a.map! do |queue_name, weight|\n        prefix_active_job_queue_name(queue_name, weight)\n      end\n\n      Shoryuken.options[:groups].to_a.map! do |group, options|\n        if options[:queues]\n          options[:queues].map! do |queue_name, weight|\n            prefix_active_job_queue_name(queue_name, weight)\n          end\n        end\n\n        [group, options]\n      end\n    end\n\n    # Parses a single queue and adds it to a group\n    #\n    # @param queue [String] the queue name\n    # @param weight [Integer] the queue weight\n    # @param group [String] the group name\n    # @return [void]\n    def parse_queue(queue, weight, group)\n      Shoryuken.add_queue(queue, [weight.to_i, 1].max, group)\n    end\n\n    # Parses all queues from configuration and adds them to groups\n    #\n    # @return [void]\n    def parse_queues\n      if Shoryuken.options[:queues].to_a.any?\n        Shoryuken.add_group('default', Shoryuken.options[:concurrency])\n\n        Shoryuken.options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, 'default')\n        end\n      end\n\n      Shoryuken.options[:groups].to_a.each do |group, options|\n        Shoryuken.add_group(group, options[:concurrency], delay: options[:delay], polling_strategy: options[:polling_strategy])\n\n        options[:queues].to_a.each do |queue, weight|\n          parse_queue(queue, weight, group)\n        end\n      end\n    end\n\n    # Requires worker files from the configured path\n    #\n    # @return [void]\n    def require_workers\n      required = Shoryuken.options[:require]\n\n      return unless required\n\n      if File.directory?(required)\n        Dir[File.join(required, '**', '*.rb')].each(&method(:require))\n      else\n        require required\n      end\n    end\n\n    # Validates that all configured queues exist in SQS\n    #\n    # @return [void]\n    # @raise [ArgumentError] if any queues do not exist\n    def validate_queues\n      return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?\n\n      non_existent_queues = []\n\n      Shoryuken.ungrouped_queues.uniq.each do |queue|\n        Shoryuken::Client.queues(queue)\n      rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue\n        non_existent_queues << queue\n      end\n\n      return if non_existent_queues.none?\n\n      # NOTE: HEREDOC's ~ operator removes indents, but is only available Ruby 2.3+\n      # See github PR: https://github.com/ruby-shoryuken/shoryuken/pull/691#issuecomment-1007653595\n      error_msg = <<-MSG.gsub(/^\\s+/, '')\n        The specified queue(s) #{non_existent_queues.join(', ')} do not exist.\n        Try 'shoryuken sqs create QUEUE-NAME' for creating a queue with default settings.\n        It's also possible that you don't have permission to access the specified queues.\n      MSG\n\n      raise Errors::QueueNotFoundError, error_msg\n    end\n\n    # Validates that all queues have registered workers\n    #\n    # @return [void]\n    def validate_workers\n      return if Shoryuken.active_job?\n\n      all_queues = Shoryuken.ungrouped_queues\n      queues_with_workers = Shoryuken.worker_registry.queues\n\n      (all_queues - queues_with_workers).each do |queue|\n        Shoryuken.logger.warn { \"No worker supplied for #{queue}\" }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate_queues", "signature": "def validate_queues return Shoryuken.logger.warn { 'No queues supplied' } if Shoryuken.ungrouped_queues.empty?", "start_line": 230, "end_line": 252}, "metadata": {"module": "Shoryuken", "class_name": "EnvironmentLoader", "class_signature": "class EnvironmentLoader"}, "task_id": 366}
{"function_name": "fetch_worker", "file_path": "shoryuken/lib/shoryuken/default_worker_registry.rb", "focal_code": "def fetch_worker(queue, message)\n      worker_class = !message.is_a?(Array) &&\n                     message.message_attributes &&\n                     message.message_attributes['shoryuken_class'] &&\n                     message.message_attributes['shoryuken_class'][:string_value]\n\n      worker_class = begin\n        Shoryuken::Helpers::StringUtils.constantize(worker_class)\n      rescue\n        @workers[queue]\n      end\n\n      worker_class.new if worker_class\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Default implementation of the worker registry.\n  # Stores and retrieves worker classes mapped to queue names.\n  class DefaultWorkerRegistry < WorkerRegistry\n    # Initializes a new DefaultWorkerRegistry with an empty workers hash\n    def initialize\n      @workers = Shoryuken::Helpers::AtomicHash.new\n    end\n\n    # Checks if a queue is configured for batch message receiving\n    #\n    # @param queue [String] the queue name\n    # @return [Boolean] true if the queue's worker has batch mode enabled\n    def batch_receive_messages?(queue)\n      !!(@workers[queue] && @workers[queue].get_shoryuken_options['batch'])\n    end\n\n    # Clears all registered workers\n    #\n    # @return [void]\n    def clear\n      @workers.clear\n    end\n\n    # Fetches a worker instance for processing a message\n    #\n    # @param queue [String] the queue name\n    # @param message [Shoryuken::Message, Array<Shoryuken::Message>] the message or batch\n    # @return [Object, nil] a new worker instance or nil if not found\n    def fetch_worker(queue, message)\n      worker_class = !message.is_a?(Array) &&\n                     message.message_attributes &&\n                     message.message_attributes['shoryuken_class'] &&\n                     message.message_attributes['shoryuken_class'][:string_value]\n\n      worker_class = begin\n        Shoryuken::Helpers::StringUtils.constantize(worker_class)\n      rescue\n        @workers[queue]\n      end\n\n      worker_class.new if worker_class\n    end\n\n    # Returns all registered queue names\n    #\n    # @return [Array<String>] the queue names with registered workers\n    def queues\n      @workers.keys\n    end\n\n    # Registers a worker class for a queue\n    #\n    # @param queue [String] the queue name\n    # @param clazz [Class] the worker class to register\n    # @return [Class] the registered worker class\n    # @raise [Errors::InvalidWorkerRegistrationError] if a batchable worker is already registered for the queue\n    def register_worker(queue, clazz)\n      if (worker_class = @workers[queue]) && (worker_class.get_shoryuken_options['batch'] == true || clazz.get_shoryuken_options['batch'] == true)\n        raise Errors::InvalidWorkerRegistrationError, \"Could not register #{clazz} for #{queue}, \"\\\n          \"because #{worker_class} is already registered for this queue, \"\\\n          \"and Shoryuken doesn't support a batchable worker for a queue with multiple workers\"\n      end\n\n      @workers[queue] = clazz\n    end\n\n    # Returns all worker classes for a queue\n    #\n    # @param queue [String] the queue name\n    # @return [Array<Class>] the registered worker classes\n    def workers(queue)\n      [@workers.fetch(queue, [])].flatten\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "fetch_worker", "signature": "def fetch_worker(queue, message)", "start_line": 32, "end_line": 45}, "metadata": {"module": "Shoryuken", "class_name": "DefaultWorkerRegistry", "class_signature": "class DefaultWorkerRegistry < < WorkerRegistry"}, "task_id": 367}
{"function_name": "initialize", "file_path": "shoryuken/lib/shoryuken/manager.rb", "focal_code": "def initialize(group, fetcher, polling_strategy, concurrency, executor)\n      @group                      = group\n      @fetcher                    = fetcher\n      @polling_strategy           = polling_strategy\n      @max_processors             = concurrency\n      @busy_processors            = Shoryuken::Helpers::AtomicCounter.new(0)\n      @executor                   = executor\n      @running                    = Shoryuken::Helpers::AtomicBoolean.new(true)\n      @stop_new_dispatching       = Shoryuken::Helpers::AtomicBoolean.new(false)\n      @dispatching_release_signal = ::Queue.new\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Manages message dispatching and processing for a single processing group.\n  # Coordinates between the fetcher, polling strategy, and processor.\n  class Manager\n    include Util\n\n    # Maximum number of messages to fetch in a single batch request\n    BATCH_LIMIT = 10\n\n    # Minimum interval between dispatch cycles\n    # @see https://github.com/ruby-shoryuken/shoryuken/issues/348#issuecomment-292847028\n    MIN_DISPATCH_INTERVAL = 0.1\n\n    # @return [String] the processing group name\n    attr_reader :group\n\n    # Initializes a new Manager for a processing group\n    #\n    # @param group [String] the processing group name\n    # @param fetcher [Shoryuken::Fetcher] the message fetcher\n    # @param polling_strategy [Shoryuken::Polling::BaseStrategy] the polling strategy\n    # @param concurrency [Integer] the maximum number of concurrent processors\n    # @param executor [Concurrent::ExecutorService] the executor for async operations\n    def initialize(group, fetcher, polling_strategy, concurrency, executor)\n      @group                      = group\n      @fetcher                    = fetcher\n      @polling_strategy           = polling_strategy\n      @max_processors             = concurrency\n      @busy_processors            = Shoryuken::Helpers::AtomicCounter.new(0)\n      @executor                   = executor\n      @running                    = Shoryuken::Helpers::AtomicBoolean.new(true)\n      @stop_new_dispatching       = Shoryuken::Helpers::AtomicBoolean.new(false)\n      @dispatching_release_signal = ::Queue.new\n    end\n\n    # Starts the dispatch loop\n    #\n    # @return [void]\n    def start\n      fire_utilization_update_event\n      dispatch_loop\n    end\n\n    # Signals the manager to stop dispatching new messages\n    #\n    # @return [void]\n    def stop_new_dispatching\n      @stop_new_dispatching.make_true\n    end\n\n    # Waits for any in-progress dispatching to complete\n    #\n    # @return [void]\n    def await_dispatching_in_progress\n      # There might still be a dispatching on-going, as the response from SQS could take some time\n      # We don't want to stop the process before processing incoming messages, as they would stay \"in-flight\" for some time on SQS\n      # We use a queue, as the dispatch_loop is running on another thread, and this is a efficient way of communicating between threads.\n      @dispatching_release_signal.pop\n    end\n\n    # Checks if the manager is still running\n    #\n    # @return [Boolean] true if the manager is running\n    def running?\n      @running.true? && @executor.running?\n    end\n\n    private\n\n    # The main dispatch loop\n    #\n    # @return [void]\n    def dispatch_loop\n      if @stop_new_dispatching.true? || !running?\n        @dispatching_release_signal << 1\n        return\n      end\n\n      @executor.post { dispatch }\n    end\n\n    # Dispatches messages from a queue\n    #\n    # @return [void]\n    def dispatch\n      return unless running?\n\n      if ready <= 0 || (queue = @polling_strategy.next_queue).nil?\n        return sleep(MIN_DISPATCH_INTERVAL)\n      end\n\n      fire_event(:dispatch, false, queue_name: queue.name)\n\n      logger.debug { \"Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}\" }\n\n      batched_queue?(queue) ? dispatch_batch(queue) : dispatch_single_messages(queue)\n    rescue => e\n      handle_dispatch_error(e)\n    ensure\n      dispatch_loop\n    end\n\n    # Returns the count of busy processors\n    #\n    # @return [Integer] the number of busy processors\n    def busy\n      @busy_processors.value\n    end\n\n    # Returns the count of ready processors\n    #\n    # @return [Integer] the number of available processors\n    def ready\n      @max_processors - busy\n    end\n\n    # Handles completion of processor work\n    #\n    # @param queue [String] the queue name\n    # @return [void]\n    def processor_done(queue)\n      @busy_processors.decrement\n      fire_utilization_update_event\n\n      client_queue = Shoryuken::Client.queues(queue)\n      return unless client_queue.fifo?\n      return unless @polling_strategy.respond_to?(:message_processed)\n\n      @polling_strategy.message_processed(queue)\n    end\n\n    # Assigns a message to a processor\n    #\n    # @param queue_name [String] the queue name\n    # @param sqs_msg [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    # @return [Concurrent::Promise, nil] the processing promise or nil if not running\n    def assign(queue_name, sqs_msg)\n      return unless running?\n\n      logger.debug { \"Assigning #{sqs_msg.message_id}\" }\n\n      @busy_processors.increment\n      fire_utilization_update_event\n\n      Concurrent::Promise\n        .execute(executor: @executor) do\n          original_priority = Thread.current.priority\n          begin\n            Thread.current.priority = Shoryuken.thread_priority\n            Processor.process(queue_name, sqs_msg)\n          ensure\n            Thread.current.priority = original_priority\n          end\n        end\n        .then { processor_done(queue_name) }\n        .rescue { processor_done(queue_name) }\n    end\n\n    # Dispatches a batch of messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_batch(queue)\n      batch = @fetcher.fetch(queue, BATCH_LIMIT)\n      @polling_strategy.messages_found(queue.name, batch.size)\n      assign(queue.name, patch_batch!(batch)) if batch.any?\n    end\n\n    # Dispatches individual messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_single_messages(queue)\n      messages = @fetcher.fetch(queue, ready)\n      @polling_strategy.messages_found(queue.name, messages.size)\n      messages.each { |message| assign(queue.name, message) }\n    end\n\n    # Checks if a queue uses batch message processing\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [Boolean] true if the queue is configured for batch processing\n    def batched_queue?(queue)\n      Shoryuken.worker_registry.batch_receive_messages?(queue.name)\n    end\n\n    # Patches a batch array with a message_id method\n    #\n    # @param sqs_msgs [Array<Aws::SQS::Types::Message>] the batch of messages\n    # @return [Array<Aws::SQS::Types::Message>] the patched batch\n    def patch_batch!(sqs_msgs)\n      sqs_msgs.instance_eval do\n        def message_id\n          \"batch-with-#{size}-messages\"\n        end\n      end\n\n      sqs_msgs\n    end\n\n    # Handles errors during dispatch\n    #\n    # @param ex [Exception] the exception that occurred\n    # @return [void]\n    def handle_dispatch_error(ex)\n      logger.error { \"Manager failed: #{ex.message}\" }\n      logger.error { ex.backtrace.join(\"\\n\") } unless ex.backtrace.nil?\n\n      Process.kill('USR1', Process.pid)\n\n      @running.make_false\n    end\n\n    # Fires a utilization update event\n    #\n    # @return [void]\n    def fire_utilization_update_event\n      fire_event :utilization_update, false, {\n        group: @group,\n        max_processors: @max_processors,\n        busy_processors: busy\n      }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(group, fetcher, polling_strategy, concurrency, executor)", "start_line": 26, "end_line": 36}, "metadata": {"module": "Shoryuken", "class_name": "Manager", "class_signature": "class Manager"}, "task_id": 368}
{"function_name": "dispatch", "file_path": "shoryuken/lib/shoryuken/manager.rb", "focal_code": "def dispatch\n      return unless running?\n\n      if ready <= 0 || (queue = @polling_strategy.next_queue).nil?\n        return sleep(MIN_DISPATCH_INTERVAL)\n      end\n\n      fire_event(:dispatch, false, queue_name: queue.name)\n\n      logger.debug { \"Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}\" }\n\n      batched_queue?(queue) ? dispatch_batch(queue) : dispatch_single_messages(queue)\n    rescue => e\n      handle_dispatch_error(e)\n    ensure\n      dispatch_loop\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Manages message dispatching and processing for a single processing group.\n  # Coordinates between the fetcher, polling strategy, and processor.\n  class Manager\n    include Util\n\n    # Maximum number of messages to fetch in a single batch request\n    BATCH_LIMIT = 10\n\n    # Minimum interval between dispatch cycles\n    # @see https://github.com/ruby-shoryuken/shoryuken/issues/348#issuecomment-292847028\n    MIN_DISPATCH_INTERVAL = 0.1\n\n    # @return [String] the processing group name\n    attr_reader :group\n\n    # Initializes a new Manager for a processing group\n    #\n    # @param group [String] the processing group name\n    # @param fetcher [Shoryuken::Fetcher] the message fetcher\n    # @param polling_strategy [Shoryuken::Polling::BaseStrategy] the polling strategy\n    # @param concurrency [Integer] the maximum number of concurrent processors\n    # @param executor [Concurrent::ExecutorService] the executor for async operations\n    def initialize(group, fetcher, polling_strategy, concurrency, executor)\n      @group                      = group\n      @fetcher                    = fetcher\n      @polling_strategy           = polling_strategy\n      @max_processors             = concurrency\n      @busy_processors            = Shoryuken::Helpers::AtomicCounter.new(0)\n      @executor                   = executor\n      @running                    = Shoryuken::Helpers::AtomicBoolean.new(true)\n      @stop_new_dispatching       = Shoryuken::Helpers::AtomicBoolean.new(false)\n      @dispatching_release_signal = ::Queue.new\n    end\n\n    # Starts the dispatch loop\n    #\n    # @return [void]\n    def start\n      fire_utilization_update_event\n      dispatch_loop\n    end\n\n    # Signals the manager to stop dispatching new messages\n    #\n    # @return [void]\n    def stop_new_dispatching\n      @stop_new_dispatching.make_true\n    end\n\n    # Waits for any in-progress dispatching to complete\n    #\n    # @return [void]\n    def await_dispatching_in_progress\n      # There might still be a dispatching on-going, as the response from SQS could take some time\n      # We don't want to stop the process before processing incoming messages, as they would stay \"in-flight\" for some time on SQS\n      # We use a queue, as the dispatch_loop is running on another thread, and this is a efficient way of communicating between threads.\n      @dispatching_release_signal.pop\n    end\n\n    # Checks if the manager is still running\n    #\n    # @return [Boolean] true if the manager is running\n    def running?\n      @running.true? && @executor.running?\n    end\n\n    private\n\n    # The main dispatch loop\n    #\n    # @return [void]\n    def dispatch_loop\n      if @stop_new_dispatching.true? || !running?\n        @dispatching_release_signal << 1\n        return\n      end\n\n      @executor.post { dispatch }\n    end\n\n    # Dispatches messages from a queue\n    #\n    # @return [void]\n    def dispatch\n      return unless running?\n\n      if ready <= 0 || (queue = @polling_strategy.next_queue).nil?\n        return sleep(MIN_DISPATCH_INTERVAL)\n      end\n\n      fire_event(:dispatch, false, queue_name: queue.name)\n\n      logger.debug { \"Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}\" }\n\n      batched_queue?(queue) ? dispatch_batch(queue) : dispatch_single_messages(queue)\n    rescue => e\n      handle_dispatch_error(e)\n    ensure\n      dispatch_loop\n    end\n\n    # Returns the count of busy processors\n    #\n    # @return [Integer] the number of busy processors\n    def busy\n      @busy_processors.value\n    end\n\n    # Returns the count of ready processors\n    #\n    # @return [Integer] the number of available processors\n    def ready\n      @max_processors - busy\n    end\n\n    # Handles completion of processor work\n    #\n    # @param queue [String] the queue name\n    # @return [void]\n    def processor_done(queue)\n      @busy_processors.decrement\n      fire_utilization_update_event\n\n      client_queue = Shoryuken::Client.queues(queue)\n      return unless client_queue.fifo?\n      return unless @polling_strategy.respond_to?(:message_processed)\n\n      @polling_strategy.message_processed(queue)\n    end\n\n    # Assigns a message to a processor\n    #\n    # @param queue_name [String] the queue name\n    # @param sqs_msg [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    # @return [Concurrent::Promise, nil] the processing promise or nil if not running\n    def assign(queue_name, sqs_msg)\n      return unless running?\n\n      logger.debug { \"Assigning #{sqs_msg.message_id}\" }\n\n      @busy_processors.increment\n      fire_utilization_update_event\n\n      Concurrent::Promise\n        .execute(executor: @executor) do\n          original_priority = Thread.current.priority\n          begin\n            Thread.current.priority = Shoryuken.thread_priority\n            Processor.process(queue_name, sqs_msg)\n          ensure\n            Thread.current.priority = original_priority\n          end\n        end\n        .then { processor_done(queue_name) }\n        .rescue { processor_done(queue_name) }\n    end\n\n    # Dispatches a batch of messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_batch(queue)\n      batch = @fetcher.fetch(queue, BATCH_LIMIT)\n      @polling_strategy.messages_found(queue.name, batch.size)\n      assign(queue.name, patch_batch!(batch)) if batch.any?\n    end\n\n    # Dispatches individual messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_single_messages(queue)\n      messages = @fetcher.fetch(queue, ready)\n      @polling_strategy.messages_found(queue.name, messages.size)\n      messages.each { |message| assign(queue.name, message) }\n    end\n\n    # Checks if a queue uses batch message processing\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [Boolean] true if the queue is configured for batch processing\n    def batched_queue?(queue)\n      Shoryuken.worker_registry.batch_receive_messages?(queue.name)\n    end\n\n    # Patches a batch array with a message_id method\n    #\n    # @param sqs_msgs [Array<Aws::SQS::Types::Message>] the batch of messages\n    # @return [Array<Aws::SQS::Types::Message>] the patched batch\n    def patch_batch!(sqs_msgs)\n      sqs_msgs.instance_eval do\n        def message_id\n          \"batch-with-#{size}-messages\"\n        end\n      end\n\n      sqs_msgs\n    end\n\n    # Handles errors during dispatch\n    #\n    # @param ex [Exception] the exception that occurred\n    # @return [void]\n    def handle_dispatch_error(ex)\n      logger.error { \"Manager failed: #{ex.message}\" }\n      logger.error { ex.backtrace.join(\"\\n\") } unless ex.backtrace.nil?\n\n      Process.kill('USR1', Process.pid)\n\n      @running.make_false\n    end\n\n    # Fires a utilization update event\n    #\n    # @return [void]\n    def fire_utilization_update_event\n      fire_event :utilization_update, false, {\n        group: @group,\n        max_processors: @max_processors,\n        busy_processors: busy\n      }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "dispatch", "signature": "def dispatch return unless running?", "start_line": 87, "end_line": 103}, "metadata": {"module": "Shoryuken", "class_name": "Manager", "class_signature": "class Manager"}, "task_id": 369}
{"function_name": "assign", "file_path": "shoryuken/lib/shoryuken/manager.rb", "focal_code": "def assign(queue_name, sqs_msg)\n      return unless running?\n\n      logger.debug { \"Assigning #{sqs_msg.message_id}\" }\n\n      @busy_processors.increment\n      fire_utilization_update_event\n\n      Concurrent::Promise\n        .execute(executor: @executor) do\n          original_priority = Thread.current.priority\n          begin\n            Thread.current.priority = Shoryuken.thread_priority\n            Processor.process(queue_name, sqs_msg)\n          ensure\n            Thread.current.priority = original_priority\n          end\n        end\n        .then { processor_done(queue_name) }\n        .rescue { processor_done(queue_name) }\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Manages message dispatching and processing for a single processing group.\n  # Coordinates between the fetcher, polling strategy, and processor.\n  class Manager\n    include Util\n\n    # Maximum number of messages to fetch in a single batch request\n    BATCH_LIMIT = 10\n\n    # Minimum interval between dispatch cycles\n    # @see https://github.com/ruby-shoryuken/shoryuken/issues/348#issuecomment-292847028\n    MIN_DISPATCH_INTERVAL = 0.1\n\n    # @return [String] the processing group name\n    attr_reader :group\n\n    # Initializes a new Manager for a processing group\n    #\n    # @param group [String] the processing group name\n    # @param fetcher [Shoryuken::Fetcher] the message fetcher\n    # @param polling_strategy [Shoryuken::Polling::BaseStrategy] the polling strategy\n    # @param concurrency [Integer] the maximum number of concurrent processors\n    # @param executor [Concurrent::ExecutorService] the executor for async operations\n    def initialize(group, fetcher, polling_strategy, concurrency, executor)\n      @group                      = group\n      @fetcher                    = fetcher\n      @polling_strategy           = polling_strategy\n      @max_processors             = concurrency\n      @busy_processors            = Shoryuken::Helpers::AtomicCounter.new(0)\n      @executor                   = executor\n      @running                    = Shoryuken::Helpers::AtomicBoolean.new(true)\n      @stop_new_dispatching       = Shoryuken::Helpers::AtomicBoolean.new(false)\n      @dispatching_release_signal = ::Queue.new\n    end\n\n    # Starts the dispatch loop\n    #\n    # @return [void]\n    def start\n      fire_utilization_update_event\n      dispatch_loop\n    end\n\n    # Signals the manager to stop dispatching new messages\n    #\n    # @return [void]\n    def stop_new_dispatching\n      @stop_new_dispatching.make_true\n    end\n\n    # Waits for any in-progress dispatching to complete\n    #\n    # @return [void]\n    def await_dispatching_in_progress\n      # There might still be a dispatching on-going, as the response from SQS could take some time\n      # We don't want to stop the process before processing incoming messages, as they would stay \"in-flight\" for some time on SQS\n      # We use a queue, as the dispatch_loop is running on another thread, and this is a efficient way of communicating between threads.\n      @dispatching_release_signal.pop\n    end\n\n    # Checks if the manager is still running\n    #\n    # @return [Boolean] true if the manager is running\n    def running?\n      @running.true? && @executor.running?\n    end\n\n    private\n\n    # The main dispatch loop\n    #\n    # @return [void]\n    def dispatch_loop\n      if @stop_new_dispatching.true? || !running?\n        @dispatching_release_signal << 1\n        return\n      end\n\n      @executor.post { dispatch }\n    end\n\n    # Dispatches messages from a queue\n    #\n    # @return [void]\n    def dispatch\n      return unless running?\n\n      if ready <= 0 || (queue = @polling_strategy.next_queue).nil?\n        return sleep(MIN_DISPATCH_INTERVAL)\n      end\n\n      fire_event(:dispatch, false, queue_name: queue.name)\n\n      logger.debug { \"Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}\" }\n\n      batched_queue?(queue) ? dispatch_batch(queue) : dispatch_single_messages(queue)\n    rescue => e\n      handle_dispatch_error(e)\n    ensure\n      dispatch_loop\n    end\n\n    # Returns the count of busy processors\n    #\n    # @return [Integer] the number of busy processors\n    def busy\n      @busy_processors.value\n    end\n\n    # Returns the count of ready processors\n    #\n    # @return [Integer] the number of available processors\n    def ready\n      @max_processors - busy\n    end\n\n    # Handles completion of processor work\n    #\n    # @param queue [String] the queue name\n    # @return [void]\n    def processor_done(queue)\n      @busy_processors.decrement\n      fire_utilization_update_event\n\n      client_queue = Shoryuken::Client.queues(queue)\n      return unless client_queue.fifo?\n      return unless @polling_strategy.respond_to?(:message_processed)\n\n      @polling_strategy.message_processed(queue)\n    end\n\n    # Assigns a message to a processor\n    #\n    # @param queue_name [String] the queue name\n    # @param sqs_msg [Aws::SQS::Types::Message, Array<Aws::SQS::Types::Message>] the message or batch\n    # @return [Concurrent::Promise, nil] the processing promise or nil if not running\n    def assign(queue_name, sqs_msg)\n      return unless running?\n\n      logger.debug { \"Assigning #{sqs_msg.message_id}\" }\n\n      @busy_processors.increment\n      fire_utilization_update_event\n\n      Concurrent::Promise\n        .execute(executor: @executor) do\n          original_priority = Thread.current.priority\n          begin\n            Thread.current.priority = Shoryuken.thread_priority\n            Processor.process(queue_name, sqs_msg)\n          ensure\n            Thread.current.priority = original_priority\n          end\n        end\n        .then { processor_done(queue_name) }\n        .rescue { processor_done(queue_name) }\n    end\n\n    # Dispatches a batch of messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_batch(queue)\n      batch = @fetcher.fetch(queue, BATCH_LIMIT)\n      @polling_strategy.messages_found(queue.name, batch.size)\n      assign(queue.name, patch_batch!(batch)) if batch.any?\n    end\n\n    # Dispatches individual messages from a queue\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [void]\n    def dispatch_single_messages(queue)\n      messages = @fetcher.fetch(queue, ready)\n      @polling_strategy.messages_found(queue.name, messages.size)\n      messages.each { |message| assign(queue.name, message) }\n    end\n\n    # Checks if a queue uses batch message processing\n    #\n    # @param queue [Shoryuken::Polling::QueueConfiguration] the queue configuration\n    # @return [Boolean] true if the queue is configured for batch processing\n    def batched_queue?(queue)\n      Shoryuken.worker_registry.batch_receive_messages?(queue.name)\n    end\n\n    # Patches a batch array with a message_id method\n    #\n    # @param sqs_msgs [Array<Aws::SQS::Types::Message>] the batch of messages\n    # @return [Array<Aws::SQS::Types::Message>] the patched batch\n    def patch_batch!(sqs_msgs)\n      sqs_msgs.instance_eval do\n        def message_id\n          \"batch-with-#{size}-messages\"\n        end\n      end\n\n      sqs_msgs\n    end\n\n    # Handles errors during dispatch\n    #\n    # @param ex [Exception] the exception that occurred\n    # @return [void]\n    def handle_dispatch_error(ex)\n      logger.error { \"Manager failed: #{ex.message}\" }\n      logger.error { ex.backtrace.join(\"\\n\") } unless ex.backtrace.nil?\n\n      Process.kill('USR1', Process.pid)\n\n      @running.make_false\n    end\n\n    # Fires a utilization update event\n    #\n    # @return [void]\n    def fire_utilization_update_event\n      fire_event :utilization_update, false, {\n        group: @group,\n        max_processors: @max_processors,\n        busy_processors: busy\n      }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "assign", "signature": "def assign(queue_name, sqs_msg)", "start_line": 139, "end_line": 159}, "metadata": {"module": "Shoryuken", "class_name": "Manager", "class_signature": "class Manager"}, "task_id": 370}
{"function_name": "initialize", "file_path": "shoryuken/lib/shoryuken/options.rb", "focal_code": "def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Stores and manages all Shoryuken configuration options.\n  # This class is used internally to hold settings for workers, queues,\n  # middleware, and other runtime configurations.\n  class Options\n    # Default configuration values for Shoryuken\n    DEFAULTS = {\n      thread_priority: -1,\n      concurrency: 25,\n      queues: [],\n      aws: {},\n      delay: 0.0,\n      timeout: 8,\n      lifecycle_events: {\n        startup: [],\n        dispatch: [],\n        utilization_update: [],\n        quiet: [],\n        shutdown: [],\n        stopped: []\n      }\n    }.freeze\n\n    # @return [Boolean] whether to enable ActiveJob queue name prefixing\n    # @return [Boolean] whether to cache SQS visibility timeout\n    # @return [Hash{String => Hash}] the configured processing groups\n    # @return [Object] the executor used to launch workers\n    # @return [Proc] the code reloader proc for development environments\n    # @return [Boolean] whether code reloading is enabled\n    # @return [Proc, nil] callback to execute when server starts\n    # @return [Proc, nil] callback to execute when server stops\n    # @return [Class] the executor class for running workers\n    # @return [Shoryuken::WorkerRegistry] the registry for worker classes\n    # @return [Array<#call>] handlers for processing exceptions\n    attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout,\n                  :groups, :launcher_executor, :reloader, :enable_reloading,\n                  :start_callback, :stop_callback, :worker_executor, :worker_registry,\n                  :exception_handlers\n\n    # @return [Hash] the default options for workers\n    # @return [Aws::SQS::Client] the SQS client instance\n    # @return [Logger] the logger instance\n    attr_writer :default_worker_options, :sqs_client, :logger\n\n    # @return [Hash] options passed to SQS receive_message calls\n    attr_reader :sqs_client_receive_message_opts\n\n    # Initializes a new Options instance with default values\n    def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end\n\n    # Checks if ActiveJob is available\n    #\n    # @return [Boolean] true if ActiveJob is defined\n    def active_job?\n      defined?(::ActiveJob)\n    end\n\n    # Adds a processing group with the specified concurrency and delay\n    #\n    # @param group [String] the name of the group\n    # @param concurrency [Integer, nil] the number of concurrent workers for the group\n    # @param delay [Float, nil] the delay between polling cycles\n    # @param polling_strategy [Class, String, nil] the polling strategy class for the group\n    # @return [Hash] the group configuration\n    # @raise [Errors::InvalidPollingStrategyError] if polling_strategy is not a Class, String, or nil\n    def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end\n\n    # Adds a queue to a processing group with the specified weight\n    #\n    # @param queue [String] the name of the queue\n    # @param weight [Integer] the weight (priority) of the queue\n    # @param group [String] the name of the group to add the queue to\n    # @return [void]\n    def add_queue(queue, weight, group)\n      weight.times do\n        groups[group][:queues] << queue\n      end\n    end\n\n    # Returns all queues from all groups\n    #\n    # @return [Array<String>] flat array of all queue names\n    def ungrouped_queues\n      groups.values.flat_map { |options| options[:queues] }\n    end\n\n    # Returns the polling strategy class for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Class] the polling strategy class to use\n    def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end\n\n    # Returns the polling delay for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Float] the delay in seconds\n    def delay(group)\n      groups[group].to_h.fetch(:delay, options[:delay]).to_f\n    end\n\n    # Returns the SQS client, initializing a default one if needed.\n    # Uses AWS configuration from options[:aws] if available.\n    #\n    # @return [Aws::SQS::Client] the SQS client\n    def sqs_client\n      @sqs_client ||= Aws::SQS::Client.new(options[:aws])\n    end\n\n    # Sets the SQS client receive message options for the default group\n    #\n    # @param sqs_client_receive_message_opts [Hash] the options hash\n    # @return [Hash] the options hash\n    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)\n      @sqs_client_receive_message_opts['default'] = sqs_client_receive_message_opts\n    end\n\n    # Returns the global options hash\n    #\n    # @return [Hash] the options hash\n    def options\n      @options ||= DEFAULTS.dup\n    end\n\n    # Returns the logger instance\n    #\n    # @return [Logger] the logger\n    def logger\n      @logger ||= Shoryuken::Logging.logger\n    end\n\n    # Returns the thread priority setting\n    #\n    # @return [Integer] the thread priority\n    def thread_priority\n      @thread_priority ||= options[:thread_priority]\n    end\n\n    # Sets the thread priority\n    #\n    # @param value [Integer] the thread priority value\n    # @return [Integer] the thread priority\n    attr_writer :thread_priority\n\n    # Registers a worker class with the worker registry\n    #\n    # @param args [Array] arguments to pass to the registry\n    # @return [void]\n    def register_worker(*args)\n      worker_registry.register_worker(*args)\n    end\n\n    # Yields self if running as a server for server-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_server\n      yield self if server?\n    end\n\n    # Returns the server middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the server middleware chain\n    def server_middleware\n      @_server_chain ||= default_server_middleware\n      yield @_server_chain if block_given?\n      @_server_chain\n    end\n\n    # Yields self unless running as a server for client-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_client\n      yield self unless server?\n    end\n\n    # Returns the client middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the client middleware chain\n    def client_middleware\n      @_client_chain ||= default_client_middleware\n      yield @_client_chain if block_given?\n      @_client_chain\n    end\n\n    # Returns the default worker options hash\n    #\n    # @return [Hash{String => Object}] the default worker options\n    def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end\n\n    # Registers a callback to run when the server starts\n    #\n    # @param block [Proc] the block to execute on start\n    # @return [void]\n    # @yield the block to execute on start\n    def on_start(&block)\n      self.start_callback = block\n    end\n\n    # Registers a callback to run when the server stops\n    #\n    # @param block [Proc] the block to execute on stop\n    # @return [void]\n    # @yield the block to execute on stop\n    def on_stop(&block)\n      self.stop_callback = block\n    end\n\n    # Registers a block to run at a point in the Shoryuken lifecycle.\n    #\n    # @param event [Symbol] the lifecycle event (:startup, :quiet, :shutdown, or :stopped)\n    # @param block [Proc] the block to execute for the event\n    # @return [void]\n    # @raise [ArgumentError] if event is not a Symbol or not a valid event name\n    # @yield the block to execute for the event\n    # @example\n    #   Shoryuken.configure_server do |config|\n    #     config.on(:shutdown) do\n    #       puts \"Goodbye cruel world!\"\n    #     end\n    #   end\n    def on(event, &block)\n      raise Errors::InvalidEventError, \"Symbols only please: #{event}\" unless event.is_a?(Symbol)\n      raise Errors::InvalidEventError, \"Invalid event name: #{event}\" unless options[:lifecycle_events].key?(event)\n\n      options[:lifecycle_events][event] << block\n    end\n\n    # Checks if running as a server (CLI mode)\n    #\n    # @return [Boolean] true if Shoryuken::CLI is defined\n    def server?\n      defined?(Shoryuken::CLI)\n    end\n\n    # Checks if visibility timeout caching is enabled\n    #\n    # @return [Boolean] true if caching is enabled\n    def cache_visibility_timeout?\n      @cache_visibility_timeout\n    end\n\n    # Checks if ActiveJob queue name prefixing is enabled\n    #\n    # @return [Boolean] true if prefixing is enabled\n    def active_job_queue_name_prefixing?\n      @active_job_queue_name_prefixing\n    end\n\n    private\n\n    # Creates the default server middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] the default middleware chain\n    def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end\n\n    # Creates the default client middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] an empty middleware chain\n    def default_client_middleware\n      Middleware::Chain.new\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize self.groups = {}", "start_line": 51, "end_line": 62}, "metadata": {"module": "Shoryuken", "class_name": "Options", "class_signature": "class Options"}, "task_id": 371}
{"function_name": "add_group", "file_path": "shoryuken/lib/shoryuken/options.rb", "focal_code": "def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Stores and manages all Shoryuken configuration options.\n  # This class is used internally to hold settings for workers, queues,\n  # middleware, and other runtime configurations.\n  class Options\n    # Default configuration values for Shoryuken\n    DEFAULTS = {\n      thread_priority: -1,\n      concurrency: 25,\n      queues: [],\n      aws: {},\n      delay: 0.0,\n      timeout: 8,\n      lifecycle_events: {\n        startup: [],\n        dispatch: [],\n        utilization_update: [],\n        quiet: [],\n        shutdown: [],\n        stopped: []\n      }\n    }.freeze\n\n    # @return [Boolean] whether to enable ActiveJob queue name prefixing\n    # @return [Boolean] whether to cache SQS visibility timeout\n    # @return [Hash{String => Hash}] the configured processing groups\n    # @return [Object] the executor used to launch workers\n    # @return [Proc] the code reloader proc for development environments\n    # @return [Boolean] whether code reloading is enabled\n    # @return [Proc, nil] callback to execute when server starts\n    # @return [Proc, nil] callback to execute when server stops\n    # @return [Class] the executor class for running workers\n    # @return [Shoryuken::WorkerRegistry] the registry for worker classes\n    # @return [Array<#call>] handlers for processing exceptions\n    attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout,\n                  :groups, :launcher_executor, :reloader, :enable_reloading,\n                  :start_callback, :stop_callback, :worker_executor, :worker_registry,\n                  :exception_handlers\n\n    # @return [Hash] the default options for workers\n    # @return [Aws::SQS::Client] the SQS client instance\n    # @return [Logger] the logger instance\n    attr_writer :default_worker_options, :sqs_client, :logger\n\n    # @return [Hash] options passed to SQS receive_message calls\n    attr_reader :sqs_client_receive_message_opts\n\n    # Initializes a new Options instance with default values\n    def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end\n\n    # Checks if ActiveJob is available\n    #\n    # @return [Boolean] true if ActiveJob is defined\n    def active_job?\n      defined?(::ActiveJob)\n    end\n\n    # Adds a processing group with the specified concurrency and delay\n    #\n    # @param group [String] the name of the group\n    # @param concurrency [Integer, nil] the number of concurrent workers for the group\n    # @param delay [Float, nil] the delay between polling cycles\n    # @param polling_strategy [Class, String, nil] the polling strategy class for the group\n    # @return [Hash] the group configuration\n    # @raise [Errors::InvalidPollingStrategyError] if polling_strategy is not a Class, String, or nil\n    def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end\n\n    # Adds a queue to a processing group with the specified weight\n    #\n    # @param queue [String] the name of the queue\n    # @param weight [Integer] the weight (priority) of the queue\n    # @param group [String] the name of the group to add the queue to\n    # @return [void]\n    def add_queue(queue, weight, group)\n      weight.times do\n        groups[group][:queues] << queue\n      end\n    end\n\n    # Returns all queues from all groups\n    #\n    # @return [Array<String>] flat array of all queue names\n    def ungrouped_queues\n      groups.values.flat_map { |options| options[:queues] }\n    end\n\n    # Returns the polling strategy class for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Class] the polling strategy class to use\n    def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end\n\n    # Returns the polling delay for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Float] the delay in seconds\n    def delay(group)\n      groups[group].to_h.fetch(:delay, options[:delay]).to_f\n    end\n\n    # Returns the SQS client, initializing a default one if needed.\n    # Uses AWS configuration from options[:aws] if available.\n    #\n    # @return [Aws::SQS::Client] the SQS client\n    def sqs_client\n      @sqs_client ||= Aws::SQS::Client.new(options[:aws])\n    end\n\n    # Sets the SQS client receive message options for the default group\n    #\n    # @param sqs_client_receive_message_opts [Hash] the options hash\n    # @return [Hash] the options hash\n    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)\n      @sqs_client_receive_message_opts['default'] = sqs_client_receive_message_opts\n    end\n\n    # Returns the global options hash\n    #\n    # @return [Hash] the options hash\n    def options\n      @options ||= DEFAULTS.dup\n    end\n\n    # Returns the logger instance\n    #\n    # @return [Logger] the logger\n    def logger\n      @logger ||= Shoryuken::Logging.logger\n    end\n\n    # Returns the thread priority setting\n    #\n    # @return [Integer] the thread priority\n    def thread_priority\n      @thread_priority ||= options[:thread_priority]\n    end\n\n    # Sets the thread priority\n    #\n    # @param value [Integer] the thread priority value\n    # @return [Integer] the thread priority\n    attr_writer :thread_priority\n\n    # Registers a worker class with the worker registry\n    #\n    # @param args [Array] arguments to pass to the registry\n    # @return [void]\n    def register_worker(*args)\n      worker_registry.register_worker(*args)\n    end\n\n    # Yields self if running as a server for server-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_server\n      yield self if server?\n    end\n\n    # Returns the server middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the server middleware chain\n    def server_middleware\n      @_server_chain ||= default_server_middleware\n      yield @_server_chain if block_given?\n      @_server_chain\n    end\n\n    # Yields self unless running as a server for client-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_client\n      yield self unless server?\n    end\n\n    # Returns the client middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the client middleware chain\n    def client_middleware\n      @_client_chain ||= default_client_middleware\n      yield @_client_chain if block_given?\n      @_client_chain\n    end\n\n    # Returns the default worker options hash\n    #\n    # @return [Hash{String => Object}] the default worker options\n    def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end\n\n    # Registers a callback to run when the server starts\n    #\n    # @param block [Proc] the block to execute on start\n    # @return [void]\n    # @yield the block to execute on start\n    def on_start(&block)\n      self.start_callback = block\n    end\n\n    # Registers a callback to run when the server stops\n    #\n    # @param block [Proc] the block to execute on stop\n    # @return [void]\n    # @yield the block to execute on stop\n    def on_stop(&block)\n      self.stop_callback = block\n    end\n\n    # Registers a block to run at a point in the Shoryuken lifecycle.\n    #\n    # @param event [Symbol] the lifecycle event (:startup, :quiet, :shutdown, or :stopped)\n    # @param block [Proc] the block to execute for the event\n    # @return [void]\n    # @raise [ArgumentError] if event is not a Symbol or not a valid event name\n    # @yield the block to execute for the event\n    # @example\n    #   Shoryuken.configure_server do |config|\n    #     config.on(:shutdown) do\n    #       puts \"Goodbye cruel world!\"\n    #     end\n    #   end\n    def on(event, &block)\n      raise Errors::InvalidEventError, \"Symbols only please: #{event}\" unless event.is_a?(Symbol)\n      raise Errors::InvalidEventError, \"Invalid event name: #{event}\" unless options[:lifecycle_events].key?(event)\n\n      options[:lifecycle_events][event] << block\n    end\n\n    # Checks if running as a server (CLI mode)\n    #\n    # @return [Boolean] true if Shoryuken::CLI is defined\n    def server?\n      defined?(Shoryuken::CLI)\n    end\n\n    # Checks if visibility timeout caching is enabled\n    #\n    # @return [Boolean] true if caching is enabled\n    def cache_visibility_timeout?\n      @cache_visibility_timeout\n    end\n\n    # Checks if ActiveJob queue name prefixing is enabled\n    #\n    # @return [Boolean] true if prefixing is enabled\n    def active_job_queue_name_prefixing?\n      @active_job_queue_name_prefixing\n    end\n\n    private\n\n    # Creates the default server middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] the default middleware chain\n    def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end\n\n    # Creates the default client middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] an empty middleware chain\n    def default_client_middleware\n      Middleware::Chain.new\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "add_group", "signature": "def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)", "start_line": 79, "end_line": 93}, "metadata": {"module": "Shoryuken", "class_name": "Options", "class_signature": "class Options"}, "task_id": 372}
{"function_name": "polling_strategy", "file_path": "shoryuken/lib/shoryuken/options.rb", "focal_code": "def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Stores and manages all Shoryuken configuration options.\n  # This class is used internally to hold settings for workers, queues,\n  # middleware, and other runtime configurations.\n  class Options\n    # Default configuration values for Shoryuken\n    DEFAULTS = {\n      thread_priority: -1,\n      concurrency: 25,\n      queues: [],\n      aws: {},\n      delay: 0.0,\n      timeout: 8,\n      lifecycle_events: {\n        startup: [],\n        dispatch: [],\n        utilization_update: [],\n        quiet: [],\n        shutdown: [],\n        stopped: []\n      }\n    }.freeze\n\n    # @return [Boolean] whether to enable ActiveJob queue name prefixing\n    # @return [Boolean] whether to cache SQS visibility timeout\n    # @return [Hash{String => Hash}] the configured processing groups\n    # @return [Object] the executor used to launch workers\n    # @return [Proc] the code reloader proc for development environments\n    # @return [Boolean] whether code reloading is enabled\n    # @return [Proc, nil] callback to execute when server starts\n    # @return [Proc, nil] callback to execute when server stops\n    # @return [Class] the executor class for running workers\n    # @return [Shoryuken::WorkerRegistry] the registry for worker classes\n    # @return [Array<#call>] handlers for processing exceptions\n    attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout,\n                  :groups, :launcher_executor, :reloader, :enable_reloading,\n                  :start_callback, :stop_callback, :worker_executor, :worker_registry,\n                  :exception_handlers\n\n    # @return [Hash] the default options for workers\n    # @return [Aws::SQS::Client] the SQS client instance\n    # @return [Logger] the logger instance\n    attr_writer :default_worker_options, :sqs_client, :logger\n\n    # @return [Hash] options passed to SQS receive_message calls\n    attr_reader :sqs_client_receive_message_opts\n\n    # Initializes a new Options instance with default values\n    def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end\n\n    # Checks if ActiveJob is available\n    #\n    # @return [Boolean] true if ActiveJob is defined\n    def active_job?\n      defined?(::ActiveJob)\n    end\n\n    # Adds a processing group with the specified concurrency and delay\n    #\n    # @param group [String] the name of the group\n    # @param concurrency [Integer, nil] the number of concurrent workers for the group\n    # @param delay [Float, nil] the delay between polling cycles\n    # @param polling_strategy [Class, String, nil] the polling strategy class for the group\n    # @return [Hash] the group configuration\n    # @raise [Errors::InvalidPollingStrategyError] if polling_strategy is not a Class, String, or nil\n    def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end\n\n    # Adds a queue to a processing group with the specified weight\n    #\n    # @param queue [String] the name of the queue\n    # @param weight [Integer] the weight (priority) of the queue\n    # @param group [String] the name of the group to add the queue to\n    # @return [void]\n    def add_queue(queue, weight, group)\n      weight.times do\n        groups[group][:queues] << queue\n      end\n    end\n\n    # Returns all queues from all groups\n    #\n    # @return [Array<String>] flat array of all queue names\n    def ungrouped_queues\n      groups.values.flat_map { |options| options[:queues] }\n    end\n\n    # Returns the polling strategy class for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Class] the polling strategy class to use\n    def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end\n\n    # Returns the polling delay for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Float] the delay in seconds\n    def delay(group)\n      groups[group].to_h.fetch(:delay, options[:delay]).to_f\n    end\n\n    # Returns the SQS client, initializing a default one if needed.\n    # Uses AWS configuration from options[:aws] if available.\n    #\n    # @return [Aws::SQS::Client] the SQS client\n    def sqs_client\n      @sqs_client ||= Aws::SQS::Client.new(options[:aws])\n    end\n\n    # Sets the SQS client receive message options for the default group\n    #\n    # @param sqs_client_receive_message_opts [Hash] the options hash\n    # @return [Hash] the options hash\n    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)\n      @sqs_client_receive_message_opts['default'] = sqs_client_receive_message_opts\n    end\n\n    # Returns the global options hash\n    #\n    # @return [Hash] the options hash\n    def options\n      @options ||= DEFAULTS.dup\n    end\n\n    # Returns the logger instance\n    #\n    # @return [Logger] the logger\n    def logger\n      @logger ||= Shoryuken::Logging.logger\n    end\n\n    # Returns the thread priority setting\n    #\n    # @return [Integer] the thread priority\n    def thread_priority\n      @thread_priority ||= options[:thread_priority]\n    end\n\n    # Sets the thread priority\n    #\n    # @param value [Integer] the thread priority value\n    # @return [Integer] the thread priority\n    attr_writer :thread_priority\n\n    # Registers a worker class with the worker registry\n    #\n    # @param args [Array] arguments to pass to the registry\n    # @return [void]\n    def register_worker(*args)\n      worker_registry.register_worker(*args)\n    end\n\n    # Yields self if running as a server for server-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_server\n      yield self if server?\n    end\n\n    # Returns the server middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the server middleware chain\n    def server_middleware\n      @_server_chain ||= default_server_middleware\n      yield @_server_chain if block_given?\n      @_server_chain\n    end\n\n    # Yields self unless running as a server for client-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_client\n      yield self unless server?\n    end\n\n    # Returns the client middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the client middleware chain\n    def client_middleware\n      @_client_chain ||= default_client_middleware\n      yield @_client_chain if block_given?\n      @_client_chain\n    end\n\n    # Returns the default worker options hash\n    #\n    # @return [Hash{String => Object}] the default worker options\n    def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end\n\n    # Registers a callback to run when the server starts\n    #\n    # @param block [Proc] the block to execute on start\n    # @return [void]\n    # @yield the block to execute on start\n    def on_start(&block)\n      self.start_callback = block\n    end\n\n    # Registers a callback to run when the server stops\n    #\n    # @param block [Proc] the block to execute on stop\n    # @return [void]\n    # @yield the block to execute on stop\n    def on_stop(&block)\n      self.stop_callback = block\n    end\n\n    # Registers a block to run at a point in the Shoryuken lifecycle.\n    #\n    # @param event [Symbol] the lifecycle event (:startup, :quiet, :shutdown, or :stopped)\n    # @param block [Proc] the block to execute for the event\n    # @return [void]\n    # @raise [ArgumentError] if event is not a Symbol or not a valid event name\n    # @yield the block to execute for the event\n    # @example\n    #   Shoryuken.configure_server do |config|\n    #     config.on(:shutdown) do\n    #       puts \"Goodbye cruel world!\"\n    #     end\n    #   end\n    def on(event, &block)\n      raise Errors::InvalidEventError, \"Symbols only please: #{event}\" unless event.is_a?(Symbol)\n      raise Errors::InvalidEventError, \"Invalid event name: #{event}\" unless options[:lifecycle_events].key?(event)\n\n      options[:lifecycle_events][event] << block\n    end\n\n    # Checks if running as a server (CLI mode)\n    #\n    # @return [Boolean] true if Shoryuken::CLI is defined\n    def server?\n      defined?(Shoryuken::CLI)\n    end\n\n    # Checks if visibility timeout caching is enabled\n    #\n    # @return [Boolean] true if caching is enabled\n    def cache_visibility_timeout?\n      @cache_visibility_timeout\n    end\n\n    # Checks if ActiveJob queue name prefixing is enabled\n    #\n    # @return [Boolean] true if prefixing is enabled\n    def active_job_queue_name_prefixing?\n      @active_job_queue_name_prefixing\n    end\n\n    private\n\n    # Creates the default server middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] the default middleware chain\n    def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end\n\n    # Creates the default client middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] an empty middleware chain\n    def default_client_middleware\n      Middleware::Chain.new\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "polling_strategy", "signature": "def polling_strategy(group)", "start_line": 118, "end_line": 135}, "metadata": {"module": "Shoryuken", "class_name": "Options", "class_signature": "class Options"}, "task_id": 373}
{"function_name": "default_worker_options", "file_path": "shoryuken/lib/shoryuken/options.rb", "focal_code": "def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Stores and manages all Shoryuken configuration options.\n  # This class is used internally to hold settings for workers, queues,\n  # middleware, and other runtime configurations.\n  class Options\n    # Default configuration values for Shoryuken\n    DEFAULTS = {\n      thread_priority: -1,\n      concurrency: 25,\n      queues: [],\n      aws: {},\n      delay: 0.0,\n      timeout: 8,\n      lifecycle_events: {\n        startup: [],\n        dispatch: [],\n        utilization_update: [],\n        quiet: [],\n        shutdown: [],\n        stopped: []\n      }\n    }.freeze\n\n    # @return [Boolean] whether to enable ActiveJob queue name prefixing\n    # @return [Boolean] whether to cache SQS visibility timeout\n    # @return [Hash{String => Hash}] the configured processing groups\n    # @return [Object] the executor used to launch workers\n    # @return [Proc] the code reloader proc for development environments\n    # @return [Boolean] whether code reloading is enabled\n    # @return [Proc, nil] callback to execute when server starts\n    # @return [Proc, nil] callback to execute when server stops\n    # @return [Class] the executor class for running workers\n    # @return [Shoryuken::WorkerRegistry] the registry for worker classes\n    # @return [Array<#call>] handlers for processing exceptions\n    attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout,\n                  :groups, :launcher_executor, :reloader, :enable_reloading,\n                  :start_callback, :stop_callback, :worker_executor, :worker_registry,\n                  :exception_handlers\n\n    # @return [Hash] the default options for workers\n    # @return [Aws::SQS::Client] the SQS client instance\n    # @return [Logger] the logger instance\n    attr_writer :default_worker_options, :sqs_client, :logger\n\n    # @return [Hash] options passed to SQS receive_message calls\n    attr_reader :sqs_client_receive_message_opts\n\n    # Initializes a new Options instance with default values\n    def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end\n\n    # Checks if ActiveJob is available\n    #\n    # @return [Boolean] true if ActiveJob is defined\n    def active_job?\n      defined?(::ActiveJob)\n    end\n\n    # Adds a processing group with the specified concurrency and delay\n    #\n    # @param group [String] the name of the group\n    # @param concurrency [Integer, nil] the number of concurrent workers for the group\n    # @param delay [Float, nil] the delay between polling cycles\n    # @param polling_strategy [Class, String, nil] the polling strategy class for the group\n    # @return [Hash] the group configuration\n    # @raise [Errors::InvalidPollingStrategyError] if polling_strategy is not a Class, String, or nil\n    def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end\n\n    # Adds a queue to a processing group with the specified weight\n    #\n    # @param queue [String] the name of the queue\n    # @param weight [Integer] the weight (priority) of the queue\n    # @param group [String] the name of the group to add the queue to\n    # @return [void]\n    def add_queue(queue, weight, group)\n      weight.times do\n        groups[group][:queues] << queue\n      end\n    end\n\n    # Returns all queues from all groups\n    #\n    # @return [Array<String>] flat array of all queue names\n    def ungrouped_queues\n      groups.values.flat_map { |options| options[:queues] }\n    end\n\n    # Returns the polling strategy class for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Class] the polling strategy class to use\n    def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end\n\n    # Returns the polling delay for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Float] the delay in seconds\n    def delay(group)\n      groups[group].to_h.fetch(:delay, options[:delay]).to_f\n    end\n\n    # Returns the SQS client, initializing a default one if needed.\n    # Uses AWS configuration from options[:aws] if available.\n    #\n    # @return [Aws::SQS::Client] the SQS client\n    def sqs_client\n      @sqs_client ||= Aws::SQS::Client.new(options[:aws])\n    end\n\n    # Sets the SQS client receive message options for the default group\n    #\n    # @param sqs_client_receive_message_opts [Hash] the options hash\n    # @return [Hash] the options hash\n    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)\n      @sqs_client_receive_message_opts['default'] = sqs_client_receive_message_opts\n    end\n\n    # Returns the global options hash\n    #\n    # @return [Hash] the options hash\n    def options\n      @options ||= DEFAULTS.dup\n    end\n\n    # Returns the logger instance\n    #\n    # @return [Logger] the logger\n    def logger\n      @logger ||= Shoryuken::Logging.logger\n    end\n\n    # Returns the thread priority setting\n    #\n    # @return [Integer] the thread priority\n    def thread_priority\n      @thread_priority ||= options[:thread_priority]\n    end\n\n    # Sets the thread priority\n    #\n    # @param value [Integer] the thread priority value\n    # @return [Integer] the thread priority\n    attr_writer :thread_priority\n\n    # Registers a worker class with the worker registry\n    #\n    # @param args [Array] arguments to pass to the registry\n    # @return [void]\n    def register_worker(*args)\n      worker_registry.register_worker(*args)\n    end\n\n    # Yields self if running as a server for server-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_server\n      yield self if server?\n    end\n\n    # Returns the server middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the server middleware chain\n    def server_middleware\n      @_server_chain ||= default_server_middleware\n      yield @_server_chain if block_given?\n      @_server_chain\n    end\n\n    # Yields self unless running as a server for client-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_client\n      yield self unless server?\n    end\n\n    # Returns the client middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the client middleware chain\n    def client_middleware\n      @_client_chain ||= default_client_middleware\n      yield @_client_chain if block_given?\n      @_client_chain\n    end\n\n    # Returns the default worker options hash\n    #\n    # @return [Hash{String => Object}] the default worker options\n    def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end\n\n    # Registers a callback to run when the server starts\n    #\n    # @param block [Proc] the block to execute on start\n    # @return [void]\n    # @yield the block to execute on start\n    def on_start(&block)\n      self.start_callback = block\n    end\n\n    # Registers a callback to run when the server stops\n    #\n    # @param block [Proc] the block to execute on stop\n    # @return [void]\n    # @yield the block to execute on stop\n    def on_stop(&block)\n      self.stop_callback = block\n    end\n\n    # Registers a block to run at a point in the Shoryuken lifecycle.\n    #\n    # @param event [Symbol] the lifecycle event (:startup, :quiet, :shutdown, or :stopped)\n    # @param block [Proc] the block to execute for the event\n    # @return [void]\n    # @raise [ArgumentError] if event is not a Symbol or not a valid event name\n    # @yield the block to execute for the event\n    # @example\n    #   Shoryuken.configure_server do |config|\n    #     config.on(:shutdown) do\n    #       puts \"Goodbye cruel world!\"\n    #     end\n    #   end\n    def on(event, &block)\n      raise Errors::InvalidEventError, \"Symbols only please: #{event}\" unless event.is_a?(Symbol)\n      raise Errors::InvalidEventError, \"Invalid event name: #{event}\" unless options[:lifecycle_events].key?(event)\n\n      options[:lifecycle_events][event] << block\n    end\n\n    # Checks if running as a server (CLI mode)\n    #\n    # @return [Boolean] true if Shoryuken::CLI is defined\n    def server?\n      defined?(Shoryuken::CLI)\n    end\n\n    # Checks if visibility timeout caching is enabled\n    #\n    # @return [Boolean] true if caching is enabled\n    def cache_visibility_timeout?\n      @cache_visibility_timeout\n    end\n\n    # Checks if ActiveJob queue name prefixing is enabled\n    #\n    # @return [Boolean] true if prefixing is enabled\n    def active_job_queue_name_prefixing?\n      @active_job_queue_name_prefixing\n    end\n\n    private\n\n    # Creates the default server middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] the default middleware chain\n    def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end\n\n    # Creates the default client middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] an empty middleware chain\n    def default_client_middleware\n      Middleware::Chain.new\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "default_worker_options", "signature": "def default_worker_options @default_worker_options ||= {", "start_line": 235, "end_line": 244}, "metadata": {"module": "Shoryuken", "class_name": "Options", "class_signature": "class Options"}, "task_id": 374}
{"function_name": "default_server_middleware", "file_path": "shoryuken/lib/shoryuken/options.rb", "focal_code": "def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Stores and manages all Shoryuken configuration options.\n  # This class is used internally to hold settings for workers, queues,\n  # middleware, and other runtime configurations.\n  class Options\n    # Default configuration values for Shoryuken\n    DEFAULTS = {\n      thread_priority: -1,\n      concurrency: 25,\n      queues: [],\n      aws: {},\n      delay: 0.0,\n      timeout: 8,\n      lifecycle_events: {\n        startup: [],\n        dispatch: [],\n        utilization_update: [],\n        quiet: [],\n        shutdown: [],\n        stopped: []\n      }\n    }.freeze\n\n    # @return [Boolean] whether to enable ActiveJob queue name prefixing\n    # @return [Boolean] whether to cache SQS visibility timeout\n    # @return [Hash{String => Hash}] the configured processing groups\n    # @return [Object] the executor used to launch workers\n    # @return [Proc] the code reloader proc for development environments\n    # @return [Boolean] whether code reloading is enabled\n    # @return [Proc, nil] callback to execute when server starts\n    # @return [Proc, nil] callback to execute when server stops\n    # @return [Class] the executor class for running workers\n    # @return [Shoryuken::WorkerRegistry] the registry for worker classes\n    # @return [Array<#call>] handlers for processing exceptions\n    attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout,\n                  :groups, :launcher_executor, :reloader, :enable_reloading,\n                  :start_callback, :stop_callback, :worker_executor, :worker_registry,\n                  :exception_handlers\n\n    # @return [Hash] the default options for workers\n    # @return [Aws::SQS::Client] the SQS client instance\n    # @return [Logger] the logger instance\n    attr_writer :default_worker_options, :sqs_client, :logger\n\n    # @return [Hash] options passed to SQS receive_message calls\n    attr_reader :sqs_client_receive_message_opts\n\n    # Initializes a new Options instance with default values\n    def initialize\n      self.groups = {}\n      self.worker_registry = DefaultWorkerRegistry.new\n      self.exception_handlers = [DefaultExceptionHandler]\n      self.active_job_queue_name_prefixing = false\n      self.worker_executor = Worker::DefaultExecutor\n      self.cache_visibility_timeout = false\n      self.reloader = proc { |&block| block.call }\n      self.enable_reloading ||= false\n      # this is needed for keeping backward compatibility\n      @sqs_client_receive_message_opts ||= {}\n    end\n\n    # Checks if ActiveJob is available\n    #\n    # @return [Boolean] true if ActiveJob is defined\n    def active_job?\n      defined?(::ActiveJob)\n    end\n\n    # Adds a processing group with the specified concurrency and delay\n    #\n    # @param group [String] the name of the group\n    # @param concurrency [Integer, nil] the number of concurrent workers for the group\n    # @param delay [Float, nil] the delay between polling cycles\n    # @param polling_strategy [Class, String, nil] the polling strategy class for the group\n    # @return [Hash] the group configuration\n    # @raise [Errors::InvalidPollingStrategyError] if polling_strategy is not a Class, String, or nil\n    def add_group(group, concurrency = nil, delay: nil, polling_strategy: nil)\n      unless polling_strategy.nil? || polling_strategy.is_a?(Class) || polling_strategy.is_a?(String)\n        raise Errors::InvalidPollingStrategyError, \"#{polling_strategy} is not a valid polling_strategy\"\n      end\n\n      concurrency ||= options[:concurrency]\n      delay ||= options[:delay]\n\n      groups[group] ||= {\n        concurrency: concurrency,\n        delay: delay,\n        polling_strategy: polling_strategy,\n        queues: []\n      }\n    end\n\n    # Adds a queue to a processing group with the specified weight\n    #\n    # @param queue [String] the name of the queue\n    # @param weight [Integer] the weight (priority) of the queue\n    # @param group [String] the name of the group to add the queue to\n    # @return [void]\n    def add_queue(queue, weight, group)\n      weight.times do\n        groups[group][:queues] << queue\n      end\n    end\n\n    # Returns all queues from all groups\n    #\n    # @return [Array<String>] flat array of all queue names\n    def ungrouped_queues\n      groups.values.flat_map { |options| options[:queues] }\n    end\n\n    # Returns the polling strategy class for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Class] the polling strategy class to use\n    def polling_strategy(group)\n      strategy = groups[group].to_h[:polling_strategy] ||\n                 (group == 'default' ? options : options[:groups].to_h[group]).to_h[:polling_strategy]\n      case strategy\n      when 'WeightedRoundRobin', nil # Default case\n        Polling::WeightedRoundRobin\n      when 'StrictPriority'\n        Polling::StrictPriority\n      when String\n        begin\n          Object.const_get(strategy)\n        rescue NameError\n          raise Errors::InvalidPollingStrategyError, \"#{strategy} is not a valid polling_strategy\"\n        end\n      when Class\n        strategy\n      end\n    end\n\n    # Returns the polling delay for a group\n    #\n    # @param group [String] the name of the group\n    # @return [Float] the delay in seconds\n    def delay(group)\n      groups[group].to_h.fetch(:delay, options[:delay]).to_f\n    end\n\n    # Returns the SQS client, initializing a default one if needed.\n    # Uses AWS configuration from options[:aws] if available.\n    #\n    # @return [Aws::SQS::Client] the SQS client\n    def sqs_client\n      @sqs_client ||= Aws::SQS::Client.new(options[:aws])\n    end\n\n    # Sets the SQS client receive message options for the default group\n    #\n    # @param sqs_client_receive_message_opts [Hash] the options hash\n    # @return [Hash] the options hash\n    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)\n      @sqs_client_receive_message_opts['default'] = sqs_client_receive_message_opts\n    end\n\n    # Returns the global options hash\n    #\n    # @return [Hash] the options hash\n    def options\n      @options ||= DEFAULTS.dup\n    end\n\n    # Returns the logger instance\n    #\n    # @return [Logger] the logger\n    def logger\n      @logger ||= Shoryuken::Logging.logger\n    end\n\n    # Returns the thread priority setting\n    #\n    # @return [Integer] the thread priority\n    def thread_priority\n      @thread_priority ||= options[:thread_priority]\n    end\n\n    # Sets the thread priority\n    #\n    # @param value [Integer] the thread priority value\n    # @return [Integer] the thread priority\n    attr_writer :thread_priority\n\n    # Registers a worker class with the worker registry\n    #\n    # @param args [Array] arguments to pass to the registry\n    # @return [void]\n    def register_worker(*args)\n      worker_registry.register_worker(*args)\n    end\n\n    # Yields self if running as a server for server-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_server\n      yield self if server?\n    end\n\n    # Returns the server middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the server middleware chain\n    def server_middleware\n      @_server_chain ||= default_server_middleware\n      yield @_server_chain if block_given?\n      @_server_chain\n    end\n\n    # Yields self unless running as a server for client-specific configuration\n    #\n    # @yield [Shoryuken::Options] the options instance\n    # @return [void]\n    def configure_client\n      yield self unless server?\n    end\n\n    # Returns the client middleware chain\n    #\n    # @yield [Shoryuken::Middleware::Chain] the middleware chain for configuration\n    # @return [Shoryuken::Middleware::Chain] the client middleware chain\n    def client_middleware\n      @_client_chain ||= default_client_middleware\n      yield @_client_chain if block_given?\n      @_client_chain\n    end\n\n    # Returns the default worker options hash\n    #\n    # @return [Hash{String => Object}] the default worker options\n    def default_worker_options\n      @default_worker_options ||= {\n        'queue' => 'default',\n        'delete' => false,\n        'auto_delete' => false,\n        'auto_visibility_timeout' => false,\n        'retry_intervals' => nil,\n        'batch' => false\n      }\n    end\n\n    # Registers a callback to run when the server starts\n    #\n    # @param block [Proc] the block to execute on start\n    # @return [void]\n    # @yield the block to execute on start\n    def on_start(&block)\n      self.start_callback = block\n    end\n\n    # Registers a callback to run when the server stops\n    #\n    # @param block [Proc] the block to execute on stop\n    # @return [void]\n    # @yield the block to execute on stop\n    def on_stop(&block)\n      self.stop_callback = block\n    end\n\n    # Registers a block to run at a point in the Shoryuken lifecycle.\n    #\n    # @param event [Symbol] the lifecycle event (:startup, :quiet, :shutdown, or :stopped)\n    # @param block [Proc] the block to execute for the event\n    # @return [void]\n    # @raise [ArgumentError] if event is not a Symbol or not a valid event name\n    # @yield the block to execute for the event\n    # @example\n    #   Shoryuken.configure_server do |config|\n    #     config.on(:shutdown) do\n    #       puts \"Goodbye cruel world!\"\n    #     end\n    #   end\n    def on(event, &block)\n      raise Errors::InvalidEventError, \"Symbols only please: #{event}\" unless event.is_a?(Symbol)\n      raise Errors::InvalidEventError, \"Invalid event name: #{event}\" unless options[:lifecycle_events].key?(event)\n\n      options[:lifecycle_events][event] << block\n    end\n\n    # Checks if running as a server (CLI mode)\n    #\n    # @return [Boolean] true if Shoryuken::CLI is defined\n    def server?\n      defined?(Shoryuken::CLI)\n    end\n\n    # Checks if visibility timeout caching is enabled\n    #\n    # @return [Boolean] true if caching is enabled\n    def cache_visibility_timeout?\n      @cache_visibility_timeout\n    end\n\n    # Checks if ActiveJob queue name prefixing is enabled\n    #\n    # @return [Boolean] true if prefixing is enabled\n    def active_job_queue_name_prefixing?\n      @active_job_queue_name_prefixing\n    end\n\n    private\n\n    # Creates the default server middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] the default middleware chain\n    def default_server_middleware\n      Middleware::Chain.new do |m|\n        m.add Middleware::Server::Timing\n        m.add Middleware::Server::NonRetryableException\n        m.add Middleware::Server::ExponentialBackoffRetry\n        m.add Middleware::Server::AutoDelete\n        m.add Middleware::Server::AutoExtendVisibility\n        if defined?(::ActiveRecord::Base)\n          require 'shoryuken/middleware/server/active_record'\n          m.add Middleware::Server::ActiveRecord\n        end\n      end\n    end\n\n    # Creates the default client middleware chain\n    #\n    # @return [Shoryuken::Middleware::Chain] an empty middleware chain\n    def default_client_middleware\n      Middleware::Chain.new\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "default_server_middleware", "signature": "def default_server_middleware Middleware::Chain.new do |m|", "start_line": 310, "end_line": 322}, "metadata": {"module": "Shoryuken", "class_name": "Options", "class_signature": "class Options"}, "task_id": 375}
{"function_name": "daemonize", "file_path": "shoryuken/lib/shoryuken/runner.rb", "focal_code": "def daemonize(options)\n      return unless options[:daemon]\n\n      files_to_reopen = []\n      ObjectSpace.each_object(File) do |file|\n        files_to_reopen << file unless file.closed?\n      end\n\n      Process.daemon(true, true)\n\n      files_to_reopen.each do |file|\n        file.reopen file.path, 'a+'\n        file.sync = true\n      rescue ::Exception\n      end\n\n      [$stdout, $stderr].each do |io|\n        File.open(options[:logfile], 'ab') do |f|\n          io.reopen(f)\n        end\n        io.sync = true\n      end\n      $stdin.reopen('/dev/null')\n    end", "file_content": "# frozen_string_literal: true\n\n$stdout.sync = true\n\nrequire 'singleton'\nrequire 'optparse'\nrequire 'erb'\n\nrequire 'shoryuken'\n\nmodule Shoryuken\n  # Runs the Shoryuken server process.\n  # Handles signal trapping, daemonization, and lifecycle management.\n  class Runner\n    include Util\n    include Singleton\n\n    # @return [Shoryuken::Launcher, nil] the launcher instance, or nil if not yet initialized\n    attr_reader :launcher\n\n    # Runs the Shoryuken server with the given options\n    #\n    # @param options [Hash] runtime configuration options\n    # @option options [Boolean] :daemon whether to daemonize the process\n    # @option options [String] :pidfile path to the PID file\n    # @option options [String] :logfile path to the log file\n    # @option options [String] :config_file path to the configuration file\n    # @return [void]\n    def run(options)\n      self_read, self_write = IO.pipe\n\n      %w[INT TERM USR1 TSTP TTIN].each do |sig|\n        trap sig do\n          self_write.puts(sig)\n        end\n      rescue ArgumentError\n        puts \"Signal #{sig} not supported\"\n      end\n\n      loader = EnvironmentLoader.setup_options(options)\n\n      daemonize(Shoryuken.options)\n      write_pid(Shoryuken.options)\n\n      loader.load\n\n      initialize_concurrent_logger\n\n      @launcher = Shoryuken::Launcher.new\n\n      begin\n        @launcher.start\n\n        while (readable_io = IO.select([self_read]))\n          signal = readable_io.first[0].gets.strip\n          handle_signal(signal)\n        end\n      rescue Interrupt\n        @launcher.stop!\n        exit 0\n      end\n    end\n\n    # Checks if the server is healthy\n    #\n    # @return [Boolean] true if the launcher is running and healthy\n    def healthy?\n      (@launcher && @launcher.healthy?) || false\n    end\n\n    private\n\n    # Initializes the Concurrent Ruby logger\n    #\n    # @return [void]\n    def initialize_concurrent_logger\n      return unless Shoryuken.logger\n\n      Concurrent.global_logger = lambda do |level, progname, msg = nil, &block|\n        Shoryuken.logger.log(level, msg, progname, &block)\n      end\n    end\n\n    # Daemonizes the process\n    #\n    # @param options [Hash] options containing daemon and logfile settings\n    # @option options [Boolean] :daemon whether to daemonize\n    # @option options [String] :logfile path to the log file for daemon output\n    # @return [void]\n    def daemonize(options)\n      return unless options[:daemon]\n\n      files_to_reopen = []\n      ObjectSpace.each_object(File) do |file|\n        files_to_reopen << file unless file.closed?\n      end\n\n      Process.daemon(true, true)\n\n      files_to_reopen.each do |file|\n        file.reopen file.path, 'a+'\n        file.sync = true\n      rescue ::Exception\n      end\n\n      [$stdout, $stderr].each do |io|\n        File.open(options[:logfile], 'ab') do |f|\n          io.reopen(f)\n        end\n        io.sync = true\n      end\n      $stdin.reopen('/dev/null')\n    end\n\n    # Writes the process ID to a file\n    #\n    # @param options [Hash] options containing the pidfile path\n    # @option options [String] :pidfile path to write the PID file\n    # @return [void]\n    def write_pid(options)\n      return unless (path = options[:pidfile])\n\n      File.open(path, 'w') { |f| f.puts(Process.pid) }\n    end\n\n    # Executes a soft shutdown on USR1 signal\n    #\n    # @return [void]\n    def execute_soft_shutdown\n      logger.info { 'Received USR1, will soft shutdown' }\n\n      @launcher.stop\n      exit 0\n    end\n\n    # Executes a terminal stop on TSTP signal\n    #\n    # @return [void]\n    def execute_terminal_stop\n      logger.info { 'Received TSTP, will stop accepting new work' }\n\n      @launcher.stop\n    end\n\n    # Prints backtraces of all threads\n    #\n    # @return [void]\n    def print_threads_backtrace\n      Thread.list.each do |thread|\n        logger.info { \"Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}\" }\n        if thread.backtrace\n          logger.info { thread.backtrace.join(\"\\n\") }\n        else\n          logger.info { '<no backtrace available>' }\n        end\n      end\n    end\n\n    # Handles incoming signals\n    #\n    # @param sig [String] the signal name\n    # @return [void]\n    # @raise [Interrupt] on TERM or INT signals\n    def handle_signal(sig)\n      logger.debug \"Got #{sig} signal\"\n\n      case sig\n      when 'USR1' then execute_soft_shutdown\n      when 'TTIN' then print_threads_backtrace\n      when 'TSTP' then execute_terminal_stop\n      when 'TERM', 'INT'\n        logger.info { \"Received #{sig}, will shutdown\" }\n\n        raise Interrupt\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "daemonize", "signature": "def daemonize(options)", "start_line": 90, "end_line": 113}, "metadata": {"module": "Shoryuken", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 376}
{"function_name": "print_threads_backtrace", "file_path": "shoryuken/lib/shoryuken/runner.rb", "focal_code": "def print_threads_backtrace\n      Thread.list.each do |thread|\n        logger.info { \"Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}\" }\n        if thread.backtrace\n          logger.info { thread.backtrace.join(\"\\n\") }\n        else\n          logger.info { '<no backtrace available>' }\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\n$stdout.sync = true\n\nrequire 'singleton'\nrequire 'optparse'\nrequire 'erb'\n\nrequire 'shoryuken'\n\nmodule Shoryuken\n  # Runs the Shoryuken server process.\n  # Handles signal trapping, daemonization, and lifecycle management.\n  class Runner\n    include Util\n    include Singleton\n\n    # @return [Shoryuken::Launcher, nil] the launcher instance, or nil if not yet initialized\n    attr_reader :launcher\n\n    # Runs the Shoryuken server with the given options\n    #\n    # @param options [Hash] runtime configuration options\n    # @option options [Boolean] :daemon whether to daemonize the process\n    # @option options [String] :pidfile path to the PID file\n    # @option options [String] :logfile path to the log file\n    # @option options [String] :config_file path to the configuration file\n    # @return [void]\n    def run(options)\n      self_read, self_write = IO.pipe\n\n      %w[INT TERM USR1 TSTP TTIN].each do |sig|\n        trap sig do\n          self_write.puts(sig)\n        end\n      rescue ArgumentError\n        puts \"Signal #{sig} not supported\"\n      end\n\n      loader = EnvironmentLoader.setup_options(options)\n\n      daemonize(Shoryuken.options)\n      write_pid(Shoryuken.options)\n\n      loader.load\n\n      initialize_concurrent_logger\n\n      @launcher = Shoryuken::Launcher.new\n\n      begin\n        @launcher.start\n\n        while (readable_io = IO.select([self_read]))\n          signal = readable_io.first[0].gets.strip\n          handle_signal(signal)\n        end\n      rescue Interrupt\n        @launcher.stop!\n        exit 0\n      end\n    end\n\n    # Checks if the server is healthy\n    #\n    # @return [Boolean] true if the launcher is running and healthy\n    def healthy?\n      (@launcher && @launcher.healthy?) || false\n    end\n\n    private\n\n    # Initializes the Concurrent Ruby logger\n    #\n    # @return [void]\n    def initialize_concurrent_logger\n      return unless Shoryuken.logger\n\n      Concurrent.global_logger = lambda do |level, progname, msg = nil, &block|\n        Shoryuken.logger.log(level, msg, progname, &block)\n      end\n    end\n\n    # Daemonizes the process\n    #\n    # @param options [Hash] options containing daemon and logfile settings\n    # @option options [Boolean] :daemon whether to daemonize\n    # @option options [String] :logfile path to the log file for daemon output\n    # @return [void]\n    def daemonize(options)\n      return unless options[:daemon]\n\n      files_to_reopen = []\n      ObjectSpace.each_object(File) do |file|\n        files_to_reopen << file unless file.closed?\n      end\n\n      Process.daemon(true, true)\n\n      files_to_reopen.each do |file|\n        file.reopen file.path, 'a+'\n        file.sync = true\n      rescue ::Exception\n      end\n\n      [$stdout, $stderr].each do |io|\n        File.open(options[:logfile], 'ab') do |f|\n          io.reopen(f)\n        end\n        io.sync = true\n      end\n      $stdin.reopen('/dev/null')\n    end\n\n    # Writes the process ID to a file\n    #\n    # @param options [Hash] options containing the pidfile path\n    # @option options [String] :pidfile path to write the PID file\n    # @return [void]\n    def write_pid(options)\n      return unless (path = options[:pidfile])\n\n      File.open(path, 'w') { |f| f.puts(Process.pid) }\n    end\n\n    # Executes a soft shutdown on USR1 signal\n    #\n    # @return [void]\n    def execute_soft_shutdown\n      logger.info { 'Received USR1, will soft shutdown' }\n\n      @launcher.stop\n      exit 0\n    end\n\n    # Executes a terminal stop on TSTP signal\n    #\n    # @return [void]\n    def execute_terminal_stop\n      logger.info { 'Received TSTP, will stop accepting new work' }\n\n      @launcher.stop\n    end\n\n    # Prints backtraces of all threads\n    #\n    # @return [void]\n    def print_threads_backtrace\n      Thread.list.each do |thread|\n        logger.info { \"Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}\" }\n        if thread.backtrace\n          logger.info { thread.backtrace.join(\"\\n\") }\n        else\n          logger.info { '<no backtrace available>' }\n        end\n      end\n    end\n\n    # Handles incoming signals\n    #\n    # @param sig [String] the signal name\n    # @return [void]\n    # @raise [Interrupt] on TERM or INT signals\n    def handle_signal(sig)\n      logger.debug \"Got #{sig} signal\"\n\n      case sig\n      when 'USR1' then execute_soft_shutdown\n      when 'TTIN' then print_threads_backtrace\n      when 'TSTP' then execute_terminal_stop\n      when 'TERM', 'INT'\n        logger.info { \"Received #{sig}, will shutdown\" }\n\n        raise Interrupt\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "print_threads_backtrace", "signature": "def print_threads_backtrace Thread.list.each do |thread|", "start_line": 148, "end_line": 157}, "metadata": {"module": "Shoryuken", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 377}
{"function_name": "handle_signal", "file_path": "shoryuken/lib/shoryuken/runner.rb", "focal_code": "def handle_signal(sig)\n      logger.debug \"Got #{sig} signal\"\n\n      case sig\n      when 'USR1' then execute_soft_shutdown\n      when 'TTIN' then print_threads_backtrace\n      when 'TSTP' then execute_terminal_stop\n      when 'TERM', 'INT'\n        logger.info { \"Received #{sig}, will shutdown\" }\n\n        raise Interrupt\n      end\n    end", "file_content": "# frozen_string_literal: true\n\n$stdout.sync = true\n\nrequire 'singleton'\nrequire 'optparse'\nrequire 'erb'\n\nrequire 'shoryuken'\n\nmodule Shoryuken\n  # Runs the Shoryuken server process.\n  # Handles signal trapping, daemonization, and lifecycle management.\n  class Runner\n    include Util\n    include Singleton\n\n    # @return [Shoryuken::Launcher, nil] the launcher instance, or nil if not yet initialized\n    attr_reader :launcher\n\n    # Runs the Shoryuken server with the given options\n    #\n    # @param options [Hash] runtime configuration options\n    # @option options [Boolean] :daemon whether to daemonize the process\n    # @option options [String] :pidfile path to the PID file\n    # @option options [String] :logfile path to the log file\n    # @option options [String] :config_file path to the configuration file\n    # @return [void]\n    def run(options)\n      self_read, self_write = IO.pipe\n\n      %w[INT TERM USR1 TSTP TTIN].each do |sig|\n        trap sig do\n          self_write.puts(sig)\n        end\n      rescue ArgumentError\n        puts \"Signal #{sig} not supported\"\n      end\n\n      loader = EnvironmentLoader.setup_options(options)\n\n      daemonize(Shoryuken.options)\n      write_pid(Shoryuken.options)\n\n      loader.load\n\n      initialize_concurrent_logger\n\n      @launcher = Shoryuken::Launcher.new\n\n      begin\n        @launcher.start\n\n        while (readable_io = IO.select([self_read]))\n          signal = readable_io.first[0].gets.strip\n          handle_signal(signal)\n        end\n      rescue Interrupt\n        @launcher.stop!\n        exit 0\n      end\n    end\n\n    # Checks if the server is healthy\n    #\n    # @return [Boolean] true if the launcher is running and healthy\n    def healthy?\n      (@launcher && @launcher.healthy?) || false\n    end\n\n    private\n\n    # Initializes the Concurrent Ruby logger\n    #\n    # @return [void]\n    def initialize_concurrent_logger\n      return unless Shoryuken.logger\n\n      Concurrent.global_logger = lambda do |level, progname, msg = nil, &block|\n        Shoryuken.logger.log(level, msg, progname, &block)\n      end\n    end\n\n    # Daemonizes the process\n    #\n    # @param options [Hash] options containing daemon and logfile settings\n    # @option options [Boolean] :daemon whether to daemonize\n    # @option options [String] :logfile path to the log file for daemon output\n    # @return [void]\n    def daemonize(options)\n      return unless options[:daemon]\n\n      files_to_reopen = []\n      ObjectSpace.each_object(File) do |file|\n        files_to_reopen << file unless file.closed?\n      end\n\n      Process.daemon(true, true)\n\n      files_to_reopen.each do |file|\n        file.reopen file.path, 'a+'\n        file.sync = true\n      rescue ::Exception\n      end\n\n      [$stdout, $stderr].each do |io|\n        File.open(options[:logfile], 'ab') do |f|\n          io.reopen(f)\n        end\n        io.sync = true\n      end\n      $stdin.reopen('/dev/null')\n    end\n\n    # Writes the process ID to a file\n    #\n    # @param options [Hash] options containing the pidfile path\n    # @option options [String] :pidfile path to write the PID file\n    # @return [void]\n    def write_pid(options)\n      return unless (path = options[:pidfile])\n\n      File.open(path, 'w') { |f| f.puts(Process.pid) }\n    end\n\n    # Executes a soft shutdown on USR1 signal\n    #\n    # @return [void]\n    def execute_soft_shutdown\n      logger.info { 'Received USR1, will soft shutdown' }\n\n      @launcher.stop\n      exit 0\n    end\n\n    # Executes a terminal stop on TSTP signal\n    #\n    # @return [void]\n    def execute_terminal_stop\n      logger.info { 'Received TSTP, will stop accepting new work' }\n\n      @launcher.stop\n    end\n\n    # Prints backtraces of all threads\n    #\n    # @return [void]\n    def print_threads_backtrace\n      Thread.list.each do |thread|\n        logger.info { \"Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}\" }\n        if thread.backtrace\n          logger.info { thread.backtrace.join(\"\\n\") }\n        else\n          logger.info { '<no backtrace available>' }\n        end\n      end\n    end\n\n    # Handles incoming signals\n    #\n    # @param sig [String] the signal name\n    # @return [void]\n    # @raise [Interrupt] on TERM or INT signals\n    def handle_signal(sig)\n      logger.debug \"Got #{sig} signal\"\n\n      case sig\n      when 'USR1' then execute_soft_shutdown\n      when 'TTIN' then print_threads_backtrace\n      when 'TSTP' then execute_terminal_stop\n      when 'TERM', 'INT'\n        logger.info { \"Received #{sig}, will shutdown\" }\n\n        raise Interrupt\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "handle_signal", "signature": "def handle_signal(sig)", "start_line": 164, "end_line": 176}, "metadata": {"module": "Shoryuken", "class_name": "Runner", "class_signature": "class Runner"}, "task_id": 378}
{"function_name": "==", "file_path": "shoryuken/lib/shoryuken/polling/queue_configuration.rb", "focal_code": "def ==(other)\n        case other\n        when String\n          if options.empty?\n            name == other\n          else\n            false\n          end\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Polling\n    # Configuration object representing a queue and its associated options.\n    #\n    # This class encapsulates a queue name along with any polling-specific\n    # options or metadata. It provides a structured way to pass queue\n    # information between polling strategies and the message fetching system.\n    #\n    # The class extends Struct to provide attribute accessors for name and options\n    # while adding custom behavior for equality comparison and string representation.\n    #\n    # @example Creating a basic queue configuration\n    #   config = QueueConfiguration.new('my_queue', {})\n    #   config.name     # => 'my_queue'\n    #   config.options  # => {}\n    #\n    # @example Creating a queue configuration with options\n    #   config = QueueConfiguration.new('priority_queue', { priority: :high })\n    #   config.name     # => 'priority_queue'\n    #   config.options  # => { priority: :high }\n    #\n    # @example Comparing configurations\n    #   config1 = QueueConfiguration.new('queue', {})\n    #   config2 = QueueConfiguration.new('queue', {})\n    #   config1 == config2  # => true\n    #   config1 == 'queue'  # => true (when options are empty)\n    #\n    # @attr_reader [String] name The name of the queue\n    # @attr_reader [Hash] options Additional options or metadata for the queue\n    QueueConfiguration = Struct.new(:name, :options) do\n      # Generates a hash value based on the queue name.\n      #\n      # This method ensures that QueueConfiguration objects can be used\n      # as hash keys and that configurations with the same queue name\n      # will have the same hash value regardless of their options.\n      #\n      # @return [Integer] Hash value based on the queue name\n      def hash\n        name.hash\n      end\n\n      # Compares this configuration with another object for equality.\n      #\n      # Two QueueConfiguration objects are equal if they have the same name\n      # and options. For convenience, a configuration with empty options can\n      # also be compared directly with a string queue name.\n      #\n      # @param other [Object] The object to compare with\n      # @return [Boolean] true if the objects are considered equal\n      #\n      # @example Comparing with another QueueConfiguration\n      #   config1 = QueueConfiguration.new('queue', {})\n      #   config2 = QueueConfiguration.new('queue', {})\n      #   config1 == config2  # => true\n      #\n      # @example Comparing with a string (only when options are empty)\n      #   config = QueueConfiguration.new('queue', {})\n      #   config == 'queue'  # => true\n      #\n      #   config_with_options = QueueConfiguration.new('queue', { weight: 5 })\n      #   config_with_options == 'queue'  # => false\n      def ==(other)\n        case other\n        when String\n          if options.empty?\n            name == other\n          else\n            false\n          end\n        else\n          super\n        end\n      end\n\n      alias_method :eql?, :==\n\n      # Returns a string representation of the queue configuration.\n      #\n      # For configurations with empty options, returns just the queue name.\n      # For configurations with options, returns a detailed representation\n      # showing both the name and the options hash.\n      #\n      # @return [String] String representation of the configuration\n      #\n      # @example Simple queue without options\n      #   config = QueueConfiguration.new('simple_queue', {})\n      #   config.to_s  # => 'simple_queue'\n      #\n      # @example Queue with options\n      #   config = QueueConfiguration.new('complex_queue', { priority: :high })\n      #   config.to_s  # => '#<QueueConfiguration complex_queue options={:priority=>:high}>'\n      def to_s\n        if options&.empty?\n          name\n        else\n          \"#<QueueConfiguration #{name} options=#{options.inspect}>\"\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "==", "signature": "def", "start_line": 64, "end_line": 75}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 379}
{"function_name": "==", "file_path": "shoryuken/lib/shoryuken/polling/base_strategy.rb", "focal_code": "def ==(other)\n        case other\n        when Array\n          @queues == other\n        else\n          if other.respond_to?(:active_queues)\n            active_queues == other.active_queues\n          else\n            false\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Polling strategies for determining which queue to fetch messages from next\n  module Polling\n    # Abstract base class for queue polling strategies.\n    #\n    # This class defines the interface that all polling strategies must implement\n    # to manage queue selection and message flow control in Shoryuken workers.\n    # Polling strategies determine which queue to fetch messages from next and\n    # how to handle scenarios where queues have no messages available.\n    #\n    # @abstract Subclass and override {#next_queue}, {#messages_found}, and {#active_queues}\n    #   to implement a custom polling strategy.\n    #\n    # @example Implementing a custom polling strategy\n    #   class CustomStrategy < BaseStrategy\n    #     def initialize(queues)\n    #       @queues = queues\n    #     end\n    #\n    #     def next_queue\n    #       # Return next queue to poll\n    #       @queues.sample\n    #     end\n    #\n    #     def messages_found(queue, count)\n    #       # Handle result of polling\n    #       logger.info \"Found #{count} messages in #{queue}\"\n    #     end\n    #\n    #     def active_queues\n    #       # Return list of active queues\n    #       @queues\n    #     end\n    #   end\n    #\n    # @see WeightedRoundRobin\n    # @see StrictPriority\n    class BaseStrategy\n      include Util\n\n      # Returns the next queue to poll for messages.\n      #\n      # This method should return a QueueConfiguration object representing\n      # the next queue that should be polled for messages, or nil if no\n      # queues are currently available for polling.\n      #\n      # @abstract Subclasses must implement this method\n      # @return [QueueConfiguration, nil] Next queue to poll, or nil if none available\n      # @raise [NotImplementedError] if not implemented by subclass\n      def next_queue\n        fail NotImplementedError\n      end\n\n      # Called when messages are found (or not found) in a queue.\n      #\n      # This method is invoked after polling a queue to inform the strategy\n      # about the number of messages that were retrieved. Strategies can use\n      # this information to make decisions about future polling behavior,\n      # such as pausing empty queues or adjusting queue weights.\n      #\n      # @abstract Subclasses must implement this method\n      # @param _queue [String] The name of the queue that was polled\n      # @param _messages_found [Integer] The number of messages retrieved\n      # @raise [NotImplementedError] if not implemented by subclass\n      def messages_found(_queue, _messages_found)\n        fail NotImplementedError\n      end\n\n      # Called when a message from a queue has been processed.\n      #\n      # This optional callback is invoked after a message has been successfully\n      # processed by a worker. Strategies can use this information for cleanup\n      # or to adjust their polling behavior.\n      #\n      # @param _queue [String] The name of the queue whose message was processed\n      # @return [void]\n      def message_processed(_queue); end\n\n      # Returns the list of currently active queues.\n      #\n      # This method should return an array representing the queues that are\n      # currently active and available for polling. The format may vary by\n      # strategy implementation.\n      #\n      # @abstract Subclasses must implement this method\n      # @return [Array] List of active queues\n      # @raise [NotImplementedError] if not implemented by subclass\n      def active_queues\n        fail NotImplementedError\n      end\n\n      # Compares this strategy with another object for equality.\n      #\n      # Two strategies are considered equal if they have the same active queues.\n      # This method also supports comparison with Array objects for backward\n      # compatibility.\n      #\n      # @param other [Object] Object to compare with\n      # @return [Boolean] true if strategies are equivalent\n      def ==(other)\n        case other\n        when Array\n          @queues == other\n        else\n          if other.respond_to?(:active_queues)\n            active_queues == other.active_queues\n          else\n            false\n          end\n        end\n      end\n\n      # Returns the delay time for pausing empty queues.\n      #\n      # This method returns the amount of time (in seconds) that empty queues\n      # should be paused before being polled again. The delay can be set at\n      # the strategy level or falls back to the global Shoryuken delay setting.\n      #\n      # @return [Float] Delay time in seconds\n      def delay\n        @delay || Shoryuken.options[:delay].to_f\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "==", "signature": "def", "start_line": 102, "end_line": 113}, "metadata": {"module": "Shoryuken", "class_name": "BaseStrategy", "class_signature": "class BaseStrategy"}, "task_id": 380}
{"function_name": "messages_found", "file_path": "shoryuken/lib/shoryuken/polling/weighted_round_robin.rb", "focal_code": "def messages_found(queue, messages_found)\n        if messages_found == 0\n          pause(queue)\n          return\n        end\n\n        maximum_weight = maximum_queue_weight(queue)\n        current_weight = current_queue_weight(queue)\n        if maximum_weight > current_weight\n          logger.info { \"Increasing #{queue} weight to #{current_weight + 1}, max: #{maximum_weight}\" }\n          @queues << queue\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Polling\n    # A polling strategy that processes queues in weighted round-robin order.\n    # Queue weights determine how often each queue is polled relative to others.\n    # Queues are temporarily paused when no messages are found.\n    class WeightedRoundRobin < BaseStrategy\n      # Initializes a new WeightedRoundRobin polling strategy\n      #\n      # @param queues [Array<String>] array of queue names, with weights indicated by repetition\n      # @param delay [Float, nil] delay in seconds before unpausing empty queues\n      def initialize(queues, delay = nil)\n        @initial_queues = queues\n        @queues = queues.dup.uniq\n        @paused_queues = []\n        @delay = delay\n      end\n\n      # Returns the next queue to poll in round-robin order\n      #\n      # @return [QueueConfiguration, nil] the next queue configuration or nil if all paused\n      def next_queue\n        unpause_queues\n        queue = @queues.shift\n        return nil if queue.nil?\n\n        @queues << queue\n        QueueConfiguration.new(queue, {})\n      end\n\n      # Handles the result of polling a queue, adjusting weight if messages were found\n      #\n      # @param queue [String] the queue name\n      # @param messages_found [Integer] number of messages found\n      # @return [void]\n      def messages_found(queue, messages_found)\n        if messages_found == 0\n          pause(queue)\n          return\n        end\n\n        maximum_weight = maximum_queue_weight(queue)\n        current_weight = current_queue_weight(queue)\n        if maximum_weight > current_weight\n          logger.info { \"Increasing #{queue} weight to #{current_weight + 1}, max: #{maximum_weight}\" }\n          @queues << queue\n        end\n      end\n\n      # Returns the list of active queues with their current weights\n      #\n      # @return [Array<Array>] array of [queue_name, weight] pairs\n      def active_queues\n        unparse_queues(@queues)\n      end\n\n      # Called when a message from a queue has been processed\n      #\n      # @param queue [String] the queue name\n      # @return [void]\n      def message_processed(queue)\n        paused_queue = @paused_queues.find { |_time, name| name == queue }\n        return unless paused_queue\n\n        paused_queue[0] = Time.at 0\n      end\n\n      private\n\n      # Pauses a queue by removing it from active rotation\n      #\n      # @param queue [String] the queue name to pause\n      # @return [void]\n      def pause(queue)\n        return unless @queues.delete(queue)\n\n        @paused_queues << [Time.now + delay, queue]\n        logger.debug \"Paused #{queue}\"\n      end\n\n      # Unpauses queues whose delay has expired\n      #\n      # @return [void]\n      def unpause_queues\n        return if @paused_queues.empty?\n        return if Time.now < @paused_queues.first[0]\n\n        pause = @paused_queues.shift\n        @queues << pause[1]\n        logger.debug \"Unpaused #{pause[1]}\"\n      end\n\n      # Returns the current weight of a queue in the active rotation\n      #\n      # @param queue [String] the queue name\n      # @return [Integer] the current weight\n      def current_queue_weight(queue)\n        queue_weight(@queues, queue)\n      end\n\n      # Returns the maximum configured weight of a queue\n      #\n      # @param queue [String] the queue name\n      # @return [Integer] the maximum weight\n      def maximum_queue_weight(queue)\n        queue_weight(@initial_queues, queue)\n      end\n\n      # Counts how many times a queue appears in the given array\n      #\n      # @param queues [Array<String>] the array to count in\n      # @param queue [String] the queue name to count\n      # @return [Integer] the count\n      def queue_weight(queues, queue)\n        queues.count { |q| q == queue }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "messages_found", "signature": "def messages_found(queue, messages_found)", "start_line": 37, "end_line": 49}, "metadata": {"module": "Shoryuken", "class_name": "WeightedRoundRobin", "class_signature": "class WeightedRoundRobin < < BaseStrategy"}, "task_id": 381}
{"function_name": "initialize", "file_path": "shoryuken/lib/shoryuken/polling/strict_priority.rb", "focal_code": "def initialize(queues, delay = nil)\n        # Priority ordering of the queues, highest priority first\n        @queues = queues\n                  .group_by { |q| q }\n                  .sort_by { |_, qs| -qs.count }\n                  .map(&:first)\n\n        # Pause status of the queues, default to past time (unpaused)\n        @paused_until = queues\n                        .each_with_object({}) { |queue, h| h[queue] = Time.at(0) }\n\n        @delay = delay\n        # Start queues at 0\n        reset_next_queue\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Polling\n    # A polling strategy that processes queues in strict priority order.\n    # Higher priority queues are always processed before lower priority queues.\n    # Queues are temporarily paused when no messages are found.\n    class StrictPriority < BaseStrategy\n      # Initializes a new StrictPriority polling strategy\n      #\n      # @param queues [Array<String>] array of queue names, with higher priority queues appearing more frequently\n      # @param delay [Float, nil] delay in seconds before unpausing empty queues\n      def initialize(queues, delay = nil)\n        # Priority ordering of the queues, highest priority first\n        @queues = queues\n                  .group_by { |q| q }\n                  .sort_by { |_, qs| -qs.count }\n                  .map(&:first)\n\n        # Pause status of the queues, default to past time (unpaused)\n        @paused_until = queues\n                        .each_with_object({}) { |queue, h| h[queue] = Time.at(0) }\n\n        @delay = delay\n        # Start queues at 0\n        reset_next_queue\n      end\n\n      # Returns the next queue to poll based on strict priority\n      #\n      # @return [QueueConfiguration, nil] the next queue configuration or nil if all paused\n      def next_queue\n        next_queue = next_active_queue\n        next_queue.nil? ? nil : QueueConfiguration.new(next_queue, {})\n      end\n\n      # Handles the result of polling a queue\n      #\n      # @param queue [String] the queue name\n      # @param messages_found [Integer] number of messages found\n      # @return [void]\n      def messages_found(queue, messages_found)\n        if messages_found == 0\n          pause(queue)\n        else\n          reset_next_queue\n        end\n      end\n\n      # Returns the list of active (non-paused) queues with their priorities\n      #\n      # @return [Array<Array>] array of [queue_name, priority] pairs\n      def active_queues\n        @queues\n          .reverse\n          .map.with_index(1)\n          .reject { |q, _| queue_paused?(q) }\n          .reverse\n      end\n\n      # Called when a message from a queue has been processed\n      #\n      # @param queue [String] the queue name\n      # @return [void]\n      def message_processed(queue)\n        if queue_paused?(queue)\n          logger.debug \"Unpausing #{queue}\"\n          @paused_until[queue] = Time.at 0\n        end\n      end\n\n      private\n\n      # Finds the next active (non-paused) queue\n      #\n      # @return [String, nil] the queue name or nil if all paused\n      def next_active_queue\n        reset_next_queue if queues_unpaused_since?\n\n        size = @queues.length\n        size.times do\n          queue = @queues[@next_queue_index]\n          @next_queue_index = (@next_queue_index + 1) % size\n          return queue unless queue_paused?(queue)\n        end\n\n        nil\n      end\n\n      # Checks if any queues have been unpaused since last check\n      #\n      # @return [Boolean] true if queues were unpaused\n      def queues_unpaused_since?\n        last = @last_unpause_check\n        now = @last_unpause_check = Time.now\n\n        last && @paused_until.values.any? { |t| t > last && t <= now }\n      end\n\n      # Resets the next queue index to start from the highest priority\n      #\n      # @return [void]\n      def reset_next_queue\n        @next_queue_index = 0\n      end\n\n      # Checks if a queue is currently paused\n      #\n      # @param queue [String] the queue name\n      # @return [Boolean] true if the queue is paused\n      def queue_paused?(queue)\n        @paused_until[queue] > Time.now\n      end\n\n      # Pauses a queue for the configured delay time\n      #\n      # @param queue [String] the queue name to pause\n      # @return [void]\n      def pause(queue)\n        return unless delay > 0\n\n        @paused_until[queue] = Time.now + delay\n        logger.debug \"Paused #{queue}\"\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(queues, delay = nil)", "start_line": 13, "end_line": 27}, "metadata": {"module": "Shoryuken", "class_name": "StrictPriority", "class_signature": "class StrictPriority < < BaseStrategy"}, "task_id": 382}
{"function_name": "next_active_queue", "file_path": "shoryuken/lib/shoryuken/polling/strict_priority.rb", "focal_code": "def next_active_queue\n        reset_next_queue if queues_unpaused_since?\n\n        size = @queues.length\n        size.times do\n          queue = @queues[@next_queue_index]\n          @next_queue_index = (@next_queue_index + 1) % size\n          return queue unless queue_paused?(queue)\n        end\n\n        nil\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Polling\n    # A polling strategy that processes queues in strict priority order.\n    # Higher priority queues are always processed before lower priority queues.\n    # Queues are temporarily paused when no messages are found.\n    class StrictPriority < BaseStrategy\n      # Initializes a new StrictPriority polling strategy\n      #\n      # @param queues [Array<String>] array of queue names, with higher priority queues appearing more frequently\n      # @param delay [Float, nil] delay in seconds before unpausing empty queues\n      def initialize(queues, delay = nil)\n        # Priority ordering of the queues, highest priority first\n        @queues = queues\n                  .group_by { |q| q }\n                  .sort_by { |_, qs| -qs.count }\n                  .map(&:first)\n\n        # Pause status of the queues, default to past time (unpaused)\n        @paused_until = queues\n                        .each_with_object({}) { |queue, h| h[queue] = Time.at(0) }\n\n        @delay = delay\n        # Start queues at 0\n        reset_next_queue\n      end\n\n      # Returns the next queue to poll based on strict priority\n      #\n      # @return [QueueConfiguration, nil] the next queue configuration or nil if all paused\n      def next_queue\n        next_queue = next_active_queue\n        next_queue.nil? ? nil : QueueConfiguration.new(next_queue, {})\n      end\n\n      # Handles the result of polling a queue\n      #\n      # @param queue [String] the queue name\n      # @param messages_found [Integer] number of messages found\n      # @return [void]\n      def messages_found(queue, messages_found)\n        if messages_found == 0\n          pause(queue)\n        else\n          reset_next_queue\n        end\n      end\n\n      # Returns the list of active (non-paused) queues with their priorities\n      #\n      # @return [Array<Array>] array of [queue_name, priority] pairs\n      def active_queues\n        @queues\n          .reverse\n          .map.with_index(1)\n          .reject { |q, _| queue_paused?(q) }\n          .reverse\n      end\n\n      # Called when a message from a queue has been processed\n      #\n      # @param queue [String] the queue name\n      # @return [void]\n      def message_processed(queue)\n        if queue_paused?(queue)\n          logger.debug \"Unpausing #{queue}\"\n          @paused_until[queue] = Time.at 0\n        end\n      end\n\n      private\n\n      # Finds the next active (non-paused) queue\n      #\n      # @return [String, nil] the queue name or nil if all paused\n      def next_active_queue\n        reset_next_queue if queues_unpaused_since?\n\n        size = @queues.length\n        size.times do\n          queue = @queues[@next_queue_index]\n          @next_queue_index = (@next_queue_index + 1) % size\n          return queue unless queue_paused?(queue)\n        end\n\n        nil\n      end\n\n      # Checks if any queues have been unpaused since last check\n      #\n      # @return [Boolean] true if queues were unpaused\n      def queues_unpaused_since?\n        last = @last_unpause_check\n        now = @last_unpause_check = Time.now\n\n        last && @paused_until.values.any? { |t| t > last && t <= now }\n      end\n\n      # Resets the next queue index to start from the highest priority\n      #\n      # @return [void]\n      def reset_next_queue\n        @next_queue_index = 0\n      end\n\n      # Checks if a queue is currently paused\n      #\n      # @param queue [String] the queue name\n      # @return [Boolean] true if the queue is paused\n      def queue_paused?(queue)\n        @paused_until[queue] > Time.now\n      end\n\n      # Pauses a queue for the configured delay time\n      #\n      # @param queue [String] the queue name to pause\n      # @return [void]\n      def pause(queue)\n        return unless delay > 0\n\n        @paused_until[queue] = Time.now + delay\n        logger.debug \"Paused #{queue}\"\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "next_active_queue", "signature": "def next_active_queue reset_next_queue if queues_unpaused_since?", "start_line": 77, "end_line": 88}, "metadata": {"module": "Shoryuken", "class_name": "StrictPriority", "class_signature": "class StrictPriority < < BaseStrategy"}, "task_id": 383}
{"function_name": "perform_async", "file_path": "shoryuken/lib/shoryuken/worker/default_executor.rb", "focal_code": "def perform_async(worker_class, body, options = {})\n          options[:message_attributes] ||= {}\n          options[:message_attributes]['shoryuken_class'] = {\n            string_value: worker_class.to_s,\n            data_type: 'String'\n          }\n\n          options[:message_body] = body\n\n          queue = options.delete(:queue) || worker_class.get_shoryuken_options['queue']\n\n          Shoryuken::Client.queues(queue).send_message(options)\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Worker\n    # Default executor that sends messages to SQS for asynchronous processing.\n    # This is the standard executor used in production environments.\n    class DefaultExecutor\n      class << self\n        # Enqueues a job for asynchronous processing via SQS\n        #\n        # @param worker_class [Class] the worker class that will process the message\n        # @param body [Object] the message body\n        # @param options [Hash] additional SQS message options\n        # @option options [Hash] :message_attributes custom message attributes\n        # @option options [String] :queue override the default queue\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def perform_async(worker_class, body, options = {})\n          options[:message_attributes] ||= {}\n          options[:message_attributes]['shoryuken_class'] = {\n            string_value: worker_class.to_s,\n            data_type: 'String'\n          }\n\n          options[:message_body] = body\n\n          queue = options.delete(:queue) || worker_class.get_shoryuken_options['queue']\n\n          Shoryuken::Client.queues(queue).send_message(options)\n        end\n\n        # Enqueues a job for delayed processing via SQS\n        #\n        # @param worker_class [Class] the worker class that will process the message\n        # @param interval [Integer, Float] delay in seconds or timestamp\n        # @param body [Object] the message body\n        # @param options [Hash] SQS message options for the delayed job\n        # @option options [Hash] :message_attributes custom message attributes\n        # @option options [String] :queue override the default queue\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        # @raise [Errors::InvalidDelayError] if delay exceeds 15 minutes\n        def perform_in(worker_class, interval, body, options = {})\n          interval = interval.to_f\n          now = Time.now.to_f\n          ts = (interval < 1_000_000_000 ? (now + interval).to_f : interval)\n\n          delay = (ts - now).ceil\n\n          raise Errors::InvalidDelayError, 'The maximum allowed delay is 15 minutes' if delay > 15 * 60\n\n          worker_class.perform_async(body, options.merge(delay_seconds: delay))\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "perform_async", "signature": "def perform_async(worker_class, body, options = {})", "start_line": 17, "end_line": 29}, "metadata": {"module": "Shoryuken", "class_name": "DefaultExecutor", "class_signature": "class DefaultExecutor"}, "task_id": 384}
{"function_name": "perform_async", "file_path": "shoryuken/lib/shoryuken/worker/inline_executor.rb", "focal_code": "def perform_async(worker_class, body, options = {})\n          body = JSON.dump(body) if body.is_a?(Hash)\n          queue_name = options.delete(:queue) || worker_class.get_shoryuken_options['queue']\n          message_attributes = options.delete(:message_attributes) || {}\n          message_attributes['shoryuken_class'] = {\n            string_value: worker_class.to_s,\n            data_type: 'String'\n          }\n\n          sqs_msg = InlineMessage.new(\n            body: body,\n            attributes: nil,\n            md5_of_body: nil,\n            md5_of_message_attributes: nil,\n            message_attributes: message_attributes,\n            message_id: nil,\n            receipt_handle: nil,\n            delete: nil,\n            queue_name: queue_name\n          )\n\n          call(worker_class, sqs_msg)\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Worker\n    # Executor that processes jobs synchronously in the current thread.\n    # Useful for testing and development environments.\n    class InlineExecutor\n      class << self\n        # Processes a job synchronously in the current thread\n        #\n        # @param worker_class [Class] the worker class that will process the message\n        # @param body [Object] the message body\n        # @param options [Hash] inline execution options\n        # @option options [String] :queue override the default queue name\n        # @option options [Hash] :message_attributes custom message attributes\n        # @return [Object] the result of the worker's perform method\n        def perform_async(worker_class, body, options = {})\n          body = JSON.dump(body) if body.is_a?(Hash)\n          queue_name = options.delete(:queue) || worker_class.get_shoryuken_options['queue']\n          message_attributes = options.delete(:message_attributes) || {}\n          message_attributes['shoryuken_class'] = {\n            string_value: worker_class.to_s,\n            data_type: 'String'\n          }\n\n          sqs_msg = InlineMessage.new(\n            body: body,\n            attributes: nil,\n            md5_of_body: nil,\n            md5_of_message_attributes: nil,\n            message_attributes: message_attributes,\n            message_id: nil,\n            receipt_handle: nil,\n            delete: nil,\n            queue_name: queue_name\n          )\n\n          call(worker_class, sqs_msg)\n        end\n\n        # Processes a job synchronously, ignoring the delay interval\n        #\n        # @param worker_class [Class] the worker class that will process the message\n        # @param _interval [Integer, Float] ignored for inline execution\n        # @param body [Object] the message body\n        # @param options [Hash] inline execution options\n        # @option options [String] :queue override the default queue name\n        # @option options [Hash] :message_attributes custom message attributes\n        # @return [Object] the result of the worker's perform method\n        def perform_in(worker_class, _interval, body, options = {})\n          worker_class.perform_async(body, options)\n        end\n\n        private\n\n        # Instantiates and calls the worker\n        #\n        # @param worker_class [Class] the worker class\n        # @param sqs_msg [Shoryuken::InlineMessage] the message\n        # @return [Object] the result of the worker's perform method\n        def call(worker_class, sqs_msg)\n          parsed_body = BodyParser.parse(worker_class, sqs_msg)\n          batch = worker_class.shoryuken_options_hash['batch']\n          args = batch ? [[sqs_msg], [parsed_body]] : [sqs_msg, parsed_body]\n          worker_class.new.perform(*args)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "perform_async", "signature": "def perform_async(worker_class, body, options = {})", "start_line": 17, "end_line": 39}, "metadata": {"module": "Shoryuken", "class_name": "InlineExecutor", "class_signature": "class InlineExecutor"}, "task_id": 385}
{"function_name": "invoke", "file_path": "shoryuken/lib/shoryuken/middleware/chain.rb", "focal_code": "def invoke(*args, &final_action)\n        chain = retrieve.dup\n        traverse_chain = lambda do\n          if chain.empty?\n            final_action.call\n          else\n            chain.shift.call(*args, &traverse_chain)\n          end\n        end\n        traverse_chain.call\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  # Middleware provides a way to wrap message processing with custom logic,\n  # similar to Rack middleware in web applications. Middleware runs on the server\n  # side and can perform setup, teardown, error handling, and monitoring around\n  # job execution.\n  #\n  # Middleware classes must implement a `call` method that accepts the worker instance,\n  # queue name, and SQS message, and must yield to continue the middleware chain.\n  #\n  # ## Global Middleware Configuration\n  #\n  # Configure middleware globally for all workers:\n  #\n  #   Shoryuken.configure_server do |config|\n  #     config.server_middleware do |chain|\n  #       chain.add MyServerHook\n  #       chain.remove Shoryuken::Middleware::Server::ActiveRecord\n  #     end\n  #   end\n  #\n  # ## Per-Worker Middleware Configuration\n  #\n  # Configure middleware for specific workers:\n  #\n  #   class MyWorker\n  #     include Shoryuken::Worker\n  #\n  #     server_middleware do |chain|\n  #       chain.add MyWorkerSpecificMiddleware\n  #     end\n  #   end\n  #\n  # ## Middleware Ordering\n  #\n  # Insert middleware at specific positions in the chain:\n  #\n  #   # Insert before existing middleware\n  #   chain.insert_before Shoryuken::Middleware::Server::ActiveRecord, MyDatabaseSetup\n  #\n  #   # Insert after existing middleware\n  #   chain.insert_after Shoryuken::Middleware::Server::Timing, MyMetricsCollector\n  #\n  #   # Add to beginning of chain\n  #   chain.prepend MyFirstMiddleware\n  #\n  # ## Example Middleware Implementations\n  #\n  #   # Basic logging middleware\n  #   class LoggingMiddleware\n  #     def call(worker_instance, queue, sqs_msg, body)\n  #       puts \"Processing #{sqs_msg.message_id} on #{queue}\"\n  #       start_time = Time.now\n  #       yield\n  #       puts \"Completed in #{Time.now - start_time}s\"\n  #     end\n  #   end\n  #\n  #   # Error reporting middleware\n  #   class ErrorReportingMiddleware\n  #     def call(worker_instance, queue, sqs_msg, body)\n  #       yield\n  #     rescue => error\n  #       ErrorReporter.notify(error, {\n  #         worker: worker_instance.class.name,\n  #         queue: queue,\n  #         message_id: sqs_msg.message_id\n  #       })\n  #       raise\n  #     end\n  #   end\n  #\n  #   # Performance monitoring middleware\n  #   class MetricsMiddleware\n  #     def call(worker_instance, queue, sqs_msg, body)\n  #       start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)\n  #       yield\n  #       duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time\n  #       StatsD.timing(\"shoryuken.#{worker_instance.class.name.underscore}.duration\", duration)\n  #     end\n  #   end\n  #\n  # @see Shoryuken::Middleware::Chain Middleware chain management\n  # @see https://github.com/ruby-shoryuken/shoryuken/wiki/Middleware Comprehensive middleware guide\n  module Middleware\n    # Manages a chain of middleware classes that will be instantiated and invoked\n    # in sequence around message processing. Provides methods for adding, removing,\n    # and reordering middleware.\n    class Chain\n      # @return [Array<Entry>] The ordered list of middleware entries\n      attr_reader :entries\n\n      # Creates a new middleware chain.\n      #\n      # @yield [Chain] The chain instance for configuration\n      # @example Creating and configuring a chain\n      #   chain = Shoryuken::Middleware::Chain.new do |c|\n      #     c.add MyMiddleware\n      #     c.add AnotherMiddleware, option: 'value'\n      #   end\n      def initialize\n        @entries = []\n        yield self if block_given?\n      end\n\n      # Creates a copy of this middleware chain.\n      #\n      # @return [Chain] A new chain with the same middleware entries\n      def dup\n        self.class.new.tap { |new_chain| new_chain.entries.replace(entries) }\n      end\n\n      # Removes all instances of the specified middleware class from the chain.\n      #\n      # @param klass [Class] The middleware class to remove\n      # @return [Array<Entry>] The removed entries\n      # @example Removing ActiveRecord middleware\n      #   chain.remove Shoryuken::Middleware::Server::ActiveRecord\n      def remove(klass)\n        entries.delete_if { |entry| entry.klass == klass }\n      end\n\n      # Adds middleware to the end of the chain. Does nothing if the middleware\n      # class is already present in the chain.\n      #\n      # @param klass [Class] The middleware class to add\n      # @param args [Array] Arguments to pass to the middleware constructor\n      # @example Adding middleware with arguments\n      #   chain.add MyMiddleware, timeout: 30, retries: 3\n      def add(klass, *args)\n        entries << Entry.new(klass, *args) unless exists?(klass)\n      end\n\n      # Adds middleware to the beginning of the chain. Does nothing if the middleware\n      # class is already present in the chain.\n      #\n      # @param klass [Class] The middleware class to prepend\n      # @param args [Array] Arguments to pass to the middleware constructor\n      # @example Adding middleware to run first\n      #   chain.prepend AuthenticationMiddleware\n      def prepend(klass, *args)\n        entries.insert(0, Entry.new(klass, *args)) unless exists?(klass)\n      end\n\n      # Inserts middleware immediately before another middleware class.\n      # If the new middleware already exists, it's moved to the new position.\n      #\n      # @param oldklass [Class] The existing middleware to insert before\n      # @param newklass [Class] The middleware class to insert\n      # @param args [Array] Arguments to pass to the middleware constructor\n      # @example Insert database setup before ActiveRecord middleware\n      #   chain.insert_before Shoryuken::Middleware::Server::ActiveRecord, DatabaseSetup\n      def insert_before(oldklass, newklass, *args)\n        i = entries.index { |entry| entry.klass == newklass }\n        new_entry = i.nil? ? Entry.new(newklass, *args) : entries.delete_at(i)\n        i = entries.find_index { |entry| entry.klass == oldklass } || 0\n        entries.insert(i, new_entry)\n      end\n\n      # Inserts middleware immediately after another middleware class.\n      # If the new middleware already exists, it's moved to the new position.\n      #\n      # @param oldklass [Class] The existing middleware to insert after\n      # @param newklass [Class] The middleware class to insert\n      # @param args [Array] Arguments to pass to the middleware constructor\n      # @example Insert metrics collection after timing middleware\n      #   chain.insert_after Shoryuken::Middleware::Server::Timing, MetricsCollector\n      def insert_after(oldklass, newklass, *args)\n        i = entries.index { |entry| entry.klass == newklass }\n        new_entry = i.nil? ? Entry.new(newklass, *args) : entries.delete_at(i)\n        i = entries.find_index { |entry| entry.klass == oldklass } || entries.count - 1\n        entries.insert(i + 1, new_entry)\n      end\n\n      # Checks if a middleware class is already in the chain.\n      #\n      # @param klass [Class] The middleware class to check for\n      # @return [Boolean] True if the middleware is in the chain\n      def exists?(klass)\n        entries.any? { |entry| entry.klass == klass }\n      end\n\n      # Creates instances of all middleware classes in the chain.\n      #\n      # @return [Array] Array of middleware instances\n      def retrieve\n        entries.map(&:make_new)\n      end\n\n      # Removes all middleware from the chain.\n      #\n      # @return [Array] Empty array\n      def clear\n        entries.clear\n      end\n\n      # Invokes the middleware chain with the given arguments.\n      # Each middleware's call method will be invoked in sequence,\n      # with control passed through yielding.\n      #\n      # @param args [Array] arguments to pass to each middleware\n      # @param final_action [Proc] the final action to perform after all middleware\n      # @return [void]\n      def invoke(*args, &final_action)\n        chain = retrieve.dup\n        traverse_chain = lambda do\n          if chain.empty?\n            final_action.call\n          else\n            chain.shift.call(*args, &traverse_chain)\n          end\n        end\n        traverse_chain.call\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "invoke", "signature": "def invoke(*args, &final_action)", "start_line": 205, "end_line": 215}, "metadata": {"module": "Shoryuken", "class_name": "Chain", "class_signature": "class Chain"}, "task_id": 386}
{"function_name": "persist", "file_path": "shoryuken/lib/shoryuken/active_job/current_attributes.rb", "focal_code": "def persist(*klasses)\n          @cattrs ||= {}\n\n          klasses.flatten.each_with_index do |klass, idx|\n            key = @cattrs.empty? ? 'cattr' : \"cattr_#{idx}\"\n            @cattrs[key] = klass.to_s\n          end\n\n          # Prepend the persistence module to the adapter for serialization\n          unless ::ActiveJob::QueueAdapters::ShoryukenAdapter.ancestors.include?(Persistence)\n            ::ActiveJob::QueueAdapters::ShoryukenAdapter.prepend(Persistence)\n          end\n\n          # Prepend the loading module to JobWrapper for deserialization\n          unless Shoryuken::ActiveJob::JobWrapper.ancestors.include?(Loading)\n            Shoryuken::ActiveJob::JobWrapper.prepend(Loading)\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'active_support/current_attributes'\nrequire 'active_job'\n\nmodule Shoryuken\n  # ActiveJob integration module for Shoryuken\n  module ActiveJob\n    # Middleware to persist Rails CurrentAttributes across job execution.\n    #\n    # This ensures that request-scoped context (like current user, tenant, locale)\n    # automatically flows from the code that enqueues a job to the job's execution.\n    #\n    # Based on Sidekiq's approach to persisting current attributes.\n    #\n    # @example Setup in initializer\n    #   require 'shoryuken/active_job/current_attributes'\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current')\n    #\n    # @example Multiple CurrentAttributes classes\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current', 'MyApp::RequestContext')\n    #\n    # @see https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html\n    # @see https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/current_attributes.rb\n    module CurrentAttributes\n      # Serializer for current attributes using ActiveJob::Arguments.\n      # Supports Symbols and GlobalID objects.\n      module Serializer\n        module_function\n\n        # Serializes attributes hash for SQS message storage\n        #\n        # @param attrs [Hash] the attributes to serialize\n        # @return [Object] the serialized attributes\n        def serialize(attrs)\n          ::ActiveJob::Arguments.serialize([attrs]).first\n        end\n\n        # Deserializes attributes hash from SQS message\n        #\n        # @param attrs [Object] the serialized attributes\n        # @return [Hash] the deserialized attributes\n        def deserialize(attrs)\n          ::ActiveJob::Arguments.deserialize([attrs]).first\n        end\n      end\n\n      class << self\n        # @return [Hash{String => String}] serialization keys mapped to CurrentAttributes class names\n        attr_reader :cattrs\n\n        # Register CurrentAttributes classes to persist across job execution.\n        #\n        # @param klasses [Array<String, Class>] CurrentAttributes class names or classes\n        # @example\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist('Current')\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist(Current, RequestContext)\n        def persist(*klasses)\n          @cattrs ||= {}\n\n          klasses.flatten.each_with_index do |klass, idx|\n            key = @cattrs.empty? ? 'cattr' : \"cattr_#{idx}\"\n            @cattrs[key] = klass.to_s\n          end\n\n          # Prepend the persistence module to the adapter for serialization\n          unless ::ActiveJob::QueueAdapters::ShoryukenAdapter.ancestors.include?(Persistence)\n            ::ActiveJob::QueueAdapters::ShoryukenAdapter.prepend(Persistence)\n          end\n\n          # Prepend the loading module to JobWrapper for deserialization\n          unless Shoryuken::ActiveJob::JobWrapper.ancestors.include?(Loading)\n            Shoryuken::ActiveJob::JobWrapper.prepend(Loading)\n          end\n        end\n      end\n\n      # Module prepended to ShoryukenAdapter to serialize CurrentAttributes on enqueue.\n      module Persistence\n        private\n\n        # Builds the SQS message with CurrentAttributes data\n        #\n        # @param queue [Shoryuken::Queue] the target queue\n        # @param job [ActiveJob::Base] the job being enqueued\n        # @return [Hash] the message parameters\n        def message(queue, job)\n          hash = super\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next if hash[:message_body].key?(key)\n\n            klass = klass_name.constantize\n            attrs = klass.attributes\n            next if attrs.empty?\n\n            hash[:message_body][key] = Serializer.serialize(attrs)\n          end\n\n          hash\n        end\n      end\n\n      # Module prepended to JobWrapper to restore CurrentAttributes on execute.\n      module Loading\n        # Performs the job after restoring CurrentAttributes\n        #\n        # @param sqs_msg [Shoryuken::Message] the SQS message\n        # @param hash [Hash] the deserialized job data\n        # @return [void]\n        def perform(sqs_msg, hash)\n          klasses_to_reset = []\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next unless hash.key?(key)\n\n            klass = klass_name.constantize\n            klasses_to_reset << klass\n\n            begin\n              attrs = Serializer.deserialize(hash[key])\n              attrs.each do |attr_name, value|\n                klass.public_send(:\"#{attr_name}=\", value) if klass.respond_to?(:\"#{attr_name}=\")\n              end\n            rescue => e\n              # Log but don't fail if attributes can't be restored\n              # (e.g., attribute removed between enqueue and execute)\n              Shoryuken.logger.warn(\"Failed to restore CurrentAttributes #{klass_name}: #{e.message}\")\n            end\n          end\n\n          super\n        ensure\n          klasses_to_reset.each(&:reset)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "persist", "signature": "def persist(*klasses)", "start_line": 58, "end_line": 75}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 387}
{"function_name": "message", "file_path": "shoryuken/lib/shoryuken/active_job/current_attributes.rb", "focal_code": "def message(queue, job)\n          hash = super\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next if hash[:message_body].key?(key)\n\n            klass = klass_name.constantize\n            attrs = klass.attributes\n            next if attrs.empty?\n\n            hash[:message_body][key] = Serializer.serialize(attrs)\n          end\n\n          hash\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'active_support/current_attributes'\nrequire 'active_job'\n\nmodule Shoryuken\n  # ActiveJob integration module for Shoryuken\n  module ActiveJob\n    # Middleware to persist Rails CurrentAttributes across job execution.\n    #\n    # This ensures that request-scoped context (like current user, tenant, locale)\n    # automatically flows from the code that enqueues a job to the job's execution.\n    #\n    # Based on Sidekiq's approach to persisting current attributes.\n    #\n    # @example Setup in initializer\n    #   require 'shoryuken/active_job/current_attributes'\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current')\n    #\n    # @example Multiple CurrentAttributes classes\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current', 'MyApp::RequestContext')\n    #\n    # @see https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html\n    # @see https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/current_attributes.rb\n    module CurrentAttributes\n      # Serializer for current attributes using ActiveJob::Arguments.\n      # Supports Symbols and GlobalID objects.\n      module Serializer\n        module_function\n\n        # Serializes attributes hash for SQS message storage\n        #\n        # @param attrs [Hash] the attributes to serialize\n        # @return [Object] the serialized attributes\n        def serialize(attrs)\n          ::ActiveJob::Arguments.serialize([attrs]).first\n        end\n\n        # Deserializes attributes hash from SQS message\n        #\n        # @param attrs [Object] the serialized attributes\n        # @return [Hash] the deserialized attributes\n        def deserialize(attrs)\n          ::ActiveJob::Arguments.deserialize([attrs]).first\n        end\n      end\n\n      class << self\n        # @return [Hash{String => String}] serialization keys mapped to CurrentAttributes class names\n        attr_reader :cattrs\n\n        # Register CurrentAttributes classes to persist across job execution.\n        #\n        # @param klasses [Array<String, Class>] CurrentAttributes class names or classes\n        # @example\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist('Current')\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist(Current, RequestContext)\n        def persist(*klasses)\n          @cattrs ||= {}\n\n          klasses.flatten.each_with_index do |klass, idx|\n            key = @cattrs.empty? ? 'cattr' : \"cattr_#{idx}\"\n            @cattrs[key] = klass.to_s\n          end\n\n          # Prepend the persistence module to the adapter for serialization\n          unless ::ActiveJob::QueueAdapters::ShoryukenAdapter.ancestors.include?(Persistence)\n            ::ActiveJob::QueueAdapters::ShoryukenAdapter.prepend(Persistence)\n          end\n\n          # Prepend the loading module to JobWrapper for deserialization\n          unless Shoryuken::ActiveJob::JobWrapper.ancestors.include?(Loading)\n            Shoryuken::ActiveJob::JobWrapper.prepend(Loading)\n          end\n        end\n      end\n\n      # Module prepended to ShoryukenAdapter to serialize CurrentAttributes on enqueue.\n      module Persistence\n        private\n\n        # Builds the SQS message with CurrentAttributes data\n        #\n        # @param queue [Shoryuken::Queue] the target queue\n        # @param job [ActiveJob::Base] the job being enqueued\n        # @return [Hash] the message parameters\n        def message(queue, job)\n          hash = super\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next if hash[:message_body].key?(key)\n\n            klass = klass_name.constantize\n            attrs = klass.attributes\n            next if attrs.empty?\n\n            hash[:message_body][key] = Serializer.serialize(attrs)\n          end\n\n          hash\n        end\n      end\n\n      # Module prepended to JobWrapper to restore CurrentAttributes on execute.\n      module Loading\n        # Performs the job after restoring CurrentAttributes\n        #\n        # @param sqs_msg [Shoryuken::Message] the SQS message\n        # @param hash [Hash] the deserialized job data\n        # @return [void]\n        def perform(sqs_msg, hash)\n          klasses_to_reset = []\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next unless hash.key?(key)\n\n            klass = klass_name.constantize\n            klasses_to_reset << klass\n\n            begin\n              attrs = Serializer.deserialize(hash[key])\n              attrs.each do |attr_name, value|\n                klass.public_send(:\"#{attr_name}=\", value) if klass.respond_to?(:\"#{attr_name}=\")\n              end\n            rescue => e\n              # Log but don't fail if attributes can't be restored\n              # (e.g., attribute removed between enqueue and execute)\n              Shoryuken.logger.warn(\"Failed to restore CurrentAttributes #{klass_name}: #{e.message}\")\n            end\n          end\n\n          super\n        ensure\n          klasses_to_reset.each(&:reset)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "message", "signature": "def message(queue, job)", "start_line": 87, "end_line": 101}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 388}
{"function_name": "perform", "file_path": "shoryuken/lib/shoryuken/active_job/current_attributes.rb", "focal_code": "def perform(sqs_msg, hash)\n          klasses_to_reset = []\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next unless hash.key?(key)\n\n            klass = klass_name.constantize\n            klasses_to_reset << klass\n\n            begin\n              attrs = Serializer.deserialize(hash[key])\n              attrs.each do |attr_name, value|\n                klass.public_send(:\"#{attr_name}=\", value) if klass.respond_to?(:\"#{attr_name}=\")\n              end\n            rescue => e\n              # Log but don't fail if attributes can't be restored\n              # (e.g., attribute removed between enqueue and execute)\n              Shoryuken.logger.warn(\"Failed to restore CurrentAttributes #{klass_name}: #{e.message}\")\n            end\n          end\n\n          super\n        ensure\n          klasses_to_reset.each(&:reset)\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'active_support/current_attributes'\nrequire 'active_job'\n\nmodule Shoryuken\n  # ActiveJob integration module for Shoryuken\n  module ActiveJob\n    # Middleware to persist Rails CurrentAttributes across job execution.\n    #\n    # This ensures that request-scoped context (like current user, tenant, locale)\n    # automatically flows from the code that enqueues a job to the job's execution.\n    #\n    # Based on Sidekiq's approach to persisting current attributes.\n    #\n    # @example Setup in initializer\n    #   require 'shoryuken/active_job/current_attributes'\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current')\n    #\n    # @example Multiple CurrentAttributes classes\n    #   Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current', 'MyApp::RequestContext')\n    #\n    # @see https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html\n    # @see https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/current_attributes.rb\n    module CurrentAttributes\n      # Serializer for current attributes using ActiveJob::Arguments.\n      # Supports Symbols and GlobalID objects.\n      module Serializer\n        module_function\n\n        # Serializes attributes hash for SQS message storage\n        #\n        # @param attrs [Hash] the attributes to serialize\n        # @return [Object] the serialized attributes\n        def serialize(attrs)\n          ::ActiveJob::Arguments.serialize([attrs]).first\n        end\n\n        # Deserializes attributes hash from SQS message\n        #\n        # @param attrs [Object] the serialized attributes\n        # @return [Hash] the deserialized attributes\n        def deserialize(attrs)\n          ::ActiveJob::Arguments.deserialize([attrs]).first\n        end\n      end\n\n      class << self\n        # @return [Hash{String => String}] serialization keys mapped to CurrentAttributes class names\n        attr_reader :cattrs\n\n        # Register CurrentAttributes classes to persist across job execution.\n        #\n        # @param klasses [Array<String, Class>] CurrentAttributes class names or classes\n        # @example\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist('Current')\n        #   Shoryuken::ActiveJob::CurrentAttributes.persist(Current, RequestContext)\n        def persist(*klasses)\n          @cattrs ||= {}\n\n          klasses.flatten.each_with_index do |klass, idx|\n            key = @cattrs.empty? ? 'cattr' : \"cattr_#{idx}\"\n            @cattrs[key] = klass.to_s\n          end\n\n          # Prepend the persistence module to the adapter for serialization\n          unless ::ActiveJob::QueueAdapters::ShoryukenAdapter.ancestors.include?(Persistence)\n            ::ActiveJob::QueueAdapters::ShoryukenAdapter.prepend(Persistence)\n          end\n\n          # Prepend the loading module to JobWrapper for deserialization\n          unless Shoryuken::ActiveJob::JobWrapper.ancestors.include?(Loading)\n            Shoryuken::ActiveJob::JobWrapper.prepend(Loading)\n          end\n        end\n      end\n\n      # Module prepended to ShoryukenAdapter to serialize CurrentAttributes on enqueue.\n      module Persistence\n        private\n\n        # Builds the SQS message with CurrentAttributes data\n        #\n        # @param queue [Shoryuken::Queue] the target queue\n        # @param job [ActiveJob::Base] the job being enqueued\n        # @return [Hash] the message parameters\n        def message(queue, job)\n          hash = super\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next if hash[:message_body].key?(key)\n\n            klass = klass_name.constantize\n            attrs = klass.attributes\n            next if attrs.empty?\n\n            hash[:message_body][key] = Serializer.serialize(attrs)\n          end\n\n          hash\n        end\n      end\n\n      # Module prepended to JobWrapper to restore CurrentAttributes on execute.\n      module Loading\n        # Performs the job after restoring CurrentAttributes\n        #\n        # @param sqs_msg [Shoryuken::Message] the SQS message\n        # @param hash [Hash] the deserialized job data\n        # @return [void]\n        def perform(sqs_msg, hash)\n          klasses_to_reset = []\n\n          CurrentAttributes.cattrs&.each do |key, klass_name|\n            next unless hash.key?(key)\n\n            klass = klass_name.constantize\n            klasses_to_reset << klass\n\n            begin\n              attrs = Serializer.deserialize(hash[key])\n              attrs.each do |attr_name, value|\n                klass.public_send(:\"#{attr_name}=\", value) if klass.respond_to?(:\"#{attr_name}=\")\n              end\n            rescue => e\n              # Log but don't fail if attributes can't be restored\n              # (e.g., attribute removed between enqueue and execute)\n              Shoryuken.logger.warn(\"Failed to restore CurrentAttributes #{klass_name}: #{e.message}\")\n            end\n          end\n\n          super\n        ensure\n          klasses_to_reset.each(&:reset)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "perform", "signature": "def perform(sqs_msg, hash)", "start_line": 111, "end_line": 135}, "metadata": {"module": "Shoryuken", "class_name": "", "class_signature": ""}, "task_id": 389}
{"function_name": "initialize", "file_path": "shoryuken/lib/shoryuken/helpers/timer_task.rb", "focal_code": "def initialize(execution_interval:, &task)\n        raise ArgumentError, 'A block must be provided' unless block_given?\n\n        @execution_interval = Float(execution_interval)\n        raise ArgumentError, 'execution_interval must be positive' if @execution_interval <= 0\n\n        @task = task\n        @mutex = Mutex.new\n        @thread = nil\n        @running = false\n        @killed = false\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Helpers\n    # A thread-safe timer task implementation.\n    # Drop-in replacement for Concurrent::TimerTask without external dependencies.\n    class TimerTask\n      # Initializes a new TimerTask\n      #\n      # @param execution_interval [Float] interval in seconds between task executions\n      # @param task [Proc] the task to execute on each interval (provided as a block)\n      # @return [TimerTask] a new TimerTask instance\n      # @raise [ArgumentError] if no block is provided or interval is not positive\n      # @yield the task to execute on each interval\n      def initialize(execution_interval:, &task)\n        raise ArgumentError, 'A block must be provided' unless block_given?\n\n        @execution_interval = Float(execution_interval)\n        raise ArgumentError, 'execution_interval must be positive' if @execution_interval <= 0\n\n        @task = task\n        @mutex = Mutex.new\n        @thread = nil\n        @running = false\n        @killed = false\n      end\n\n      # Starts the timer task execution\n      #\n      # @return [TimerTask] self for method chaining\n      def execute\n        @mutex.synchronize do\n          return self if @running || @killed\n\n          @running = true\n          @thread = Thread.new { run_timer_loop }\n        end\n        self\n      end\n\n      # Stops and kills the timer task\n      #\n      # @return [Boolean] true if killed, false if already killed\n      def kill\n        @mutex.synchronize do\n          return false if @killed\n\n          @killed = true\n          @running = false\n\n          @thread.kill if @thread&.alive?\n        end\n        true\n      end\n\n      private\n\n      # Runs the timer loop in a separate thread\n      #\n      # @return [void]\n      def run_timer_loop\n        until @killed\n          sleep(@execution_interval)\n          break if @killed\n\n          begin\n            @task.call\n          rescue => e\n            # Log the error but continue running\n            # This matches the behavior of Concurrent::TimerTask\n            warn \"TimerTask execution error: #{e.message}\"\n            warn e.backtrace.join(\"\\n\") if e.backtrace\n          end\n        end\n      ensure\n        @mutex.synchronize { @running = false }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(execution_interval:, &task)", "start_line": 15, "end_line": 26}, "metadata": {"module": "Shoryuken", "class_name": "TimerTask", "class_signature": "class TimerTask"}, "task_id": 390}
{"function_name": "run_timer_loop", "file_path": "shoryuken/lib/shoryuken/helpers/timer_task.rb", "focal_code": "def run_timer_loop\n        until @killed\n          sleep(@execution_interval)\n          break if @killed\n\n          begin\n            @task.call\n          rescue => e\n            # Log the error but continue running\n            # This matches the behavior of Concurrent::TimerTask\n            warn \"TimerTask execution error: #{e.message}\"\n            warn e.backtrace.join(\"\\n\") if e.backtrace\n          end\n        end\n      ensure\n        @mutex.synchronize { @running = false }\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Helpers\n    # A thread-safe timer task implementation.\n    # Drop-in replacement for Concurrent::TimerTask without external dependencies.\n    class TimerTask\n      # Initializes a new TimerTask\n      #\n      # @param execution_interval [Float] interval in seconds between task executions\n      # @param task [Proc] the task to execute on each interval (provided as a block)\n      # @return [TimerTask] a new TimerTask instance\n      # @raise [ArgumentError] if no block is provided or interval is not positive\n      # @yield the task to execute on each interval\n      def initialize(execution_interval:, &task)\n        raise ArgumentError, 'A block must be provided' unless block_given?\n\n        @execution_interval = Float(execution_interval)\n        raise ArgumentError, 'execution_interval must be positive' if @execution_interval <= 0\n\n        @task = task\n        @mutex = Mutex.new\n        @thread = nil\n        @running = false\n        @killed = false\n      end\n\n      # Starts the timer task execution\n      #\n      # @return [TimerTask] self for method chaining\n      def execute\n        @mutex.synchronize do\n          return self if @running || @killed\n\n          @running = true\n          @thread = Thread.new { run_timer_loop }\n        end\n        self\n      end\n\n      # Stops and kills the timer task\n      #\n      # @return [Boolean] true if killed, false if already killed\n      def kill\n        @mutex.synchronize do\n          return false if @killed\n\n          @killed = true\n          @running = false\n\n          @thread.kill if @thread&.alive?\n        end\n        true\n      end\n\n      private\n\n      # Runs the timer loop in a separate thread\n      #\n      # @return [void]\n      def run_timer_loop\n        until @killed\n          sleep(@execution_interval)\n          break if @killed\n\n          begin\n            @task.call\n          rescue => e\n            # Log the error but continue running\n            # This matches the behavior of Concurrent::TimerTask\n            warn \"TimerTask execution error: #{e.message}\"\n            warn e.backtrace.join(\"\\n\") if e.backtrace\n          end\n        end\n      ensure\n        @mutex.synchronize { @running = false }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run_timer_loop", "signature": "def run_timer_loop until @killed", "start_line": 61, "end_line": 77}, "metadata": {"module": "Shoryuken", "class_name": "TimerTask", "class_signature": "class TimerTask"}, "task_id": 391}
{"function_name": "call", "file_path": "shoryuken/lib/shoryuken/middleware/server/timing.rb", "focal_code": "def call(_worker, queue, _sqs_msg, _body)\n          started_at = Time.now\n\n          logger.info { \"started at #{started_at}\" }\n\n          yield\n\n          total_time = elapsed(started_at)\n\n          if (total_time / 1000.0) > (timeout = Shoryuken::Client.queues(queue).visibility_timeout)\n            logger.warn { \"exceeded the queue visibility timeout by #{total_time - (timeout * 1000)} ms\" }\n          end\n\n          logger.info { \"completed in: #{total_time} ms\" }\n        rescue\n          logger.info { \"failed in: #{elapsed(started_at)} ms\" }\n          raise\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Middleware\n    module Server\n      # Middleware that logs timing information for message processing.\n      # Records start time, completion time, and warns if processing\n      # exceeds the queue's visibility timeout.\n      class Timing\n        include Util\n\n        # Processes a message while logging timing information\n        #\n        # @param _worker [Object] the worker instance (unused)\n        # @param queue [String] the queue name\n        # @param _sqs_msg [Shoryuken::Message] the message being processed (unused)\n        # @param _body [Object] the parsed message body (unused)\n        # @yield continues to the next middleware in the chain\n        # @return [void]\n        def call(_worker, queue, _sqs_msg, _body)\n          started_at = Time.now\n\n          logger.info { \"started at #{started_at}\" }\n\n          yield\n\n          total_time = elapsed(started_at)\n\n          if (total_time / 1000.0) > (timeout = Shoryuken::Client.queues(queue).visibility_timeout)\n            logger.warn { \"exceeded the queue visibility timeout by #{total_time - (timeout * 1000)} ms\" }\n          end\n\n          logger.info { \"completed in: #{total_time} ms\" }\n        rescue\n          logger.info { \"failed in: #{elapsed(started_at)} ms\" }\n          raise\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(_worker, queue, _sqs_msg, _body)", "start_line": 20, "end_line": 37}, "metadata": {"module": "Shoryuken", "class_name": "Timing", "class_signature": "class Timing"}, "task_id": 392}
{"function_name": "call", "file_path": "shoryuken/lib/shoryuken/middleware/server/non_retryable_exception.rb", "focal_code": "def call(worker, queue, sqs_msg, _body)\n          yield\n        rescue => e\n          non_retryable_exceptions = worker.class.get_shoryuken_options['non_retryable_exceptions']\n\n          return raise unless non_retryable_exceptions\n\n          if non_retryable_exceptions.respond_to?(:call)\n            return raise unless non_retryable_exceptions.call(e)\n          else\n            exception_classes = Array(non_retryable_exceptions)\n            return raise unless exception_classes.any? { |klass| e.is_a?(klass) }\n          end\n\n          # Handle batch messages\n          messages = sqs_msg.is_a?(Array) ? sqs_msg : [sqs_msg]\n\n          logger.warn do\n            \"Non-retryable exception #{e.class} occurred for message(s) #{messages.map(&:message_id).join(', ')}. \" \\\n            \"Deleting message(s) immediately. Error: #{e.message}\"\n          end\n\n          logger.debug { e.backtrace.join(\"\\n\") } if e.backtrace\n\n          # Delete the message(s) immediately\n          entries = messages.map.with_index { |message, i| { id: i.to_s, receipt_handle: message.receipt_handle } }\n\n          begin\n            queue_client = Shoryuken::Client.queues(queue)\n            delete_failed = queue_client.delete_messages(entries: entries)\n\n            # Check if deletion reported failures (returns true if any failed)\n            if delete_failed\n              logger.warn do\n                'Failed to delete some messages for non-retryable exception on queue ' \\\n                  \"'#{queue}'. \" \\\n                  \"Entries: #{entries.map { |e| { id: e[:id] } }.inspect}. \" \\\n                  'Some messages may remain in the queue and could be reprocessed.'\n              end\n            end\n          rescue => delete_error\n            logger.error do\n              'Error deleting messages for non-retryable exception on queue ' \\\n                \"'#{queue}': #{delete_error.class} - #{delete_error.message}. \" \\\n                \"Entries: #{entries.map { |e| { id: e[:id] } }.inspect}. \" \\\n                'Messages may remain in the queue and could be reprocessed.'\n            end\n            logger.debug { delete_error.backtrace.join(\"\\n\") } if delete_error.backtrace\n          end\n\n          # Don't re-raise - the exception has been handled by deleting the message\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Middleware\n    module Server\n      # Middleware that handles non-retryable exceptions by deleting messages immediately.\n      # When a configured exception occurs, the message is deleted instead of being retried.\n      #\n      # Configure non-retryable exceptions per worker:\n      #\n      #   class MyWorker\n      #     include Shoryuken::Worker\n      #\n      #     # Using exception classes\n      #     shoryuken_options queue: 'my_queue',\n      #                       non_retryable_exceptions: [InvalidInputError, RecordNotFoundError]\n      #\n      #     # Or using a lambda for dynamic classification\n      #     shoryuken_options queue: 'my_queue',\n      #                       non_retryable_exceptions: ->(error) {\n      #                         error.is_a?(StandardError) && error.message.include?('permanent')\n      #                       }\n      #\n      #     def perform(sqs_msg, body)\n      #       # ...\n      #     end\n      #   end\n      class NonRetryableException\n        include Util\n\n        # Processes a message and handles non-retryable exceptions\n        #\n        # @param worker [Object] the worker instance\n        # @param queue [String] the queue name\n        # @param sqs_msg [Shoryuken::Message, Array<Shoryuken::Message>] the message or batch\n        # @param _body [Object] the parsed message body (unused)\n        # @yield continues to the next middleware in the chain\n        # @return [void]\n        def call(worker, queue, sqs_msg, _body)\n          yield\n        rescue => e\n          non_retryable_exceptions = worker.class.get_shoryuken_options['non_retryable_exceptions']\n\n          return raise unless non_retryable_exceptions\n\n          if non_retryable_exceptions.respond_to?(:call)\n            return raise unless non_retryable_exceptions.call(e)\n          else\n            exception_classes = Array(non_retryable_exceptions)\n            return raise unless exception_classes.any? { |klass| e.is_a?(klass) }\n          end\n\n          # Handle batch messages\n          messages = sqs_msg.is_a?(Array) ? sqs_msg : [sqs_msg]\n\n          logger.warn do\n            \"Non-retryable exception #{e.class} occurred for message(s) #{messages.map(&:message_id).join(', ')}. \" \\\n            \"Deleting message(s) immediately. Error: #{e.message}\"\n          end\n\n          logger.debug { e.backtrace.join(\"\\n\") } if e.backtrace\n\n          # Delete the message(s) immediately\n          entries = messages.map.with_index { |message, i| { id: i.to_s, receipt_handle: message.receipt_handle } }\n\n          begin\n            queue_client = Shoryuken::Client.queues(queue)\n            delete_failed = queue_client.delete_messages(entries: entries)\n\n            # Check if deletion reported failures (returns true if any failed)\n            if delete_failed\n              logger.warn do\n                'Failed to delete some messages for non-retryable exception on queue ' \\\n                  \"'#{queue}'. \" \\\n                  \"Entries: #{entries.map { |e| { id: e[:id] } }.inspect}. \" \\\n                  'Some messages may remain in the queue and could be reprocessed.'\n              end\n            end\n          rescue => delete_error\n            logger.error do\n              'Error deleting messages for non-retryable exception on queue ' \\\n                \"'#{queue}': #{delete_error.class} - #{delete_error.message}. \" \\\n                \"Entries: #{entries.map { |e| { id: e[:id] } }.inspect}. \" \\\n                'Messages may remain in the queue and could be reprocessed.'\n            end\n            logger.debug { delete_error.backtrace.join(\"\\n\") } if delete_error.backtrace\n          end\n\n          # Don't re-raise - the exception has been handled by deleting the message\n        end\n      end\n    end\n  end\nend\n\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(worker, queue, sqs_msg, _body)", "start_line": 39, "end_line": 90}, "metadata": {"module": "Shoryuken", "class_name": "NonRetryableException", "class_signature": "class NonRetryableException"}, "task_id": 393}
{"function_name": "call", "file_path": "shoryuken/lib/shoryuken/middleware/server/auto_extend_visibility.rb", "focal_code": "def call(worker, queue, sqs_msg, body)\n          return yield unless worker.class.auto_visibility_timeout?\n\n          if sqs_msg.is_a?(Array)\n            logger.warn { \"Auto extend visibility isn't supported for batch workers\" }\n            return yield\n          end\n\n          timer = auto_visibility_timer(worker, queue, sqs_msg, body)\n          yield\n        ensure\n          timer.kill if timer\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Middleware\n    module Server\n      # Middleware that automatically extends message visibility timeout during processing.\n      # Prevents messages from becoming visible to other consumers while still being processed.\n      class AutoExtendVisibility\n        include Util\n\n        # Number of seconds before timeout to extend visibility\n        EXTEND_UPFRONT_SECONDS = 5\n\n        # Processes a message with automatic visibility timeout extension\n        #\n        # @param worker [Object] the worker instance\n        # @param queue [String] the queue name\n        # @param sqs_msg [Shoryuken::Message, Array<Shoryuken::Message>] the message or batch\n        # @param body [Object] the parsed message body\n        # @yield continues to the next middleware in the chain\n        # @return [void]\n        def call(worker, queue, sqs_msg, body)\n          return yield unless worker.class.auto_visibility_timeout?\n\n          if sqs_msg.is_a?(Array)\n            logger.warn { \"Auto extend visibility isn't supported for batch workers\" }\n            return yield\n          end\n\n          timer = auto_visibility_timer(worker, queue, sqs_msg, body)\n          yield\n        ensure\n          timer.kill if timer\n        end\n\n        private\n\n        # Helper class for extending message visibility\n        class MessageVisibilityExtender\n          include Util\n\n          # Creates a timer task that extends message visibility\n          #\n          # @param _worker [Object] the worker instance (unused)\n          # @param queue [String] the queue name\n          # @param sqs_msg [Shoryuken::Message] the message\n          # @param _body [Object] the parsed message body (unused)\n          # @return [Shoryuken::Helpers::TimerTask] the timer task\n          def auto_extend(_worker, queue, sqs_msg, _body)\n            queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout\n\n            Shoryuken::Helpers::TimerTask.new(execution_interval: queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do\n              logger.debug do\n                \"Extending message #{queue}/#{sqs_msg.message_id} visibility timeout by #{queue_visibility_timeout}s\"\n              end\n\n              sqs_msg.change_visibility(visibility_timeout: queue_visibility_timeout)\n            rescue => e\n              logger.error do\n                \"Could not auto extend the message #{queue}/#{sqs_msg.message_id} visibility timeout. Error: #{e.message}\"\n              end\n            end\n          end\n        end\n\n        # Creates and starts a visibility extension timer\n        #\n        # @param worker [Object] the worker instance\n        # @param queue [String] the queue name\n        # @param sqs_msg [Shoryuken::Message] the message\n        # @param body [Object] the parsed message body\n        # @return [Shoryuken::Helpers::TimerTask] the started timer\n        def auto_visibility_timer(worker, queue, sqs_msg, body)\n          MessageVisibilityExtender.new.auto_extend(worker, queue, sqs_msg, body).tap(&:execute)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(worker, queue, sqs_msg, body)", "start_line": 22, "end_line": 34}, "metadata": {"module": "Shoryuken", "class_name": "AutoExtendVisibility", "class_signature": "class AutoExtendVisibility"}, "task_id": 394}
{"function_name": "auto_extend", "file_path": "shoryuken/lib/shoryuken/middleware/server/auto_extend_visibility.rb", "focal_code": "def auto_extend(_worker, queue, sqs_msg, _body)\n            queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout\n\n            Shoryuken::Helpers::TimerTask.new(execution_interval: queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do\n              logger.debug do\n                \"Extending message #{queue}/#{sqs_msg.message_id} visibility timeout by #{queue_visibility_timeout}s\"\n              end\n\n              sqs_msg.change_visibility(visibility_timeout: queue_visibility_timeout)\n            rescue => e\n              logger.error do\n                \"Could not auto extend the message #{queue}/#{sqs_msg.message_id} visibility timeout. Error: #{e.message}\"\n              end\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Middleware\n    module Server\n      # Middleware that automatically extends message visibility timeout during processing.\n      # Prevents messages from becoming visible to other consumers while still being processed.\n      class AutoExtendVisibility\n        include Util\n\n        # Number of seconds before timeout to extend visibility\n        EXTEND_UPFRONT_SECONDS = 5\n\n        # Processes a message with automatic visibility timeout extension\n        #\n        # @param worker [Object] the worker instance\n        # @param queue [String] the queue name\n        # @param sqs_msg [Shoryuken::Message, Array<Shoryuken::Message>] the message or batch\n        # @param body [Object] the parsed message body\n        # @yield continues to the next middleware in the chain\n        # @return [void]\n        def call(worker, queue, sqs_msg, body)\n          return yield unless worker.class.auto_visibility_timeout?\n\n          if sqs_msg.is_a?(Array)\n            logger.warn { \"Auto extend visibility isn't supported for batch workers\" }\n            return yield\n          end\n\n          timer = auto_visibility_timer(worker, queue, sqs_msg, body)\n          yield\n        ensure\n          timer.kill if timer\n        end\n\n        private\n\n        # Helper class for extending message visibility\n        class MessageVisibilityExtender\n          include Util\n\n          # Creates a timer task that extends message visibility\n          #\n          # @param _worker [Object] the worker instance (unused)\n          # @param queue [String] the queue name\n          # @param sqs_msg [Shoryuken::Message] the message\n          # @param _body [Object] the parsed message body (unused)\n          # @return [Shoryuken::Helpers::TimerTask] the timer task\n          def auto_extend(_worker, queue, sqs_msg, _body)\n            queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout\n\n            Shoryuken::Helpers::TimerTask.new(execution_interval: queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do\n              logger.debug do\n                \"Extending message #{queue}/#{sqs_msg.message_id} visibility timeout by #{queue_visibility_timeout}s\"\n              end\n\n              sqs_msg.change_visibility(visibility_timeout: queue_visibility_timeout)\n            rescue => e\n              logger.error do\n                \"Could not auto extend the message #{queue}/#{sqs_msg.message_id} visibility timeout. Error: #{e.message}\"\n              end\n            end\n          end\n        end\n\n        # Creates and starts a visibility extension timer\n        #\n        # @param worker [Object] the worker instance\n        # @param queue [String] the queue name\n        # @param sqs_msg [Shoryuken::Message] the message\n        # @param body [Object] the parsed message body\n        # @return [Shoryuken::Helpers::TimerTask] the started timer\n        def auto_visibility_timer(worker, queue, sqs_msg, body)\n          MessageVisibilityExtender.new.auto_extend(worker, queue, sqs_msg, body).tap(&:execute)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "auto_extend", "signature": "def auto_extend(_worker, queue, sqs_msg, _body)", "start_line": 49, "end_line": 63}, "metadata": {"module": "Shoryuken", "class_name": "AutoExtendVisibility", "class_signature": "class AutoExtendVisibility"}, "task_id": 395}
{"function_name": "call", "file_path": "shoryuken/lib/shoryuken/middleware/server/exponential_backoff_retry.rb", "focal_code": "def call(worker, _queue, sqs_msg, _body)\n          return yield unless worker.class.exponential_backoff?\n\n          if sqs_msg.is_a?(Array)\n            logger.warn { \"Exponential backoff isn't supported for batch workers\" }\n            return yield\n          end\n\n          started_at = Time.now\n          yield\n        rescue => e\n          retry_intervals = worker.class.get_shoryuken_options['retry_intervals']\n\n          if retry_intervals.nil? || !handle_failure(sqs_msg, started_at, retry_intervals)\n            # Re-raise the exception if the job is not going to be exponential backoff retried.\n            # This allows custom middleware (like exception notifiers) to be aware of the unhandled failure.\n            raise\n          end\n\n          logger.warn { \"Message #{sqs_msg.message_id} will attempt retry due to error: #{e.message}\" }\n          # since we didn't raise, lets log the backtrace for debugging purposes.\n          logger.debug { e.backtrace.join(\"\\n\") } unless e.backtrace.nil?\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Shoryuken\n  module Middleware\n    module Server\n      # Middleware that implements exponential backoff retry for failed messages.\n      # When a job fails, the message visibility timeout is adjusted based on\n      # configured retry intervals.\n      class ExponentialBackoffRetry\n        include Util\n\n        # Processes a message with exponential backoff retry on failure\n        #\n        # @param worker [Object] the worker instance\n        # @param _queue [String] the queue name (unused)\n        # @param sqs_msg [Shoryuken::Message, Array<Shoryuken::Message>] the message or batch\n        # @param _body [Object] the parsed message body (unused)\n        # @yield continues to the next middleware in the chain\n        # @return [void]\n        # @raise [StandardError] re-raises the original exception if retry intervals are not configured\n        #   or if retry limit is exceeded\n        def call(worker, _queue, sqs_msg, _body)\n          return yield unless worker.class.exponential_backoff?\n\n          if sqs_msg.is_a?(Array)\n            logger.warn { \"Exponential backoff isn't supported for batch workers\" }\n            return yield\n          end\n\n          started_at = Time.now\n          yield\n        rescue => e\n          retry_intervals = worker.class.get_shoryuken_options['retry_intervals']\n\n          if retry_intervals.nil? || !handle_failure(sqs_msg, started_at, retry_intervals)\n            # Re-raise the exception if the job is not going to be exponential backoff retried.\n            # This allows custom middleware (like exception notifiers) to be aware of the unhandled failure.\n            raise\n          end\n\n          logger.warn { \"Message #{sqs_msg.message_id} will attempt retry due to error: #{e.message}\" }\n          # since we didn't raise, lets log the backtrace for debugging purposes.\n          logger.debug { e.backtrace.join(\"\\n\") } unless e.backtrace.nil?\n        end\n\n        private\n\n        # Gets the retry interval for a given attempt number\n        #\n        # @param retry_intervals [Array<Integer>, #call] the configured intervals or callable\n        # @param attempts [Integer] the current attempt number\n        # @return [Integer, nil] the interval in seconds or nil\n        def get_interval(retry_intervals, attempts)\n          return retry_intervals.call(attempts) if retry_intervals.respond_to?(:call)\n\n          if attempts <= (retry_intervals = Array(retry_intervals)).size\n            retry_intervals[attempts - 1]\n          else\n            retry_intervals.last\n          end\n        end\n\n        # Calculates the next visibility timeout capped at SQS maximum\n        #\n        # @param interval [Integer] the desired interval\n        # @param started_at [Time] when processing started\n        # @return [Integer] the capped visibility timeout\n        def next_visibility_timeout(interval, started_at)\n          max_timeout = 43_200 - (Time.now - started_at).ceil - 1\n          interval = max_timeout if interval > max_timeout\n          interval.to_i\n        end\n\n        # Handles a message failure by adjusting visibility timeout\n        #\n        # @param sqs_msg [Shoryuken::Message] the failed message\n        # @param started_at [Time] when processing started\n        # @param retry_intervals [Array<Integer>, #call] the configured intervals\n        # @return [Boolean] true if retry was scheduled, false otherwise\n        def handle_failure(sqs_msg, started_at, retry_intervals)\n          receive_count = sqs_msg.attributes['ApproximateReceiveCount'].to_i\n\n          return false unless (interval = get_interval(retry_intervals, receive_count))\n\n          sqs_msg.change_visibility(visibility_timeout: next_visibility_timeout(interval.to_i, started_at))\n\n          logger.info { \"Message #{sqs_msg.message_id} failed, will be retried in #{interval} seconds\" }\n\n          true\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(worker, _queue, sqs_msg, _body)", "start_line": 22, "end_line": 44}, "metadata": {"module": "Shoryuken", "class_name": "ExponentialBackoffRetry", "class_signature": "class ExponentialBackoffRetry"}, "task_id": 396}
{"function_name": "enqueue_at", "file_path": "shoryuken/lib/active_job/queue_adapters/shoryuken_adapter.rb", "focal_code": "def enqueue_at(job, timestamp) # :nodoc:\n        delay = calculate_delay(timestamp)\n\n        # FIFO queues do not support per-message delays\n        # Check early to fail synchronously (before any async wrapping in subclasses)\n        # Note: negative delays (past timestamps) don't need handling here -\n        # SQS treats them as immediate delivery (delay_seconds=0)\n        # See https://github.com/ruby-shoryuken/shoryuken/issues/924\n        if delay.positive?\n          queue = Shoryuken::Client.queues(job.queue_name)\n          if queue.fifo?\n            raise Shoryuken::Errors::FifoDelayNotSupportedError,\n                  \"FIFO queue '#{queue.name}' does not support per-message delays. \" \\\n                  'When using ActiveJob retry_on with FIFO queues, set `wait: 0`.'\n          end\n        end\n\n        enqueue(job, delay_seconds: delay)\n      end", "file_content": "# frozen_string_literal: true\n\n# ActiveJob docs: http://edgeguides.rubyonrails.org/active_job_basics.html\n# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters\n\nrequire 'shoryuken'\nrequire 'shoryuken/active_job/job_wrapper'\n\n# Rails ActiveJob module providing background job processing\nmodule ActiveJob\n  # Queue adapter implementations for various backends\n  module QueueAdapters\n    # Shoryuken adapter for Active Job.\n    # To use Shoryuken set the queue_adapter config to +:shoryuken+.\n    #\n    # @example Rails configuration\n    #   Rails.application.config.active_job.queue_adapter = :shoryuken\n\n    # Determine the appropriate base class based on Rails version\n    # This prevents AbstractAdapter autoloading issues in Rails 7.0-7.1\n    base = if defined?(Rails) && defined?(Rails::VERSION)\n             (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR < 2 ? Object : AbstractAdapter)\n           else\n             Object\n           end\n\n    # Shoryuken queue adapter for ActiveJob integration.\n    # Provides methods for enqueueing jobs to SQS queues.\n    class ShoryukenAdapter < base\n      class << self\n        # Returns the singleton adapter instance\n        #\n        # @return [ShoryukenAdapter] the adapter instance\n        def instance\n          # https://github.com/ruby-shoryuken/shoryuken/pull/174#issuecomment-174555657\n          @instance ||= new\n        end\n\n        # Enqueues a job for immediate processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue(job)\n          instance.enqueue(job)\n        end\n\n        # Enqueues a job for delayed processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @param timestamp [Float] Unix timestamp when the job should be processed\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue_at(job, timestamp)\n          instance.enqueue_at(job, timestamp)\n        end\n      end\n\n      # Checks if jobs should be enqueued after transaction commit (Rails 7.2+)\n      #\n      # @return [Boolean] always returns true\n      def enqueue_after_transaction_commit?\n        true\n      end\n\n      # Indicates whether Shoryuken is in the process of shutting down.\n      #\n      # This method is required for ActiveJob Continuations support (Rails 8.1+).\n      # When true, it signals to jobs that they should checkpoint their progress\n      # and gracefully interrupt execution to allow for resumption after restart.\n      #\n      # @return [Boolean] true if Shoryuken is shutting down, false otherwise\n      # @see https://github.com/rails/rails/pull/55127 Rails ActiveJob Continuations\n      def stopping?\n        launcher = Shoryuken::Runner.instance.launcher\n        launcher&.stopping? || false\n      end\n\n      # Enqueues a job for immediate processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param options [Hash] SQS message configuration\n      # @option options [Integer] :delay_seconds delay before the message becomes visible\n      # @option options [String] :message_group_id FIFO queue group ID\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      def enqueue(job, options = {}) # :nodoc:\n        register_worker!(job)\n\n        job.sqs_send_message_parameters.merge! options\n\n        queue = Shoryuken::Client.queues(job.queue_name)\n        send_message_params = message queue, job\n        job.sqs_send_message_parameters = send_message_params\n        queue.send_message send_message_params\n      end\n\n      # Enqueues a job for delayed processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param timestamp [Float] Unix timestamp when the job should be processed\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      # @raise [Shoryuken::Errors::FifoDelayNotSupportedError] if delay is used with a FIFO queue\n      def enqueue_at(job, timestamp) # :nodoc:\n        delay = calculate_delay(timestamp)\n\n        # FIFO queues do not support per-message delays\n        # Check early to fail synchronously (before any async wrapping in subclasses)\n        # Note: negative delays (past timestamps) don't need handling here -\n        # SQS treats them as immediate delivery (delay_seconds=0)\n        # See https://github.com/ruby-shoryuken/shoryuken/issues/924\n        if delay.positive?\n          queue = Shoryuken::Client.queues(job.queue_name)\n          if queue.fifo?\n            raise Shoryuken::Errors::FifoDelayNotSupportedError,\n                  \"FIFO queue '#{queue.name}' does not support per-message delays. \" \\\n                  'When using ActiveJob retry_on with FIFO queues, set `wait: 0`.'\n          end\n        end\n\n        enqueue(job, delay_seconds: delay)\n      end\n\n      # Bulk enqueue multiple jobs efficiently using SQS batch API.\n      # Called by ActiveJob.perform_all_later (Rails 7.1+).\n      #\n      # @param jobs [Array<ActiveJob::Base>] array of ActiveJob instances to be enqueued\n      # @return [Integer] number of jobs successfully enqueued\n      def enqueue_all(jobs) # :nodoc:\n        jobs.group_by(&:queue_name).each do |queue_name, queue_jobs|\n          queue = Shoryuken::Client.queues(queue_name)\n\n          queue_jobs.each_slice(10) do |batch|\n            entries = batch.map.with_index do |job, idx|\n              register_worker!(job)\n              msg = message(queue, job)\n              job.sqs_send_message_parameters = msg\n              { id: idx.to_s }.merge(msg)\n            end\n\n            response = queue.send_messages(entries: entries)\n            successful_ids = response.successful.map { |r| r.id.to_i }.to_set\n            batch.each_with_index do |job, idx|\n              job.successfully_enqueued = successful_ids.include?(idx)\n            end\n          end\n        end\n\n        jobs.count(&:successfully_enqueued?)\n      end\n\n      private\n\n      # Calculates the delay in seconds from a timestamp\n      #\n      # @param timestamp [Float] Unix timestamp\n      # @return [Integer] delay in seconds\n      # @raise [RuntimeError] if delay exceeds 15 minutes\n      def calculate_delay(timestamp)\n        delay = (timestamp - Time.current.to_f).round\n        raise 'The maximum allowed delay is 15 minutes' if delay > 15.minutes\n\n        delay\n      end\n\n      # Builds the SQS message parameters for a job\n      #\n      # @param queue [Shoryuken::Queue] the queue to send to\n      # @param job [ActiveJob::Base] the job to serialize\n      # @return [Hash] the message parameters\n      def message(queue, job)\n        body = job.serialize\n        job_params = job.sqs_send_message_parameters\n\n        attributes = job_params[:message_attributes] || {}\n\n        msg = {\n          message_body: body,\n          message_attributes: attributes.merge(MESSAGE_ATTRIBUTES)\n        }\n\n        if queue.fifo?\n          # See https://github.com/ruby-shoryuken/shoryuken/issues/457 and\n          # https://github.com/ruby-shoryuken/shoryuken/pull/750#issuecomment-1781317929\n          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(\n            JSON.dump(body.except('job_id', 'enqueued_at'))\n          )\n        end\n\n        msg.merge(job_params.except(:message_attributes))\n      end\n\n      # Registers the JobWrapper as the worker for the job's queue\n      #\n      # @param job [ActiveJob::Base] the job being enqueued\n      # @return [void]\n      def register_worker!(job)\n        Shoryuken.register_worker(job.queue_name, Shoryuken::ActiveJob::JobWrapper)\n      end\n\n      # Default message attributes identifying the Shoryuken worker class\n      MESSAGE_ATTRIBUTES = {\n        'shoryuken_class' => {\n          string_value: Shoryuken::ActiveJob::JobWrapper.to_s,\n          data_type: 'String'\n        }\n      }.freeze\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "enqueue_at", "signature": "def enqueue_at(job, timestamp) # :nodoc:", "start_line": 102, "end_line": 120}, "metadata": {"module": "ActiveJob", "class_name": "ShoryukenAdapter", "class_signature": "class ShoryukenAdapter < < base"}, "task_id": 397}
{"function_name": "enqueue_all", "file_path": "shoryuken/lib/active_job/queue_adapters/shoryuken_adapter.rb", "focal_code": "def enqueue_all(jobs) # :nodoc:\n        jobs.group_by(&:queue_name).each do |queue_name, queue_jobs|\n          queue = Shoryuken::Client.queues(queue_name)\n\n          queue_jobs.each_slice(10) do |batch|\n            entries = batch.map.with_index do |job, idx|\n              register_worker!(job)\n              msg = message(queue, job)\n              job.sqs_send_message_parameters = msg\n              { id: idx.to_s }.merge(msg)\n            end\n\n            response = queue.send_messages(entries: entries)\n            successful_ids = response.successful.map { |r| r.id.to_i }.to_set\n            batch.each_with_index do |job, idx|\n              job.successfully_enqueued = successful_ids.include?(idx)\n            end\n          end\n        end\n\n        jobs.count(&:successfully_enqueued?)\n      end", "file_content": "# frozen_string_literal: true\n\n# ActiveJob docs: http://edgeguides.rubyonrails.org/active_job_basics.html\n# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters\n\nrequire 'shoryuken'\nrequire 'shoryuken/active_job/job_wrapper'\n\n# Rails ActiveJob module providing background job processing\nmodule ActiveJob\n  # Queue adapter implementations for various backends\n  module QueueAdapters\n    # Shoryuken adapter for Active Job.\n    # To use Shoryuken set the queue_adapter config to +:shoryuken+.\n    #\n    # @example Rails configuration\n    #   Rails.application.config.active_job.queue_adapter = :shoryuken\n\n    # Determine the appropriate base class based on Rails version\n    # This prevents AbstractAdapter autoloading issues in Rails 7.0-7.1\n    base = if defined?(Rails) && defined?(Rails::VERSION)\n             (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR < 2 ? Object : AbstractAdapter)\n           else\n             Object\n           end\n\n    # Shoryuken queue adapter for ActiveJob integration.\n    # Provides methods for enqueueing jobs to SQS queues.\n    class ShoryukenAdapter < base\n      class << self\n        # Returns the singleton adapter instance\n        #\n        # @return [ShoryukenAdapter] the adapter instance\n        def instance\n          # https://github.com/ruby-shoryuken/shoryuken/pull/174#issuecomment-174555657\n          @instance ||= new\n        end\n\n        # Enqueues a job for immediate processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue(job)\n          instance.enqueue(job)\n        end\n\n        # Enqueues a job for delayed processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @param timestamp [Float] Unix timestamp when the job should be processed\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue_at(job, timestamp)\n          instance.enqueue_at(job, timestamp)\n        end\n      end\n\n      # Checks if jobs should be enqueued after transaction commit (Rails 7.2+)\n      #\n      # @return [Boolean] always returns true\n      def enqueue_after_transaction_commit?\n        true\n      end\n\n      # Indicates whether Shoryuken is in the process of shutting down.\n      #\n      # This method is required for ActiveJob Continuations support (Rails 8.1+).\n      # When true, it signals to jobs that they should checkpoint their progress\n      # and gracefully interrupt execution to allow for resumption after restart.\n      #\n      # @return [Boolean] true if Shoryuken is shutting down, false otherwise\n      # @see https://github.com/rails/rails/pull/55127 Rails ActiveJob Continuations\n      def stopping?\n        launcher = Shoryuken::Runner.instance.launcher\n        launcher&.stopping? || false\n      end\n\n      # Enqueues a job for immediate processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param options [Hash] SQS message configuration\n      # @option options [Integer] :delay_seconds delay before the message becomes visible\n      # @option options [String] :message_group_id FIFO queue group ID\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      def enqueue(job, options = {}) # :nodoc:\n        register_worker!(job)\n\n        job.sqs_send_message_parameters.merge! options\n\n        queue = Shoryuken::Client.queues(job.queue_name)\n        send_message_params = message queue, job\n        job.sqs_send_message_parameters = send_message_params\n        queue.send_message send_message_params\n      end\n\n      # Enqueues a job for delayed processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param timestamp [Float] Unix timestamp when the job should be processed\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      # @raise [Shoryuken::Errors::FifoDelayNotSupportedError] if delay is used with a FIFO queue\n      def enqueue_at(job, timestamp) # :nodoc:\n        delay = calculate_delay(timestamp)\n\n        # FIFO queues do not support per-message delays\n        # Check early to fail synchronously (before any async wrapping in subclasses)\n        # Note: negative delays (past timestamps) don't need handling here -\n        # SQS treats them as immediate delivery (delay_seconds=0)\n        # See https://github.com/ruby-shoryuken/shoryuken/issues/924\n        if delay.positive?\n          queue = Shoryuken::Client.queues(job.queue_name)\n          if queue.fifo?\n            raise Shoryuken::Errors::FifoDelayNotSupportedError,\n                  \"FIFO queue '#{queue.name}' does not support per-message delays. \" \\\n                  'When using ActiveJob retry_on with FIFO queues, set `wait: 0`.'\n          end\n        end\n\n        enqueue(job, delay_seconds: delay)\n      end\n\n      # Bulk enqueue multiple jobs efficiently using SQS batch API.\n      # Called by ActiveJob.perform_all_later (Rails 7.1+).\n      #\n      # @param jobs [Array<ActiveJob::Base>] array of ActiveJob instances to be enqueued\n      # @return [Integer] number of jobs successfully enqueued\n      def enqueue_all(jobs) # :nodoc:\n        jobs.group_by(&:queue_name).each do |queue_name, queue_jobs|\n          queue = Shoryuken::Client.queues(queue_name)\n\n          queue_jobs.each_slice(10) do |batch|\n            entries = batch.map.with_index do |job, idx|\n              register_worker!(job)\n              msg = message(queue, job)\n              job.sqs_send_message_parameters = msg\n              { id: idx.to_s }.merge(msg)\n            end\n\n            response = queue.send_messages(entries: entries)\n            successful_ids = response.successful.map { |r| r.id.to_i }.to_set\n            batch.each_with_index do |job, idx|\n              job.successfully_enqueued = successful_ids.include?(idx)\n            end\n          end\n        end\n\n        jobs.count(&:successfully_enqueued?)\n      end\n\n      private\n\n      # Calculates the delay in seconds from a timestamp\n      #\n      # @param timestamp [Float] Unix timestamp\n      # @return [Integer] delay in seconds\n      # @raise [RuntimeError] if delay exceeds 15 minutes\n      def calculate_delay(timestamp)\n        delay = (timestamp - Time.current.to_f).round\n        raise 'The maximum allowed delay is 15 minutes' if delay > 15.minutes\n\n        delay\n      end\n\n      # Builds the SQS message parameters for a job\n      #\n      # @param queue [Shoryuken::Queue] the queue to send to\n      # @param job [ActiveJob::Base] the job to serialize\n      # @return [Hash] the message parameters\n      def message(queue, job)\n        body = job.serialize\n        job_params = job.sqs_send_message_parameters\n\n        attributes = job_params[:message_attributes] || {}\n\n        msg = {\n          message_body: body,\n          message_attributes: attributes.merge(MESSAGE_ATTRIBUTES)\n        }\n\n        if queue.fifo?\n          # See https://github.com/ruby-shoryuken/shoryuken/issues/457 and\n          # https://github.com/ruby-shoryuken/shoryuken/pull/750#issuecomment-1781317929\n          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(\n            JSON.dump(body.except('job_id', 'enqueued_at'))\n          )\n        end\n\n        msg.merge(job_params.except(:message_attributes))\n      end\n\n      # Registers the JobWrapper as the worker for the job's queue\n      #\n      # @param job [ActiveJob::Base] the job being enqueued\n      # @return [void]\n      def register_worker!(job)\n        Shoryuken.register_worker(job.queue_name, Shoryuken::ActiveJob::JobWrapper)\n      end\n\n      # Default message attributes identifying the Shoryuken worker class\n      MESSAGE_ATTRIBUTES = {\n        'shoryuken_class' => {\n          string_value: Shoryuken::ActiveJob::JobWrapper.to_s,\n          data_type: 'String'\n        }\n      }.freeze\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "enqueue_all", "signature": "def enqueue_all(jobs) # :nodoc:", "start_line": 127, "end_line": 148}, "metadata": {"module": "ActiveJob", "class_name": "ShoryukenAdapter", "class_signature": "class ShoryukenAdapter < < base"}, "task_id": 398}
{"function_name": "message", "file_path": "shoryuken/lib/active_job/queue_adapters/shoryuken_adapter.rb", "focal_code": "def message(queue, job)\n        body = job.serialize\n        job_params = job.sqs_send_message_parameters\n\n        attributes = job_params[:message_attributes] || {}\n\n        msg = {\n          message_body: body,\n          message_attributes: attributes.merge(MESSAGE_ATTRIBUTES)\n        }\n\n        if queue.fifo?\n          # See https://github.com/ruby-shoryuken/shoryuken/issues/457 and\n          # https://github.com/ruby-shoryuken/shoryuken/pull/750#issuecomment-1781317929\n          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(\n            JSON.dump(body.except('job_id', 'enqueued_at'))\n          )\n        end\n\n        msg.merge(job_params.except(:message_attributes))\n      end", "file_content": "# frozen_string_literal: true\n\n# ActiveJob docs: http://edgeguides.rubyonrails.org/active_job_basics.html\n# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters\n\nrequire 'shoryuken'\nrequire 'shoryuken/active_job/job_wrapper'\n\n# Rails ActiveJob module providing background job processing\nmodule ActiveJob\n  # Queue adapter implementations for various backends\n  module QueueAdapters\n    # Shoryuken adapter for Active Job.\n    # To use Shoryuken set the queue_adapter config to +:shoryuken+.\n    #\n    # @example Rails configuration\n    #   Rails.application.config.active_job.queue_adapter = :shoryuken\n\n    # Determine the appropriate base class based on Rails version\n    # This prevents AbstractAdapter autoloading issues in Rails 7.0-7.1\n    base = if defined?(Rails) && defined?(Rails::VERSION)\n             (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR < 2 ? Object : AbstractAdapter)\n           else\n             Object\n           end\n\n    # Shoryuken queue adapter for ActiveJob integration.\n    # Provides methods for enqueueing jobs to SQS queues.\n    class ShoryukenAdapter < base\n      class << self\n        # Returns the singleton adapter instance\n        #\n        # @return [ShoryukenAdapter] the adapter instance\n        def instance\n          # https://github.com/ruby-shoryuken/shoryuken/pull/174#issuecomment-174555657\n          @instance ||= new\n        end\n\n        # Enqueues a job for immediate processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue(job)\n          instance.enqueue(job)\n        end\n\n        # Enqueues a job for delayed processing\n        #\n        # @param job [ActiveJob::Base] the job to enqueue\n        # @param timestamp [Float] Unix timestamp when the job should be processed\n        # @return [Aws::SQS::Types::SendMessageResult] the send result\n        def enqueue_at(job, timestamp)\n          instance.enqueue_at(job, timestamp)\n        end\n      end\n\n      # Checks if jobs should be enqueued after transaction commit (Rails 7.2+)\n      #\n      # @return [Boolean] always returns true\n      def enqueue_after_transaction_commit?\n        true\n      end\n\n      # Indicates whether Shoryuken is in the process of shutting down.\n      #\n      # This method is required for ActiveJob Continuations support (Rails 8.1+).\n      # When true, it signals to jobs that they should checkpoint their progress\n      # and gracefully interrupt execution to allow for resumption after restart.\n      #\n      # @return [Boolean] true if Shoryuken is shutting down, false otherwise\n      # @see https://github.com/rails/rails/pull/55127 Rails ActiveJob Continuations\n      def stopping?\n        launcher = Shoryuken::Runner.instance.launcher\n        launcher&.stopping? || false\n      end\n\n      # Enqueues a job for immediate processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param options [Hash] SQS message configuration\n      # @option options [Integer] :delay_seconds delay before the message becomes visible\n      # @option options [String] :message_group_id FIFO queue group ID\n      # @option options [String] :message_deduplication_id FIFO queue deduplication ID\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      def enqueue(job, options = {}) # :nodoc:\n        register_worker!(job)\n\n        job.sqs_send_message_parameters.merge! options\n\n        queue = Shoryuken::Client.queues(job.queue_name)\n        send_message_params = message queue, job\n        job.sqs_send_message_parameters = send_message_params\n        queue.send_message send_message_params\n      end\n\n      # Enqueues a job for delayed processing\n      #\n      # @param job [ActiveJob::Base] the job to enqueue\n      # @param timestamp [Float] Unix timestamp when the job should be processed\n      # @return [Aws::SQS::Types::SendMessageResult] the send result\n      # @raise [Shoryuken::Errors::FifoDelayNotSupportedError] if delay is used with a FIFO queue\n      def enqueue_at(job, timestamp) # :nodoc:\n        delay = calculate_delay(timestamp)\n\n        # FIFO queues do not support per-message delays\n        # Check early to fail synchronously (before any async wrapping in subclasses)\n        # Note: negative delays (past timestamps) don't need handling here -\n        # SQS treats them as immediate delivery (delay_seconds=0)\n        # See https://github.com/ruby-shoryuken/shoryuken/issues/924\n        if delay.positive?\n          queue = Shoryuken::Client.queues(job.queue_name)\n          if queue.fifo?\n            raise Shoryuken::Errors::FifoDelayNotSupportedError,\n                  \"FIFO queue '#{queue.name}' does not support per-message delays. \" \\\n                  'When using ActiveJob retry_on with FIFO queues, set `wait: 0`.'\n          end\n        end\n\n        enqueue(job, delay_seconds: delay)\n      end\n\n      # Bulk enqueue multiple jobs efficiently using SQS batch API.\n      # Called by ActiveJob.perform_all_later (Rails 7.1+).\n      #\n      # @param jobs [Array<ActiveJob::Base>] array of ActiveJob instances to be enqueued\n      # @return [Integer] number of jobs successfully enqueued\n      def enqueue_all(jobs) # :nodoc:\n        jobs.group_by(&:queue_name).each do |queue_name, queue_jobs|\n          queue = Shoryuken::Client.queues(queue_name)\n\n          queue_jobs.each_slice(10) do |batch|\n            entries = batch.map.with_index do |job, idx|\n              register_worker!(job)\n              msg = message(queue, job)\n              job.sqs_send_message_parameters = msg\n              { id: idx.to_s }.merge(msg)\n            end\n\n            response = queue.send_messages(entries: entries)\n            successful_ids = response.successful.map { |r| r.id.to_i }.to_set\n            batch.each_with_index do |job, idx|\n              job.successfully_enqueued = successful_ids.include?(idx)\n            end\n          end\n        end\n\n        jobs.count(&:successfully_enqueued?)\n      end\n\n      private\n\n      # Calculates the delay in seconds from a timestamp\n      #\n      # @param timestamp [Float] Unix timestamp\n      # @return [Integer] delay in seconds\n      # @raise [RuntimeError] if delay exceeds 15 minutes\n      def calculate_delay(timestamp)\n        delay = (timestamp - Time.current.to_f).round\n        raise 'The maximum allowed delay is 15 minutes' if delay > 15.minutes\n\n        delay\n      end\n\n      # Builds the SQS message parameters for a job\n      #\n      # @param queue [Shoryuken::Queue] the queue to send to\n      # @param job [ActiveJob::Base] the job to serialize\n      # @return [Hash] the message parameters\n      def message(queue, job)\n        body = job.serialize\n        job_params = job.sqs_send_message_parameters\n\n        attributes = job_params[:message_attributes] || {}\n\n        msg = {\n          message_body: body,\n          message_attributes: attributes.merge(MESSAGE_ATTRIBUTES)\n        }\n\n        if queue.fifo?\n          # See https://github.com/ruby-shoryuken/shoryuken/issues/457 and\n          # https://github.com/ruby-shoryuken/shoryuken/pull/750#issuecomment-1781317929\n          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(\n            JSON.dump(body.except('job_id', 'enqueued_at'))\n          )\n        end\n\n        msg.merge(job_params.except(:message_attributes))\n      end\n\n      # Registers the JobWrapper as the worker for the job's queue\n      #\n      # @param job [ActiveJob::Base] the job being enqueued\n      # @return [void]\n      def register_worker!(job)\n        Shoryuken.register_worker(job.queue_name, Shoryuken::ActiveJob::JobWrapper)\n      end\n\n      # Default message attributes identifying the Shoryuken worker class\n      MESSAGE_ATTRIBUTES = {\n        'shoryuken_class' => {\n          string_value: Shoryuken::ActiveJob::JobWrapper.to_s,\n          data_type: 'String'\n        }\n      }.freeze\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "message", "signature": "def message(queue, job)", "start_line": 169, "end_line": 189}, "metadata": {"module": "ActiveJob", "class_name": "ShoryukenAdapter", "class_signature": "class ShoryukenAdapter < < base"}, "task_id": 399}
{"function_name": "forward", "file_path": "rom/core/lib/rom/data_proxy.rb", "focal_code": "def forward(*methods)\n        # FIXME: we should probably raise if one of the non-forwardable methods\n        #       was provided\n        (methods - NON_FORWARDABLE).each do |method_name|\n          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n            def #{method_name}(...)                              # def find_all(...)\n              response = data.public_send(:#{method_name}, ...)  #   response = data.public_send(:find_all, ...)\n                                                                 #\n              if response.equal?(data)                           #   if response.equal?(data)\n                self                                             #     self\n              elsif response.is_a?(data.class)                   #   elsif response.is_a?(data.class)\n                self.class.new(response)                         #     self.class.new(response)\n              else                                               #   else\n                response                                         #     response\n              end                                                #   end\n            end                                                  # end\n          RUBY\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # Helper module for dataset classes\n  #\n  # It provides a constructor accepting data, header and an optional row_proc.\n  # This module is used internally by EnumerableDataset and ArrayDataset.\n  #\n  # @private\n  module DataProxy\n    NON_FORWARDABLE = %i[\n      each to_a to_ary kind_of? instance_of? is_a?\n    ].freeze\n\n    # Wrapped data array\n    #\n    # @return [Object] Data object for the iterator\n    #\n    # @api private\n    attr_reader :data\n\n    # @return [Proc] tuple processing proc\n    #\n    # @api private\n    attr_reader :row_proc\n\n    # Extends the class with `forward` DSL and Equalizer using `data` attribute\n    #\n    # @see ClassMethods#forward\n    #\n    # @api private\n    def self.included(klass)\n      klass.class_eval do\n        extend ClassMethods\n\n        include ::Dry::Equalizer(:data)\n\n        option :row_proc, default: -> { self.class.row_proc }\n      end\n    end\n\n    # Iterate over data using row_proc\n    #\n    # @return [Enumerator] if block is not given\n    #\n    # @api private\n    def each\n      return to_enum unless block_given?\n\n      data.each { |tuple| yield(row_proc[tuple]) }\n    end\n\n    module ClassMethods\n      # Default no-op tuple proc\n      #\n      # @return [Proc]\n      #\n      # @api private\n      def row_proc = -> tuple { tuple }\n\n      # Forward provided methods to the underlaying data object\n      #\n      # @example\n      #\n      #   class MyDataset\n      #     include DataProxy\n      #\n      #     forward(:find_all, :map)\n      #   end\n      #\n      # @return [undefined]\n      #\n      # @api public\n      def forward(*methods)\n        # FIXME: we should probably raise if one of the non-forwardable methods\n        #       was provided\n        (methods - NON_FORWARDABLE).each do |method_name|\n          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n            def #{method_name}(...)                              # def find_all(...)\n              response = data.public_send(:#{method_name}, ...)  #   response = data.public_send(:find_all, ...)\n                                                                 #\n              if response.equal?(data)                           #   if response.equal?(data)\n                self                                             #     self\n              elsif response.is_a?(data.class)                   #   elsif response.is_a?(data.class)\n                self.class.new(response)                         #     self.class.new(response)\n              else                                               #   else\n                response                                         #     response\n              end                                                #   end\n            end                                                  # end\n          RUBY\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "forward", "signature": "def forward(*methods)", "start_line": 74, "end_line": 92}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 400}
{"function_name": "plugin", "file_path": "rom/core/lib/rom/configuration_dsl.rb", "focal_code": "def plugin(adapter, spec, &)\n      type, name = spec.flatten(1)\n      plugin = plugin_registry[type].adapter(adapter).fetch(name) do\n        plugin_registry[type].fetch(name)\n      end\n\n      if block_given?\n        register_plugin(plugin.configure(&))\n      else\n        register_plugin(plugin)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/configuration_dsl/relation'\nrequire 'rom/configuration_dsl/command_dsl'\nrequire 'rom/configuration_dsl/mapper_dsl'\n\nmodule ROM\n  # This extends Configuration class with the DSL methods\n  #\n  # @api public\n  module ConfigurationDSL\n    # Relation definition DSL\n    #\n    # @example\n    #   setup.relation(:users) do\n    #     def names\n    #       project(:name)\n    #     end\n    #   end\n    #\n    # @api public\n    def relation(name, options = EMPTY_HASH, &)\n      klass_opts = { adapter: default_adapter }.merge(options)\n      klass = Relation.build_class(name, klass_opts)\n      klass.schema_opts(dataset: name, relation: name)\n      klass.class_eval(&) if block_given?\n      register_relation(klass)\n      klass\n    end\n\n    # Command definition DSL\n    #\n    # @example\n    #   setup.commands(:users) do\n    #     define(:create) do\n    #       input NewUserParams\n    #       result :one\n    #     end\n    #\n    #     define(:update) do\n    #       input UserParams\n    #       result :many\n    #     end\n    #\n    #     define(:delete) do\n    #       result :many\n    #     end\n    #   end\n    #\n    # @api public\n    def commands(name, &)\n      register_command(*CommandDSL.new(name, default_adapter, &).command_classes)\n    end\n\n    # Mapper definition DSL\n    #\n    # @api public\n    def mappers(&block)\n      register_mapper(*MapperDSL.new(self, mapper_classes, block).mapper_classes)\n    end\n\n    # Configures a plugin for a specific adapter to be enabled for all relations\n    #\n    # @example\n    #   config = ROM::Configuration.new(:sql, 'sqlite::memory')\n    #\n    #   config.plugin(:sql, relations: :instrumentation) do |p|\n    #     p.notifications = MyNotificationsBackend\n    #   end\n    #\n    #   config.plugin(:sql, relations: :pagination)\n    #\n    # @param [Symbol] adapter The adapter identifier\n    # @param [Hash<Symbol=>Symbol>] spec Component identifier => plugin identifier\n    #\n    # @return [Plugin]\n    #\n    # @api public\n    def plugin(adapter, spec, &)\n      type, name = spec.flatten(1)\n      plugin = plugin_registry[type].adapter(adapter).fetch(name) do\n        plugin_registry[type].fetch(name)\n      end\n\n      if block_given?\n        register_plugin(plugin.configure(&))\n      else\n        register_plugin(plugin)\n      end\n    end\n\n    # @api private\n    def plugin_registry = ::ROM.plugin_registry\n  end\nend\n", "language": "ruby", "function_component": {"name": "plugin", "signature": "def plugin(adapter, spec, &)", "start_line": 79, "end_line": 90}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 401}
{"function_name": "visit_relation", "file_path": "rom/core/lib/rom/mapper_compiler.rb", "focal_code": "def visit_relation(node)\n      rel_name, header, meta_options = node\n      name = meta_options[:combine_name] || meta_options[:alias] || rel_name\n      namespace = meta_options.fetch(:struct_namespace)\n\n      model = meta_options.fetch(:model) do\n        if meta_options[:combine_name]\n          false\n        else\n          struct_compiler[name, header, namespace]\n        end\n      end\n\n      options = [header.map(&method(:visit)), mapper_options.merge(model: model)]\n\n      if meta_options[:combine_type]\n        type = meta_options[:combine_type] == :many ? :array : :hash\n        keys = meta_options.fetch(:keys)\n\n        [name, combine: true, type: type, keys: keys, header: Header.coerce(*options)]\n      elsif meta_options[:wrap]\n        [name, wrap: true, type: :hash, header: Header.coerce(*options)]\n      else\n        options\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/constants'\nrequire 'rom/initializer'\nrequire 'rom/mapper'\nrequire 'rom/struct'\nrequire 'rom/struct_compiler'\nrequire 'rom/cache'\n\nmodule ROM\n  # @api private\n  class MapperCompiler\n    extend Dry::Core::ClassAttributes\n    extend Initializer\n\n    defines :mapper_options\n\n    mapper_options(EMPTY_HASH)\n\n    option :cache, default: -> { Cache.new }\n\n    attr_reader :struct_compiler\n\n    attr_reader :mapper_options\n\n    def initialize(*, **)\n      super\n      @struct_compiler = StructCompiler.new(cache: cache)\n      @cache = cache.namespaced(:mappers)\n      @mapper_options = self.class.mapper_options\n    end\n\n    def call(ast)\n      cache.fetch_or_store(ast.hash) { Mapper.build(Header.coerce(*visit(ast))) }\n    end\n    alias_method :[], :call\n\n    private\n\n    def visit(node)\n      name, node = node\n      __send__(\"visit_#{name}\", node)\n    end\n\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n    def visit_relation(node)\n      rel_name, header, meta_options = node\n      name = meta_options[:combine_name] || meta_options[:alias] || rel_name\n      namespace = meta_options.fetch(:struct_namespace)\n\n      model = meta_options.fetch(:model) do\n        if meta_options[:combine_name]\n          false\n        else\n          struct_compiler[name, header, namespace]\n        end\n      end\n\n      options = [header.map(&method(:visit)), mapper_options.merge(model: model)]\n\n      if meta_options[:combine_type]\n        type = meta_options[:combine_type] == :many ? :array : :hash\n        keys = meta_options.fetch(:keys)\n\n        [name, combine: true, type: type, keys: keys, header: Header.coerce(*options)]\n      elsif meta_options[:wrap]\n        [name, wrap: true, type: :hash, header: Header.coerce(*options)]\n      else\n        options\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    def visit_attribute(node)\n      name, _, meta_options = node\n\n      if meta_options[:alias]\n        [meta_options[:alias], from: name]\n      else\n        [name]\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_relation", "signature": "def visit_relation(node)", "start_line": 46, "end_line": 71}, "metadata": {"module": "ROM", "class_name": "MapperCompiler", "class_signature": "class MapperCompiler"}, "task_id": 402}
{"function_name": "normalize_gateways", "file_path": "rom/core/lib/rom/environment.rb", "focal_code": "def normalize_gateways(gateways_config)\n      gateways_config.each_with_object(map: {}, gateways: {}) do |(name, spec), hash|\n        identifier, *args = Array(spec)\n\n        if identifier.is_a?(Gateway)\n          gateway = identifier\n        else\n          kwargs = args.last.is_a?(::Hash) ? args.pop : {}\n          gateway = Gateway.setup(identifier, *args.flatten, **kwargs)\n        end\n\n        hash[:map][gateway] = name\n        hash[:gateways][name] = gateway\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/configurable'\nrequire 'rom/gateway'\n\nmodule ROM\n  # Core gateway configuration interface\n  #\n  # @api private\n  class Environment\n    include Configurable\n\n    attr_reader :gateways\n\n    attr_reader :gateways_map\n\n    # @api private\n    def initialize(*args)\n      @gateways = {}\n      @gateways_map = {}\n\n      configure_gateways(*args) unless args.empty?\n    end\n\n    private\n\n    # @api private\n    def configure_gateways(*args)\n      normalized_gateway_args = normalize_gateway_args(args)\n      normalized_gateways = normalize_gateways(normalized_gateway_args)\n\n      @gateways, @gateways_map = normalized_gateways.values_at(:gateways, :map)\n\n      normalized_gateway_args.each_with_object(config) do |(name, gateway_config), config|\n        options = gateway_config.is_a?(Array) && gateway_config.last\n        load_config(config.gateways[name], options) if options.is_a?(Hash)\n      end\n    end\n\n    # @api private\n    def normalize_gateway_args(args)\n      if args.first.is_a?(::Hash)\n        args.first\n      else\n        { default: args }\n      end\n    end\n\n    # Build gateways using the setup interface\n    #\n    # @api private\n    def normalize_gateways(gateways_config)\n      gateways_config.each_with_object(map: {}, gateways: {}) do |(name, spec), hash|\n        identifier, *args = Array(spec)\n\n        if identifier.is_a?(Gateway)\n          gateway = identifier\n        else\n          kwargs = args.last.is_a?(::Hash) ? args.pop : {}\n          gateway = Gateway.setup(identifier, *args.flatten, **kwargs)\n        end\n\n        hash[:map][gateway] = name\n        hash[:gateways][name] = gateway\n      end\n    end\n\n    # @api private\n    def load_config(config, hash)\n      hash.each do |key, value|\n        if value.is_a?(Hash)\n          load_config(config[key], value)\n        else\n          config.send(\"#{key}=\", value)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "normalize_gateways", "signature": "def normalize_gateways(gateways_config)", "start_line": 52, "end_line": 66}, "metadata": {"module": "ROM", "class_name": "Environment", "class_signature": "class Environment"}, "task_id": 403}
{"function_name": "call", "file_path": "rom/core/lib/rom/command.rb", "focal_code": "def call(*args, &)\n      tuples =\n        if hooks?\n          prepared =\n            if curried?\n              apply_hooks(before_hooks, *(curry_args + args))\n            else\n              apply_hooks(before_hooks, *args)\n            end\n\n          result =\n            if prepared\n              execute(prepared, &)\n            else\n              execute(&)\n            end\n\n          if curried?\n            if !args.empty?\n              apply_hooks(after_hooks, result, *args)\n            elsif curry_args.size > 1\n              apply_hooks(after_hooks, result, curry_args[1])\n            else\n              apply_hooks(after_hooks, result)\n            end\n          else\n            apply_hooks(after_hooks, result, *args.drop(1))\n          end\n        else\n          execute(*(curry_args + args), &)\n        end\n\n      if one?\n        tuples.first\n      else\n        tuples\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/initializer'\nrequire 'rom/pipeline'\n\nrequire 'rom/commands/class_interface'\nrequire 'rom/commands/composite'\nrequire 'rom/commands/graph'\nrequire 'rom/commands/lazy'\n\nmodule ROM\n  # Abstract command class\n  #\n  # Provides a constructor accepting relation with options and basic behavior\n  # for calling, currying and composing commands.\n  #\n  # Typically command subclasses should inherit from specialized\n  # Create/Update/Delete, not this one.\n  #\n  # @abstract\n  #\n  # @api public\n  class Command\n    extend Dry::Core::ClassAttributes\n    extend Initializer\n    extend ClassInterface\n\n    include Dry::Equalizer(:relation, :options)\n    include Commands\n    include Pipeline::Operator\n\n    # @!method self.adapter\n    #   Get or set adapter identifier\n    #\n    #   @overload adapter\n    #     Get adapter identifier\n    #\n    #     @example\n    #       ROM::Memory::Commands::Create.adapter\n    #       # => :memory\n    #\n    #     @return [Symbol]\n    #\n    #   @overload adapter(identifier)\n    #     Set adapter identifier. This must always match actual adapter identifier\n    #     that was used to register an adapter.\n    #\n    #     @example\n    #       module MyAdapter\n    #         class CreateCommand < ROM::Commands::Memory::Create\n    #           adapter :my_adapter\n    #         end\n    #       end\n    #\n    # @api public\n    defines :adapter\n\n    # @!method self.relation\n    #   Get or set relation identifier\n    #\n    #   @overload relation\n    #     Get relation identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         relation :users\n    #       end\n    #\n    #       CreateUser.relation\n    #       # => :users\n    #\n    #     @return [Symbol]\n    #\n    #   @overload relation(identifier)\n    #     Set relation identifier.\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         relation :users\n    #       end\n    #\n    # @api public\n    defines :relation\n\n    # @!method self.result\n    #   Get or set result type\n    #\n    #   @overload result\n    #     Get result type\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         result :one\n    #       end\n    #\n    #       CreateUser.result\n    #       # => :one\n    #\n    #     @return [Symbol]\n    #\n    #   @overload result(identifier)\n    #     Set result type\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         result :one\n    #       end\n    #\n    # @api public\n    defines :result\n\n    # @!method self.input\n    #   Get or set input processing function. This is typically set during setup\n    #   to relation's input_schema\n    #\n    #   @overload input\n    #     Get input processing function\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         input -> tuple { .. }\n    #       end\n    #\n    #       CreateUser.input\n    #       # Your custom function\n    #\n    #     @return [Proc,#call]\n    #\n    #   @overload input(identifier)\n    #     Set input processing function\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         input -> tuple { .. }\n    #       end\n    #\n    # @api public\n    defines :input\n\n    # @!method self.register_as\n    #   Get or set identifier that should be used to register a command in a container\n    #\n    #   @overload register_as\n    #     Get registration identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         register_as :create_user\n    #       end\n    #\n    #       CreateUser.register_as\n    #       # => :create_user\n    #\n    #     @return [Symbol]\n    #\n    #   @overload register_as(identifier)\n    #     Set registration identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         register_as :create_user\n    #       end\n    #\n    # @api public\n    defines :register_as\n\n    # @!method self.restrictable\n    #   @overload restrictable\n    #     Check if a command class is restrictable\n    #\n    #     @example\n    #       class UpdateUser < ROM::Commands::Update[:memory]\n    #         restrictable true\n    #       end\n    #\n    #       CreateUser.restrictable\n    #       # => true\n    #\n    #     @return [FalseClass, TrueClass]\n    #\n    #   @overload restrictable(value)\n    #     Set if a command is restrictable\n    #\n    #     @example\n    #       class UpdateUser < ROM::Commands::Update[:memory]\n    #         restrictable true\n    #       end\n    #\n    # @api public\n    defines :restrictable\n\n    # @!attribute [r] relation\n    #   @return [Relation] Command's relation\n    param :relation\n\n    CommandType = Types::Strict::Symbol.enum(:create, :update, :delete)\n    Result = Types::Strict::Symbol.enum(:one, :many)\n\n    # @!attribute [r] type\n    #   @return [Symbol] The command type, one of :create, :update or :delete\n    option :type, type: CommandType, optional: true\n\n    # @!attribute [r] source\n    #   @return [Relation] The source relation\n    option :source, default: -> { relation }\n\n    # @!attribute [r] result\n    #   @return [Symbol] Result type, either :one or :many\n    option :result, type: Result\n\n    # @!attribute [r] input\n    #   @return [Proc, #call] Tuple processing function, typically uses Relation#input_schema\n    option :input\n\n    # @!attribute [r] curry_args\n    #   @return [Array] Curried args\n    option :curry_args, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] before\n    #   @return [Array<Hash>] An array with before hooks configuration\n    option :before, Types::Coercible::Array, reader: false, default: -> { self.class.before }\n\n    # @!attribute [r] after\n    #   @return [Array<Hash>] An array with after hooks configuration\n    option :after, Types::Coercible::Array, reader: false, default: -> { self.class.after }\n\n    input Hash\n    result :many\n\n    # Return name of this command's relation\n    #\n    # @return [ROM::Relation::Name]\n    #\n    # @api public\n    def name\n      relation.name\n    end\n\n    # Return gateway of this command's relation\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    def gateway\n      relation.gateway\n    end\n\n    # Execute the command\n    #\n    # @abstract\n    #\n    # @return [Array] an array with inserted tuples\n    #\n    # @api private\n    def execute(*)\n      raise(\n        ::NotImplementedError,\n        \"#{self.class}##{__method__} must be implemented\"\n      )\n    end\n\n    # Call the command and return one or many tuples\n    #\n    # This method will apply before/after hooks automatically\n    #\n    # @api public\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def call(*args, &)\n      tuples =\n        if hooks?\n          prepared =\n            if curried?\n              apply_hooks(before_hooks, *(curry_args + args))\n            else\n              apply_hooks(before_hooks, *args)\n            end\n\n          result =\n            if prepared\n              execute(prepared, &)\n            else\n              execute(&)\n            end\n\n          if curried?\n            if !args.empty?\n              apply_hooks(after_hooks, result, *args)\n            elsif curry_args.size > 1\n              apply_hooks(after_hooks, result, curry_args[1])\n            else\n              apply_hooks(after_hooks, result)\n            end\n          else\n            apply_hooks(after_hooks, result, *args.drop(1))\n          end\n        else\n          execute(*(curry_args + args), &)\n        end\n\n      if one?\n        tuples.first\n      else\n        tuples\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    alias_method :[], :call\n\n    # Curry this command with provided args\n    #\n    # Curried command can be called without args. If argument is a graph input processor,\n    # lazy command will be returned, which is used for handling nested input hashes.\n    #\n    # @return [Command, Lazy]\n    #\n    # @api public\n    def curry(*args)\n      if curry_args.empty? && args.first.is_a?(Graph::InputEvaluator)\n        Lazy[self].new(self, *args)\n      else\n        self.class.build(relation, **options, curry_args: args)\n      end\n    end\n\n    # Compose this command with other commands\n    #\n    # Composed commands can handle nested input\n    #\n    # @return [Command::Graph]\n    #\n    # @api public\n    def combine(*others) = Graph.new(self, others)\n\n    # Check if this command is curried\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api public\n    def curried? = !curry_args.empty?\n\n    # Return a new command with appended before hooks\n    #\n    # @param [Array<Hash>] hooks A list of before hooks configurations\n    #\n    # @return [Command]\n    #\n    # @api public\n    def before(*hooks)\n      self.class.new(relation, **options, before: before_hooks + hooks)\n    end\n\n    # Return a new command with appended after hooks\n    #\n    # @param [Array<Hash>] hooks A list of after hooks configurations\n    #\n    # @return [Command]\n    #\n    # @api public\n    def after(*hooks)\n      self.class.new(relation, **options, after: after_hooks + hooks)\n    end\n\n    # List of before hooks\n    #\n    # @return [Array]\n    #\n    # @api public\n    def before_hooks = options[:before]\n\n    # List of after hooks\n    #\n    # @return [Array]\n    #\n    # @api public\n    def after_hooks = options[:after]\n\n    # Return a new command with other source relation\n    #\n    # This can be used to restrict command with a specific relation\n    #\n    # @return [Command]\n    #\n    # @api public\n    def new(new_relation)\n      self.class.build(new_relation, **options, source: relation)\n    end\n\n    # Check if this command has any hooks\n    #\n    # @api private\n    def hooks? = !before_hooks.empty? || !after_hooks.empty?\n\n    # Check if this command is lazy\n    #\n    # @return [false]\n    #\n    # @api private\n    def lazy? = false\n\n    # Check if this command is a graph\n    #\n    # @return [false]\n    #\n    # @api private\n    def graph? = false\n\n    # Check if this command returns a single tuple\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def one? = result.equal?(:one)\n\n    # Check if this command returns many tuples\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def many? = result.equal?(:many)\n\n    # Check if this command is restrictible through relation\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def restrictible? = self.class.restrictable.equal?(true)\n\n    # Yields tuples for insertion or return an enumerator\n    #\n    # @api private\n    def map_input_tuples(tuples, &mapper)\n      return enum_for(:with_input_tuples, tuples) unless mapper\n\n      if tuples.respond_to? :merge\n        mapper[tuples]\n      else\n        tuples.map(&mapper)\n      end\n    end\n\n    private\n\n    # Hook called by Pipeline to get composite class for commands\n    #\n    # @return [Class]\n    #\n    # @api private\n    def composite_class = Command::Composite\n\n    # Apply provided hooks\n    #\n    # Used by #call\n    #\n    # @return [Array<Hash>]\n    #\n    # @api private\n    def apply_hooks(hooks, tuples, *args)\n      hooks.reduce(tuples) do |a, e|\n        if e.is_a?(Hash)\n          hook_meth, hook_args = e.to_a.flatten(1)\n          __send__(hook_meth, a, *args, **hook_args)\n        else\n          __send__(e, a, *args)\n        end\n      end\n    end\n\n    # Pipes a dataset through command's relation\n    #\n    # @return [Array]\n    #\n    # @api private\n    def wrap_dataset(dataset)\n      if relation.is_a?(Relation::Composite)\n        relation.new(dataset).to_a\n      else\n        dataset\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args, &)", "start_line": 270, "end_line": 307}, "metadata": {"module": "ROM", "class_name": "Command", "class_signature": "class Command"}, "task_id": 404}
{"function_name": "apply_hooks", "file_path": "rom/core/lib/rom/command.rb", "focal_code": "def apply_hooks(hooks, tuples, *args)\n      hooks.reduce(tuples) do |a, e|\n        if e.is_a?(Hash)\n          hook_meth, hook_args = e.to_a.flatten(1)\n          __send__(hook_meth, a, *args, **hook_args)\n        else\n          __send__(e, a, *args)\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/initializer'\nrequire 'rom/pipeline'\n\nrequire 'rom/commands/class_interface'\nrequire 'rom/commands/composite'\nrequire 'rom/commands/graph'\nrequire 'rom/commands/lazy'\n\nmodule ROM\n  # Abstract command class\n  #\n  # Provides a constructor accepting relation with options and basic behavior\n  # for calling, currying and composing commands.\n  #\n  # Typically command subclasses should inherit from specialized\n  # Create/Update/Delete, not this one.\n  #\n  # @abstract\n  #\n  # @api public\n  class Command\n    extend Dry::Core::ClassAttributes\n    extend Initializer\n    extend ClassInterface\n\n    include Dry::Equalizer(:relation, :options)\n    include Commands\n    include Pipeline::Operator\n\n    # @!method self.adapter\n    #   Get or set adapter identifier\n    #\n    #   @overload adapter\n    #     Get adapter identifier\n    #\n    #     @example\n    #       ROM::Memory::Commands::Create.adapter\n    #       # => :memory\n    #\n    #     @return [Symbol]\n    #\n    #   @overload adapter(identifier)\n    #     Set adapter identifier. This must always match actual adapter identifier\n    #     that was used to register an adapter.\n    #\n    #     @example\n    #       module MyAdapter\n    #         class CreateCommand < ROM::Commands::Memory::Create\n    #           adapter :my_adapter\n    #         end\n    #       end\n    #\n    # @api public\n    defines :adapter\n\n    # @!method self.relation\n    #   Get or set relation identifier\n    #\n    #   @overload relation\n    #     Get relation identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         relation :users\n    #       end\n    #\n    #       CreateUser.relation\n    #       # => :users\n    #\n    #     @return [Symbol]\n    #\n    #   @overload relation(identifier)\n    #     Set relation identifier.\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         relation :users\n    #       end\n    #\n    # @api public\n    defines :relation\n\n    # @!method self.result\n    #   Get or set result type\n    #\n    #   @overload result\n    #     Get result type\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         result :one\n    #       end\n    #\n    #       CreateUser.result\n    #       # => :one\n    #\n    #     @return [Symbol]\n    #\n    #   @overload result(identifier)\n    #     Set result type\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         result :one\n    #       end\n    #\n    # @api public\n    defines :result\n\n    # @!method self.input\n    #   Get or set input processing function. This is typically set during setup\n    #   to relation's input_schema\n    #\n    #   @overload input\n    #     Get input processing function\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         input -> tuple { .. }\n    #       end\n    #\n    #       CreateUser.input\n    #       # Your custom function\n    #\n    #     @return [Proc,#call]\n    #\n    #   @overload input(identifier)\n    #     Set input processing function\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         input -> tuple { .. }\n    #       end\n    #\n    # @api public\n    defines :input\n\n    # @!method self.register_as\n    #   Get or set identifier that should be used to register a command in a container\n    #\n    #   @overload register_as\n    #     Get registration identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         register_as :create_user\n    #       end\n    #\n    #       CreateUser.register_as\n    #       # => :create_user\n    #\n    #     @return [Symbol]\n    #\n    #   @overload register_as(identifier)\n    #     Set registration identifier\n    #\n    #     @example\n    #       class CreateUser < ROM::Commands::Create[:memory]\n    #         register_as :create_user\n    #       end\n    #\n    # @api public\n    defines :register_as\n\n    # @!method self.restrictable\n    #   @overload restrictable\n    #     Check if a command class is restrictable\n    #\n    #     @example\n    #       class UpdateUser < ROM::Commands::Update[:memory]\n    #         restrictable true\n    #       end\n    #\n    #       CreateUser.restrictable\n    #       # => true\n    #\n    #     @return [FalseClass, TrueClass]\n    #\n    #   @overload restrictable(value)\n    #     Set if a command is restrictable\n    #\n    #     @example\n    #       class UpdateUser < ROM::Commands::Update[:memory]\n    #         restrictable true\n    #       end\n    #\n    # @api public\n    defines :restrictable\n\n    # @!attribute [r] relation\n    #   @return [Relation] Command's relation\n    param :relation\n\n    CommandType = Types::Strict::Symbol.enum(:create, :update, :delete)\n    Result = Types::Strict::Symbol.enum(:one, :many)\n\n    # @!attribute [r] type\n    #   @return [Symbol] The command type, one of :create, :update or :delete\n    option :type, type: CommandType, optional: true\n\n    # @!attribute [r] source\n    #   @return [Relation] The source relation\n    option :source, default: -> { relation }\n\n    # @!attribute [r] result\n    #   @return [Symbol] Result type, either :one or :many\n    option :result, type: Result\n\n    # @!attribute [r] input\n    #   @return [Proc, #call] Tuple processing function, typically uses Relation#input_schema\n    option :input\n\n    # @!attribute [r] curry_args\n    #   @return [Array] Curried args\n    option :curry_args, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] before\n    #   @return [Array<Hash>] An array with before hooks configuration\n    option :before, Types::Coercible::Array, reader: false, default: -> { self.class.before }\n\n    # @!attribute [r] after\n    #   @return [Array<Hash>] An array with after hooks configuration\n    option :after, Types::Coercible::Array, reader: false, default: -> { self.class.after }\n\n    input Hash\n    result :many\n\n    # Return name of this command's relation\n    #\n    # @return [ROM::Relation::Name]\n    #\n    # @api public\n    def name\n      relation.name\n    end\n\n    # Return gateway of this command's relation\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    def gateway\n      relation.gateway\n    end\n\n    # Execute the command\n    #\n    # @abstract\n    #\n    # @return [Array] an array with inserted tuples\n    #\n    # @api private\n    def execute(*)\n      raise(\n        ::NotImplementedError,\n        \"#{self.class}##{__method__} must be implemented\"\n      )\n    end\n\n    # Call the command and return one or many tuples\n    #\n    # This method will apply before/after hooks automatically\n    #\n    # @api public\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def call(*args, &)\n      tuples =\n        if hooks?\n          prepared =\n            if curried?\n              apply_hooks(before_hooks, *(curry_args + args))\n            else\n              apply_hooks(before_hooks, *args)\n            end\n\n          result =\n            if prepared\n              execute(prepared, &)\n            else\n              execute(&)\n            end\n\n          if curried?\n            if !args.empty?\n              apply_hooks(after_hooks, result, *args)\n            elsif curry_args.size > 1\n              apply_hooks(after_hooks, result, curry_args[1])\n            else\n              apply_hooks(after_hooks, result)\n            end\n          else\n            apply_hooks(after_hooks, result, *args.drop(1))\n          end\n        else\n          execute(*(curry_args + args), &)\n        end\n\n      if one?\n        tuples.first\n      else\n        tuples\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    alias_method :[], :call\n\n    # Curry this command with provided args\n    #\n    # Curried command can be called without args. If argument is a graph input processor,\n    # lazy command will be returned, which is used for handling nested input hashes.\n    #\n    # @return [Command, Lazy]\n    #\n    # @api public\n    def curry(*args)\n      if curry_args.empty? && args.first.is_a?(Graph::InputEvaluator)\n        Lazy[self].new(self, *args)\n      else\n        self.class.build(relation, **options, curry_args: args)\n      end\n    end\n\n    # Compose this command with other commands\n    #\n    # Composed commands can handle nested input\n    #\n    # @return [Command::Graph]\n    #\n    # @api public\n    def combine(*others) = Graph.new(self, others)\n\n    # Check if this command is curried\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api public\n    def curried? = !curry_args.empty?\n\n    # Return a new command with appended before hooks\n    #\n    # @param [Array<Hash>] hooks A list of before hooks configurations\n    #\n    # @return [Command]\n    #\n    # @api public\n    def before(*hooks)\n      self.class.new(relation, **options, before: before_hooks + hooks)\n    end\n\n    # Return a new command with appended after hooks\n    #\n    # @param [Array<Hash>] hooks A list of after hooks configurations\n    #\n    # @return [Command]\n    #\n    # @api public\n    def after(*hooks)\n      self.class.new(relation, **options, after: after_hooks + hooks)\n    end\n\n    # List of before hooks\n    #\n    # @return [Array]\n    #\n    # @api public\n    def before_hooks = options[:before]\n\n    # List of after hooks\n    #\n    # @return [Array]\n    #\n    # @api public\n    def after_hooks = options[:after]\n\n    # Return a new command with other source relation\n    #\n    # This can be used to restrict command with a specific relation\n    #\n    # @return [Command]\n    #\n    # @api public\n    def new(new_relation)\n      self.class.build(new_relation, **options, source: relation)\n    end\n\n    # Check if this command has any hooks\n    #\n    # @api private\n    def hooks? = !before_hooks.empty? || !after_hooks.empty?\n\n    # Check if this command is lazy\n    #\n    # @return [false]\n    #\n    # @api private\n    def lazy? = false\n\n    # Check if this command is a graph\n    #\n    # @return [false]\n    #\n    # @api private\n    def graph? = false\n\n    # Check if this command returns a single tuple\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def one? = result.equal?(:one)\n\n    # Check if this command returns many tuples\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def many? = result.equal?(:many)\n\n    # Check if this command is restrictible through relation\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api private\n    def restrictible? = self.class.restrictable.equal?(true)\n\n    # Yields tuples for insertion or return an enumerator\n    #\n    # @api private\n    def map_input_tuples(tuples, &mapper)\n      return enum_for(:with_input_tuples, tuples) unless mapper\n\n      if tuples.respond_to? :merge\n        mapper[tuples]\n      else\n        tuples.map(&mapper)\n      end\n    end\n\n    private\n\n    # Hook called by Pipeline to get composite class for commands\n    #\n    # @return [Class]\n    #\n    # @api private\n    def composite_class = Command::Composite\n\n    # Apply provided hooks\n    #\n    # Used by #call\n    #\n    # @return [Array<Hash>]\n    #\n    # @api private\n    def apply_hooks(hooks, tuples, *args)\n      hooks.reduce(tuples) do |a, e|\n        if e.is_a?(Hash)\n          hook_meth, hook_args = e.to_a.flatten(1)\n          __send__(hook_meth, a, *args, **hook_args)\n        else\n          __send__(e, a, *args)\n        end\n      end\n    end\n\n    # Pipes a dataset through command's relation\n    #\n    # @return [Array]\n    #\n    # @api private\n    def wrap_dataset(dataset)\n      if relation.is_a?(Relation::Composite)\n        relation.new(dataset).to_a\n      else\n        dataset\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "apply_hooks", "signature": "def apply_hooks(hooks, tuples, *args)", "start_line": 460, "end_line": 469}, "metadata": {"module": "ROM", "class_name": "Command", "class_signature": "class Command"}, "task_id": 405}
{"function_name": "call", "file_path": "rom/core/lib/rom/struct_compiler.rb", "focal_code": "def call(*args)\n      cache.fetch_or_store(args) do\n        name, header, ns = args\n        attributes = header.map(&method(:visit)).compact\n\n        if attributes.empty?\n          ROM::OpenStruct\n        else\n          build_class(name, ROM::Struct, ns) do |klass|\n            klass.attributes(attributes.to_h)\n          end\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/types'\nrequire 'rom/cache'\nrequire 'rom/struct'\nrequire 'rom/open_struct'\nrequire 'rom/attribute'\n\nmodule ROM\n  # @api private\n  class StructCompiler < Dry::Types::Compiler\n    extend Initializer\n\n    param :registry, default: -> { Dry::Types }\n    option :cache, default: -> { Cache.new }\n\n    # @api private\n    def initialize(*, **)\n      super\n      @cache = cache.namespaced(:structs)\n    end\n\n    # Build a struct class based on relation header ast\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args) do\n        name, header, ns = args\n        attributes = header.map(&method(:visit)).compact\n\n        if attributes.empty?\n          ROM::OpenStruct\n        else\n          build_class(name, ROM::Struct, ns) do |klass|\n            klass.attributes(attributes.to_h)\n          end\n        end\n      end\n    end\n    alias_method :[], :call\n\n    private\n\n    # @api private\n    def visit_relation(node)\n      _, header, meta = node\n      name = meta[:combine_name] || meta[:alias]\n      namespace = meta.fetch(:struct_namespace)\n\n      model = meta[:model] || call(name, header, namespace)\n\n      member =\n        if model < Dry::Struct\n          model\n        else\n          Dry::Types::Nominal.new(model).constructor(&model.method(:new))\n        end\n\n      if meta[:combine_type] == :many\n        [name, Types::Array.of(member)]\n      else\n        [name, member.optional]\n      end\n    end\n\n    # @api private\n    def visit_attribute(node)\n      name, type, meta = node\n\n      [meta[:alias] && !meta[:wrapped] ? meta[:alias] : name, visit(type).meta(meta)]\n    end\n\n    # @api private\n    def visit_constructor(node)\n      definition, * = node\n\n      visit(definition)\n    end\n\n    # @api private\n    def visit_constrained(node)\n      definition, = node\n\n      visit(definition)\n    end\n\n    # @api private\n    def visit_enum(node)\n      type_node, * = node\n      visit(type_node)\n    end\n\n    # @api private\n    def build_class(name, parent, ns, &)\n      Dry::Core::ClassBuilder\n        .new(name: class_name(name), parent: parent, namespace: ns)\n        .call(&)\n    end\n\n    # @api private\n    def class_name(name) = Inflector.classify(name)\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 29, "end_line": 42}, "metadata": {"module": "ROM", "class_name": "StructCompiler", "class_signature": "class StructCompiler < < Dry::Types::Compiler"}, "task_id": 406}
{"function_name": "visit_relation", "file_path": "rom/core/lib/rom/struct_compiler.rb", "focal_code": "def visit_relation(node)\n      _, header, meta = node\n      name = meta[:combine_name] || meta[:alias]\n      namespace = meta.fetch(:struct_namespace)\n\n      model = meta[:model] || call(name, header, namespace)\n\n      member =\n        if model < Dry::Struct\n          model\n        else\n          Dry::Types::Nominal.new(model).constructor(&model.method(:new))\n        end\n\n      if meta[:combine_type] == :many\n        [name, Types::Array.of(member)]\n      else\n        [name, member.optional]\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/types'\nrequire 'rom/cache'\nrequire 'rom/struct'\nrequire 'rom/open_struct'\nrequire 'rom/attribute'\n\nmodule ROM\n  # @api private\n  class StructCompiler < Dry::Types::Compiler\n    extend Initializer\n\n    param :registry, default: -> { Dry::Types }\n    option :cache, default: -> { Cache.new }\n\n    # @api private\n    def initialize(*, **)\n      super\n      @cache = cache.namespaced(:structs)\n    end\n\n    # Build a struct class based on relation header ast\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args) do\n        name, header, ns = args\n        attributes = header.map(&method(:visit)).compact\n\n        if attributes.empty?\n          ROM::OpenStruct\n        else\n          build_class(name, ROM::Struct, ns) do |klass|\n            klass.attributes(attributes.to_h)\n          end\n        end\n      end\n    end\n    alias_method :[], :call\n\n    private\n\n    # @api private\n    def visit_relation(node)\n      _, header, meta = node\n      name = meta[:combine_name] || meta[:alias]\n      namespace = meta.fetch(:struct_namespace)\n\n      model = meta[:model] || call(name, header, namespace)\n\n      member =\n        if model < Dry::Struct\n          model\n        else\n          Dry::Types::Nominal.new(model).constructor(&model.method(:new))\n        end\n\n      if meta[:combine_type] == :many\n        [name, Types::Array.of(member)]\n      else\n        [name, member.optional]\n      end\n    end\n\n    # @api private\n    def visit_attribute(node)\n      name, type, meta = node\n\n      [meta[:alias] && !meta[:wrapped] ? meta[:alias] : name, visit(type).meta(meta)]\n    end\n\n    # @api private\n    def visit_constructor(node)\n      definition, * = node\n\n      visit(definition)\n    end\n\n    # @api private\n    def visit_constrained(node)\n      definition, = node\n\n      visit(definition)\n    end\n\n    # @api private\n    def visit_enum(node)\n      type_node, * = node\n      visit(type_node)\n    end\n\n    # @api private\n    def build_class(name, parent, ns, &)\n      Dry::Core::ClassBuilder\n        .new(name: class_name(name), parent: parent, namespace: ns)\n        .call(&)\n    end\n\n    # @api private\n    def class_name(name) = Inflector.classify(name)\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_relation", "signature": "def visit_relation(node)", "start_line": 48, "end_line": 67}, "metadata": {"module": "ROM", "class_name": "StructCompiler", "class_signature": "class StructCompiler < < Dry::Types::Compiler"}, "task_id": 407}
{"function_name": "use", "file_path": "rom/core/lib/rom/configuration.rb", "focal_code": "def use(plugin, options = EMPTY_HASH)\n      if plugin.is_a?(::Array)\n        plugin.each { |p| use(p) }\n      elsif plugin.is_a?(::Hash)\n        plugin.to_a.each { |p| use(*p) }\n      else\n        ROM.plugin_registry[:configuration].fetch(plugin).apply_to(self, options)\n      end\n\n      self\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'forwardable'\n\nrequire 'rom/environment'\nrequire 'rom/setup'\nrequire 'rom/configuration_dsl'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  class Configuration\n    extend Forwardable\n    extend Notifications\n\n    register_event('configuration.relations.class.ready')\n    register_event('configuration.relations.object.registered')\n    register_event('configuration.relations.registry.created')\n    register_event('configuration.relations.schema.allocated')\n    register_event('configuration.relations.schema.set')\n    register_event('configuration.relations.dataset.allocated')\n    register_event('configuration.commands.class.before_build')\n\n    include ::ROM::ConfigurationDSL\n\n    NoDefaultAdapterError = ::Class.new(::StandardError)\n\n    # @!attribute [r] environment\n    #   @return [Environment] Environment object with gateways\n    attr_reader :environment\n\n    # @!attribute [r] setup\n    #   @return [Setup] Setup object which collects component classes and plugins\n    attr_reader :setup\n\n    # @!attribute [r] notifications\n    #   @return [Notifications] Notification bus instance\n    attr_reader :notifications\n\n    def_delegators :@setup, :register_relation, :register_command,\n                   :register_mapper, :register_plugin,\n                   :command_classes, :mapper_classes,\n                   :auto_registration\n\n    def_delegators :@environment, :gateways, :gateways_map, :configure, :config\n\n    # Initialize a new configuration\n    #\n    # @see Environment#initialize\n    #\n    # @return [Configuration]\n    #\n    # @api private\n    def initialize(*args)\n      @environment = Environment.new(*args)\n      @notifications = Notifications.event_bus(:configuration)\n      @setup = Setup.new(notifications)\n\n      yield self if block_given?\n    end\n\n    # Apply a plugin to the configuration\n    #\n    # @param [Mixed] plugin The plugin identifier, usually a Symbol\n    # @param [Hash] options Plugin options\n    #\n    # @return [Configuration]\n    #\n    # @api public\n    def use(plugin, options = EMPTY_HASH)\n      if plugin.is_a?(::Array)\n        plugin.each { |p| use(p) }\n      elsif plugin.is_a?(::Hash)\n        plugin.to_a.each { |p| use(*p) }\n      else\n        ROM.plugin_registry[:configuration].fetch(plugin).apply_to(self, options)\n      end\n\n      self\n    end\n\n    # Return gateway identified by name\n    #\n    # @return [Gateway]\n    #\n    # @api private\n    def [](name) = gateways.fetch(name)\n\n    # Hook for respond_to? used internally\n    #\n    # @api private\n    def respond_to?(name, ...) = gateways.key?(name) || super\n\n    # @api private\n    def default_gateway\n      @default_gateway ||= gateways[:default]\n    end\n\n    # @api private\n    def adapter_for_gateway(gateway)\n      ROM.adapters.select do |_key, value|\n        value.const_defined?(:Gateway) && gateway.is_a?(value.const_get(:Gateway))\n      end.keys.first\n    end\n\n    # @api private\n    def relation_classes(gateway = nil)\n      if gateway\n        gw_name = gateway.is_a?(Symbol) ? gateway : gateways_map[gateway]\n        setup.relation_classes.select { |rel| rel.gateway == gw_name }\n      else\n        setup.relation_classes\n      end\n    end\n\n    # @api private\n    def default_adapter\n      @default_adapter ||= adapter_for_gateway(default_gateway) || ROM.adapters.keys.first\n    end\n\n    private\n\n    # @api private\n    def respond_to_missing?(name, ...) = gateways.key?(name) || super\n\n    # Returns gateway if method is a name of a registered gateway\n    #\n    # @return [Gateway]\n    #\n    # @api private\n    def method_missing(name, ...) = gateways.fetch(name) { super }\n  end\nend\n", "language": "ruby", "function_component": {"name": "use", "signature": "def use(plugin, options = EMPTY_HASH)", "start_line": 69, "end_line": 79}, "metadata": {"module": "ROM", "class_name": "Configuration", "class_signature": "class Configuration"}, "task_id": 408}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/auto_curry.rb", "focal_code": "def initialize(name, arity, &block)\n        define_method(name) do |*args, **kwargs, &mblock|\n          kwargs_size =\n            if kwargs.empty?\n              0\n            else\n              1\n            end\n\n          response =\n            if arity.negative? || arity.eql?(args.size + kwargs_size)\n              super(*args, **kwargs, &mblock)\n            else\n              self.class.curried.new(self, view: name, curry_args: args, arity: arity)\n            end\n\n          if block\n            response.instance_exec(&block)\n          else\n            response\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # Relation extension which provides auto-currying of relation view methods\n  #\n  # @api private\n  module AutoCurry\n    # @api private\n    class Wrapper < ::Module\n      def initialize(name, arity, &block)\n        define_method(name) do |*args, **kwargs, &mblock|\n          kwargs_size =\n            if kwargs.empty?\n              0\n            else\n              1\n            end\n\n          response =\n            if arity.negative? || arity.eql?(args.size + kwargs_size)\n              super(*args, **kwargs, &mblock)\n            else\n              self.class.curried.new(self, view: name, curry_args: args, arity: arity)\n            end\n\n          if block\n            response.instance_exec(&block)\n          else\n            response\n          end\n        end\n      end\n    end\n\n    def self.extended(klass)\n      klass.define_singleton_method(:method_added) do |name|\n        return if auto_curry_busy?\n\n        auto_curry_guard { auto_curry(name) }\n        super(name)\n      end\n    end\n\n    # @api private\n    def auto_curry_guard\n      @__auto_curry_busy__ = true\n      yield\n    ensure\n      @__auto_curry_busy__ = false\n    end\n\n    # @api private\n    def auto_curry_busy?\n      @__auto_curry_busy__ ||= false\n    end\n\n    # @api private\n    def auto_curried_methods\n      @__auto_curried_methods__ ||= Set.new\n    end\n\n    # Auto-curry a method\n    #\n    # @param [Symbol] name The name of a method\n    #\n    # @api private\n    def auto_curry(name, &)\n      arity = instance_method(name).arity\n\n      if public_instance_methods.include?(name) && arity != 0\n        mod = Wrapper.new(name, arity, &)\n\n        auto_curried_methods << name\n\n        prepend(mod)\n      else\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(name, arity, &block)", "start_line": 10, "end_line": 32}, "metadata": {"module": "ROM", "class_name": "Wrapper", "class_signature": "class Wrapper < < ::Module"}, "task_id": 409}
{"function_name": "auto_curry", "file_path": "rom/core/lib/rom/auto_curry.rb", "focal_code": "def auto_curry(name, &)\n      arity = instance_method(name).arity\n\n      if public_instance_methods.include?(name) && arity != 0\n        mod = Wrapper.new(name, arity, &)\n\n        auto_curried_methods << name\n\n        prepend(mod)\n      else\n        self\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # Relation extension which provides auto-currying of relation view methods\n  #\n  # @api private\n  module AutoCurry\n    # @api private\n    class Wrapper < ::Module\n      def initialize(name, arity, &block)\n        define_method(name) do |*args, **kwargs, &mblock|\n          kwargs_size =\n            if kwargs.empty?\n              0\n            else\n              1\n            end\n\n          response =\n            if arity.negative? || arity.eql?(args.size + kwargs_size)\n              super(*args, **kwargs, &mblock)\n            else\n              self.class.curried.new(self, view: name, curry_args: args, arity: arity)\n            end\n\n          if block\n            response.instance_exec(&block)\n          else\n            response\n          end\n        end\n      end\n    end\n\n    def self.extended(klass)\n      klass.define_singleton_method(:method_added) do |name|\n        return if auto_curry_busy?\n\n        auto_curry_guard { auto_curry(name) }\n        super(name)\n      end\n    end\n\n    # @api private\n    def auto_curry_guard\n      @__auto_curry_busy__ = true\n      yield\n    ensure\n      @__auto_curry_busy__ = false\n    end\n\n    # @api private\n    def auto_curry_busy?\n      @__auto_curry_busy__ ||= false\n    end\n\n    # @api private\n    def auto_curried_methods\n      @__auto_curried_methods__ ||= Set.new\n    end\n\n    # Auto-curry a method\n    #\n    # @param [Symbol] name The name of a method\n    #\n    # @api private\n    def auto_curry(name, &)\n      arity = instance_method(name).arity\n\n      if public_instance_methods.include?(name) && arity != 0\n        mod = Wrapper.new(name, arity, &)\n\n        auto_curried_methods << name\n\n        prepend(mod)\n      else\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "auto_curry", "signature": "def auto_curry(name, &)", "start_line": 67, "end_line": 79}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 410}
{"function_name": "[]", "file_path": "rom/core/lib/rom/command_registry.rb", "focal_code": "def [](*args)\n      if args.size.equal?(1)\n        command = super\n        mapper = options[:mapper]\n\n        if mapper\n          command.curry >> mapper\n        else\n          command\n        end\n      else\n        cache.fetch_or_store(args.hash) { compiler.(*args) }\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'concurrent/map'\n\nrequire 'rom/constants'\nrequire 'rom/registry'\n\nmodule ROM\n  # Specialized registry class for commands\n  #\n  # @api public\n  class CommandRegistry < Registry\n    # Internal command registry\n    #\n    # @return [Registry]\n    #\n    # @api private\n    param :elements\n\n    # @!attribute [r] relation_name\n    #   @return [Relation::Name] The name of a relation\n    option :relation_name\n\n    # @!attribute [r] mappers\n    #   @return [MapperRegistry] Optional mapper registry\n    option :mappers, optional: true\n\n    # @!attribute [r] mapper\n    #   @return [Object#call] Default mapper for processing command results\n    option :mapper, optional: true\n\n    # @!attribute [r] compiler\n    #   @return [CommandCompiler] A command compiler instance\n    option :compiler, optional: true\n\n    # @api private\n    def self.element_not_found_error = CommandNotFoundError\n\n    # Return a command from the registry\n    #\n    # If mapper is set command will be turned into a composite command with\n    # auto-mapping\n    #\n    # @overload [](name)\n    #   @param [Symbol] name The command identifier from the registry\n    #   @example\n    #     create_user = rom.commands[:users][:create]\n    #     create_user[name: 'Jane']\n    #\n    #     # with mapping, assuming :entity mapper is registered for :users relation\n    #     create_user = rom.commands[:users].map_with(:entity)[:create]\n    #     create_user[name: 'Jane'] # => result is sent through :entity mapper\n    #\n    # @overload [](*args)\n    #   @param [Array] *args {CommandCompiler} arguments\n    #   @see CommandCompiler#call\n    #\n    # @return [Command,Command::Composite]\n    #\n    # @api public\n    def [](*args)\n      if args.size.equal?(1)\n        command = super\n        mapper = options[:mapper]\n\n        if mapper\n          command.curry >> mapper\n        else\n          command\n        end\n      else\n        cache.fetch_or_store(args.hash) { compiler.(*args) }\n      end\n    end\n\n    # Specify a mapper that should be used for commands from this registry\n    #\n    # @example\n    #   entity_commands = rom.commands[:users].map_with(:entity)\n    #\n    #\n    # @param [Symbol] mapper_name The name of a registered mapper\n    #\n    # @return [CommandRegistry]\n    #\n    # @api public\n    def map_with(mapper_name) = with(mapper: mappers[mapper_name])\n\n    # @api private\n    def set_compiler(compiler) # rubocop:disable Naming/AccessorMethodName\n      options[:compiler] = @compiler = compiler\n    end\n\n    # @api private\n    def set_mappers(mappers) # rubocop:disable Naming/AccessorMethodName\n      options[:mappers] = @mappers = mappers\n    end\n\n    private\n\n    # Allow checking if a certain command is available using dot-notation\n    #\n    # @api private\n    def respond_to_missing?(name, include_private = false)\n      key?(name) || super\n    end\n\n    # Allow retrieving commands using dot-notation\n    #\n    # @api private\n    def method_missing(name, *)\n      if key?(name)\n        self[name]\n      else\n        super\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "[]", "signature": "def [](*args)", "start_line": 61, "end_line": 74}, "metadata": {"module": "ROM", "class_name": "CommandRegistry", "class_signature": "class CommandRegistry < < Registry"}, "task_id": 411}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/model_builder.rb", "focal_code": "def initialize(options = {})\n      @name = options[:name]\n\n      if name\n        parts = name.split('::')\n\n        @const_name = parts.pop\n\n        @namespace =\n          if parts.any?\n            Inflector.constantize(parts.join('::'))\n          else\n            ::Object\n          end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nmodule ROM\n  # Model builders can be used to build model classes for mappers\n  #\n  # This is used when you define a mapper and setup a model using :name option.\n  #\n  # @example\n  #   # this will define User model for you\n  #   class UserMapper < ROM::Mapper\n  #     model name: 'User'\n  #     attribute :id\n  #     attribute :name\n  #   end\n  #\n  # @private\n  class ModelBuilder\n    attr_reader :name\n\n    attr_reader :const_name\n\n    attr_reader :namespace\n\n    attr_reader :klass\n\n    # Return model builder subclass based on type\n    #\n    # @param [Symbol] type\n    #\n    # @return [Class]\n    #\n    # @api private\n    def self.[](type)\n      case type\n      when :poro then PORO\n      else\n        raise ::ArgumentError, \"#{type.inspect} is not a supported model type\"\n      end\n    end\n\n    # Build a model class\n    #\n    # @return [Class]\n    #\n    # @api private\n    def self.call(*args) = new(*args).call\n\n    # @api private\n    def initialize(options = {})\n      @name = options[:name]\n\n      if name\n        parts = name.split('::')\n\n        @const_name = parts.pop\n\n        @namespace =\n          if parts.any?\n            Inflector.constantize(parts.join('::'))\n          else\n            ::Object\n          end\n      end\n    end\n\n    # Define a model class constant\n    #\n    # @api private\n    def define_const = namespace.const_set(const_name, klass)\n\n    # Build a model class supporting specific attributes\n    #\n    # @return [Class]\n    #\n    # @api private\n    def call(attrs)\n      define_class(attrs)\n      define_const if const_name\n      @klass\n    end\n\n    # PORO model class builder\n    #\n    # @private\n    class PORO < ModelBuilder\n      def define_class(attrs)\n        @klass = ::Class.new\n\n        @klass.attr_reader(*attrs)\n\n        @klass.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n          def initialize(params)                                             # def initialize(params)\n            #{attrs.map { |name| \"@#{name} = params[:#{name}]\" }.join(\"\\n\")} #   @name = params[:name]\n          end                                                                # end\n        RUBY\n\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(options = {})", "start_line": 51, "end_line": 66}, "metadata": {"module": "ROM", "class_name": "ModelBuilder", "class_signature": "class ModelBuilder"}, "task_id": 412}
{"function_name": "method_missing", "file_path": "rom/core/lib/rom/attribute.rb", "focal_code": "def method_missing(meth, ...)\n      if type.respond_to?(meth)\n        response = type.__send__(meth, ...)\n\n        if response.is_a?(type.class)\n          self.class.new(response, **options)\n        else\n          response\n        end\n      else\n        super\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/initializer'\nrequire 'rom/support/memoizable'\nrequire 'rom/types'\n\nmodule ROM\n  # Schema attributes provide meta information about types and an API\n  # for additional operations. This class can be extended by adapters to provide\n  # database-specific features. In example rom-sql provides SQL::Attribute\n  # with more features like creating SQL expressions for queries.\n  #\n  # Schema attributes are accessible through canonical relation schemas and\n  # instance-level schemas.\n  #\n  # @api public\n  class Attribute\n    include Dry::Equalizer(:type, :options)\n    include Memoizable\n\n    extend Initializer\n\n    META_OPTIONS = %i[primary_key foreign_key source target relation].freeze\n\n    # @!attribute [r] type\n    #   @return [Dry::Types::Nominal, Dry::Types::Sum, Dry::Types::Constrained] The attribute's\n    #                                                                           type object\n    param :type\n\n    # @!attribute [r] name\n    #\n    # Return the canonical name of this attribute name\n    #\n    # This *always* returns the name that is used in the datastore, even when\n    # an attribute is aliased\n    #\n    # @example\n    #   class Users < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :user_id, Types::Integer, alias: :id\n    #       attribute :email, Types::String\n    #     end\n    #   end\n    #\n    #   users[:user_id].name\n    #   # => :user_id\n    #\n    #   users[:email].name\n    #   # => :email\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    option :name, optional: true, type: Types::Strict::Symbol\n\n    # @!attribute [r] type\n    #   @return [Symbol, nil] Alias to use instead of attribute name\n    option :alias, optional: true, type: Types::Strict::Symbol.optional\n\n    # @api private\n    def [](value = Undefined)\n      type[value]\n    end\n\n    # Return true if this attribute type is a primary key\n    #\n    # @example\n    #   class Users < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :id, Types::Integer\n    #       attribute :name, Types::String\n    #\n    #       primary_key :id\n    #     end\n    #   end\n    #\n    #   Users.schema[:id].primary_key?\n    #   # => true\n    #\n    #   Users.schema[:name].primary_key?\n    #   # => false\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api public\n    def primary_key? = meta[:primary_key].equal?(true)\n\n    # Return true if this attribute type is a foreign key\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :id, Types::Integer\n    #       attribute :user_id, Types.ForeignKey(:users)\n    #     end\n    #   end\n    #\n    #   Users.schema[:user_id].foreign_key?\n    #   # => true\n    #\n    #   Users.schema[:id].foreign_key?\n    #   # => false\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api public\n    def foreign_key? = meta[:foreign_key].equal?(true)\n\n    # Return true if this attribute has a configured alias\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :user_id, Types::Integer, alias: :id\n    #       attribute :name, Types::String\n    #     end\n    #   end\n    #\n    #   Users.schema[:user_id].aliased?\n    #   # => true\n    #\n    #   Users.schema[:name].aliased?\n    #   # => false\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api public\n    def aliased? = !self.alias.nil?\n\n    # Return source relation of this attribute type\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :id, Types::Integer\n    #       attribute :user_id, Types.ForeignKey(:users)\n    #     end\n    #   end\n    #\n    #   Users.schema[:id].source\n    #   # => :tasks\n    #\n    #   Users.schema[:user_id].source\n    #   # => :tasks\n    #\n    # @return [Symbol, Relation::Name]\n    #\n    # @api public\n    def source = meta[:source]\n\n    # Return target relation of this attribute type\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :id, Types::Integer\n    #       attribute :user_id, Types.ForeignKey(:users)\n    #     end\n    #   end\n    #\n    #   Users.schema[:id].target\n    #   # => nil\n    #\n    #   Users.schema[:user_id].target\n    #   # => :users\n    #\n    # @return [NilClass, Symbol, Relation::Name]\n    #\n    # @api public\n    def target = meta[:target]\n\n    # Return tuple key\n    #\n    # When schemas are projected with aliased attributes, we need a simple access to tuple keys\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :user_id, Types::Integer, alias: :id\n    #       attribute :name, Types::String\n    #     end\n    #   end\n    #\n    #   Users.schema[:id].key\n    #   # :id\n    #\n    #   Users.schema.project(Users.schema[:id].aliased(:user_id)).key\n    #   # :user_id\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    def key = self.alias || name\n\n    # Return new attribute type with provided alias\n    #\n    # @example\n    #   class Tasks < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :user_id, Types::Integer\n    #       attribute :name, Types::String\n    #     end\n    #   end\n    #\n    #   aliased_user_id = Users.schema[:user_id].aliased(:id)\n    #\n    #   aliased_user_id.aliased?\n    #   # => true\n    #\n    #   aliased_user_id.name\n    #   # => :user_id\n    #\n    #   aliased_user_id.alias\n    #   # => :id\n    #\n    # @param [Symbol] name The alias\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def aliased(name) = with(alias: name)\n    alias_method :as, :aliased\n\n    # Return new attribute type with an alias using provided prefix\n    #\n    # @example\n    #   class Users < ROM::Relation[:memory]\n    #     schema do\n    #       attribute :id, Types::Integer\n    #       attribute :name, Types::String\n    #     end\n    #   end\n    #\n    #   prefixed_id = Users.schema[:id].prefixed\n    #\n    #   prefixed_id.aliased?\n    #   # => true\n    #\n    #   prefixed_id.name\n    #   # => :id\n    #\n    #   prefixed_id.alias\n    #   # => :users_id\n    #\n    #   prefixed_id = Users.schema[:id].prefixed(:user)\n    #\n    #   prefixed_id.alias\n    #   # => :user_id\n    #\n    # @param [Symbol] prefix The prefix (defaults to source.dataset)\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def prefixed(prefix = source.dataset)\n      aliased(:\"#{prefix}_#{name}\")\n    end\n\n    # Return if the attribute type is from a wrapped relation\n    #\n    # Wrapped attributes are used when two schemas from different relations\n    # are merged together. This way we can identify them easily and handle\n    # correctly in places like auto-mapping.\n    #\n    # @api public\n    def wrapped? = meta[:wrapped].equal?(true)\n\n    # Return attribute type wrapped for the specified relation name\n    #\n    # @param [Symbol] name The name of the source relation (defaults to source.dataset)\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def wrapped(name = source.dataset)\n      prefixed(name).meta(wrapped: true)\n    end\n\n    # Return attribute type with additional meta information\n    #\n    # Return meta information hash if no opts are provided\n    #\n    # @param [Hash] opts The meta options\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def meta(opts = nil)\n      if opts\n        self.class.new(type.meta(opts), **options)\n      else\n        type.meta\n      end\n    end\n\n    # Return string representation of the attribute type\n    #\n    # @return [String]\n    #\n    # @api public\n    def inspect\n      opts = options.reject { |k| %i[type name].include?(k) }\n      meta_and_opts = meta.merge(opts).map { |k, v| \"#{k}=#{v.inspect}\" }\n      %(#<#{self.class}[#{type.name}] name=#{name.inspect} #{meta_and_opts.join(' ')}>)\n    end\n    alias_method :pretty_inspect, :inspect\n\n    # Check if the attribute type is equal to another\n    #\n    # @param [Dry::Type, Attribute] other\n    #\n    # @return [TrueClass,FalseClass]\n    #\n    # @api public\n    def eql?(other)\n      other.is_a?(self.class) ? super : type.eql?(other)\n    end\n\n    # Return if this attribute type has additional attribute type for reading\n    # tuple values\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api private\n    def read? = !meta[:read].nil?\n\n    # Return read type\n    #\n    # @return [Dry::Types::Type]\n    #\n    # @api private\n    def to_read_type = read? ? meta[:read] : type\n\n    # Return write type\n    #\n    # @return [Dry::Types::Type]\n    #\n    # @api private\n    def to_write_type = type\n\n    # Return nullable attribute\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def optional\n      sum = self.class.new(super, **options)\n      if read?\n        sum.meta(read: meta[:read].optional)\n      else\n        sum\n      end\n    end\n\n    # @api private\n    def respond_to_missing?(name, include_private = false)\n      type.respond_to?(name) || super\n    end\n\n    # Return AST for the type\n    #\n    # @return [Array]\n    #\n    # @api public\n    def to_ast\n      [:attribute, [name, type.to_ast(meta: false), meta_options_ast]]\n    end\n\n    # Return AST for the read type\n    #\n    # @return [Array]\n    #\n    # @api public\n    def to_read_ast\n      [:attribute, [name, to_read_type.to_ast(meta: false), meta_options_ast]]\n    end\n\n    # @api private\n    def meta_options_ast\n      keys = %i[wrapped primary_key alias]\n      ast = meta.merge(options).select { |k, _| keys.include?(k) }\n      ast[:source] = source.to_sym if source\n      ast\n    end\n\n    memoize :to_ast, :to_read_ast, :meta_options_ast\n\n    private\n\n    # @api private\n    def method_missing(meth, ...)\n      if type.respond_to?(meth)\n        response = type.__send__(meth, ...)\n\n        if response.is_a?(type.class)\n          self.class.new(response, **options)\n        else\n          response\n        end\n      else\n        super\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(meth, ...)", "start_line": 391, "end_line": 403}, "metadata": {"module": "ROM", "class_name": "Attribute", "class_signature": "class Attribute"}, "task_id": 413}
{"function_name": "[]", "file_path": "rom/core/lib/rom/schema.rb", "focal_code": "def [](key, src = name.to_sym)\n      attr =\n        if count_index[key].equal?(1)\n          name_index[key]\n        else\n          source_index[src][key]\n        end\n\n      raise(KeyError, \"#{key.inspect} attribute doesn't exist in #{src} schema\") unless attr\n\n      attr\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/constants'\nrequire 'rom/attribute'\nrequire 'rom/schema/dsl'\nrequire 'rom/schema/inferrer'\nrequire 'rom/association_set'\nrequire 'rom/support/notifications'\nrequire 'rom/support/memoizable'\n\nmodule ROM\n  # Relation schema\n  #\n  # Schemas hold detailed information about relation tuples, including their\n  # primitive types (String, Integer, Hash, etc. or custom classes), as well as\n  # various meta information like primary/foreign key and literally any other\n  # information that a given database adapter may need.\n  #\n  # Adapters can extend this class and it can be used in adapter-specific relations.\n  # In example rom-sql extends schema with Association DSL and many additional\n  # SQL-specific APIs in schema types.\n  #\n  # Schemas are used for projecting canonical relations into other relations and\n  # every relation object maintains its schema. This means that we always have\n  # all information about relation tuples, even when a relation was projected and\n  # diverged from its canonical form.\n  #\n  # Furthermore schema attributes know their source relations, which makes it\n  # possible to merge schemas from multiple relations and maintain information\n  # about the source relations. In example when two relations are joined, their\n  # schemas are merged, and we know which attributes belong to which relation.\n  #\n  # @api public\n  # rubocop:disable Metrics/ClassLength\n  class Schema\n    include Memoizable\n\n    extend Notifications::Listener\n\n    subscribe('configuration.relations.registry.created') do |event|\n      registry = event[:registry]\n\n      registry.each_value do |relation|\n        unless relation.schema.frozen?\n          relation.schema.finalize_associations!(relations: registry)\n          relation.schema.finalize!\n        end\n      end\n    end\n\n    subscribe('configuration.relations.schema.allocated') do |event|\n      schema = event[:schema]\n      registry = event[:registry]\n      gateway = event[:gateway]\n\n      unless schema.frozen?\n        schema.finalize_attributes!(gateway: gateway, relations: registry)\n        schema.set!(:relations, registry)\n      end\n    end\n\n    EMPTY_ASSOCIATION_SET = AssociationSet.build(EMPTY_HASH).freeze\n\n    DEFAULT_INFERRER = Inferrer.new(enabled: false).freeze\n\n    type_transformation = lambda do |key|\n      k = if key.default?\n            key.constructor { |value| value.nil? ? Undefined : value }\n          else\n            key\n          end\n      k.required(false)\n    end\n\n    HASH_SCHEMA = Types::Coercible::Hash\n      .schema(EMPTY_HASH)\n      .with_type_transform(type_transformation)\n\n    extend Initializer\n\n    include Dry::Equalizer(:name, :attributes, :associations)\n    include Enumerable\n\n    # @!attribute [r] name\n    #   @return [Symbol] The name of this schema\n    param :name\n\n    # @!attribute [r] attributes\n    #   @return [Array] Array with schema attributes\n    option :attributes, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] associations\n    #   @return [AssociationSet] Optional association set (this is adapter-specific)\n    option :associations, default: -> { EMPTY_ASSOCIATION_SET }\n\n    # @!attribute [r] inferrer\n    #   @return [#call] An optional inferrer object used in `finalize!`\n    option :inferrer, default: -> { DEFAULT_INFERRER }\n\n    # @api private\n    option :relations, default: -> { EMPTY_HASH }\n\n    # @!attribute [r] canonical\n    #   @return [Symbol] The canonical schema which is carried in all schema instances\n    option :canonical, default: -> { self }\n\n    # @api private\n    option :attr_class, default: -> { Attribute }\n\n    # @!attribute [r] primary_key_name\n    #   @return [Symbol] The name of the primary key. This is set because in\n    #                    most of the cases relations don't have composite pks\n    option :primary_key_name, optional: true\n\n    # @!attribute [r] primary_key_names\n    #   @return [Array<Symbol>] A list of all pk names\n    option :primary_key_names, optional: true\n\n    alias_method :to_ary, :attributes\n\n    # Define a relation schema from plain rom types and optional options\n    #\n    # Resulting schema will decorate plain rom types with adapter-specific types\n    # By default `Attribute` will be used\n    #\n    # @param [Relation::Name, Symbol] name The schema name, typically ROM::Relation::Name\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def self.define(name, attributes: EMPTY_ARRAY, attr_class: Attribute, **options)\n      new(\n        name,\n        attr_class: attr_class,\n        attributes: attributes(attributes, attr_class),\n        **options\n      ) { |schema| yield(schema) if block_given? }\n    end\n\n    # Builds a representation of the information needed to create an\n    # attribute.\n    #\n    # This representation is consumed by `Schema.define` in order to create\n    # the actual attributes.\n    #\n    # @return [Hash] A hash with `:type` and `:options` keys.\n    #\n    # @api private\n    def self.build_attribute_info(type, **options)\n      {\n        type: type,\n        options: options\n      }\n    end\n\n    # @api private\n    def self.attributes(attributes, attr_class)\n      attributes.map do |attr|\n        attr_class.new(attr[:type], **attr.fetch(:options))\n      end\n    end\n\n    # @api private\n    def initialize(*, **)\n      super\n\n      yield(self) if block_given?\n    end\n\n    # Abstract method for creating a new relation based on schema definition\n    #\n    # This can be used by views to generate a new relation automatically.\n    # In example a schema can project a relation, join any additional relations\n    # if it includes attributes from other relations etc.\n    #\n    # Default implementation is a no-op and it simply returns back untouched relation\n    #\n    # @param [Relation] relation\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def call(relation) = relation\n\n    # Iterate over schema's attributes\n    #\n    # @yield [Attribute]\n    #\n    # @api public\n    def each(&) = attributes.each(&)\n\n    # Check if schema has any attributes\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api public\n    def empty? = attributes.empty?\n\n    # Coerce schema into a <AttributeName=>Attribute> Hash\n    #\n    # @return [Hash]\n    #\n    # @api public\n    def to_h\n      if block_given?\n        super\n      else\n        super { [_1.name, _1] }\n      end\n    end\n\n    # Return attribute\n    #\n    # @param [Symbol] key The attribute name\n    # @param [Symbol, Relation::Name] src The source relation (for merged schemas)\n    #\n    # @raise KeyError\n    #\n    # @api public\n    def [](key, src = name.to_sym)\n      attr =\n        if count_index[key].equal?(1)\n          name_index[key]\n        else\n          source_index[src][key]\n        end\n\n      raise(KeyError, \"#{key.inspect} attribute doesn't exist in #{src} schema\") unless attr\n\n      attr\n    end\n\n    # Project a schema to include only specified attributes\n    #\n    # @param [*Array<Symbol, Attribute>] names Attribute names\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def project(*names)\n      new(names.map { |name| name.is_a?(Symbol) ? self[name] : name })\n    end\n\n    # Exclude provided attributes from a schema\n    #\n    # @param [*Array] names Attribute names\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def exclude(*names) = project(*(map(&:name) - names))\n\n    # Project a schema with renamed attributes\n    #\n    # @param [Hash] mapping The attribute mappings\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def rename(mapping)\n      new_attributes = map do |attr|\n        alias_name = mapping[attr.name]\n        alias_name ? attr.aliased(alias_name) : attr\n      end\n\n      new(new_attributes)\n    end\n\n    # Project a schema with renamed attributes using provided prefix\n    #\n    # @param [Symbol] prefix The name of the prefix\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def prefix(prefix)\n      new(map { |attr| attr.prefixed(prefix) })\n    end\n\n    # Return new schema with all attributes marked as prefixed and wrapped\n    #\n    # This is useful when relations are joined and the right side should be marked\n    # as wrapped\n    #\n    # @param [Symbol] prefix The prefix used for aliasing wrapped attributes\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def wrap(prefix = name.dataset)\n      new(map { |attr| attr.wrapped? ? attr : attr.wrapped(prefix) })\n    end\n\n    # Return FK attribute for a given relation name\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def foreign_key(relation)\n      detect { |attr| attr.foreign_key? && attr.target == relation }\n    end\n\n    # Return primary key attributes\n    #\n    # @return [Array<Attribute>]\n    #\n    # @api public\n    def primary_key = select(&:primary_key?)\n\n    # Merge with another schema\n    #\n    # @param [Schema] other Other schema\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def merge(other) = append(*other)\n    alias_method :+, :merge\n\n    # Append more attributes to the schema\n    #\n    # This returns a new schema instance\n    #\n    # @param [Array<Attribute>] new_attributes\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def append(*new_attributes)\n      new(attributes + new_attributes)\n    end\n\n    # Return a new schema with uniq attributes\n    #\n    # @return [Schema]\n    #\n    # @api public\n    def uniq(&)\n      if block_given?\n        new(attributes.uniq(&))\n      else\n        new(attributes.uniq(&:name))\n      end\n    end\n\n    # Return if a schema includes an attribute with the given name\n    #\n    # @param [Symbol] name The name of the attribute\n    #\n    # @return [Boolean]\n    #\n    # @api public\n    def key?(name)\n      !attributes.detect { |attr| attr.name == name }.nil?\n    end\n\n    # Return if a schema is canonical\n    #\n    # @return [Boolean]\n    #\n    # @api public\n    def canonical? = equal?(canonical)\n\n    # Finalize a schema\n    #\n    # @return [self]\n    #\n    # @api private\n    def finalize!(**_opts)\n      return self if frozen?\n\n      freeze\n    end\n\n    # This hook is called when relation is being build during container finalization\n    #\n    # When block is provided it'll be called just before freezing the instance\n    # so that additional ivars can be set\n    #\n    # @return [self]\n    #\n    # @api private\n    def finalize_attributes!(gateway: nil, **)\n      inferrer.(self, gateway).each { |key, value| set!(key, value) }\n\n      yield if block_given?\n\n      initialize_primary_key_names\n\n      self\n    end\n\n    # Finalize associations defined in a schema\n    #\n    # @param [RelationRegistry] relations\n    #\n    # @return [self]\n    #\n    # @api private\n    def finalize_associations!(**)\n      set!(:associations, yield) if associations.any?\n      self\n    end\n\n    # Return coercion function using attribute read types\n    #\n    # This is used for `output_schema` in relations\n    #\n    # @return [Dry::Types::Hash]\n    #\n    # @api private\n    def to_output_hash\n      HASH_SCHEMA.schema(\n        to_h { |attr| [attr.key, attr.to_read_type] }\n      )\n    end\n\n    # Return coercion function using attribute types\n    #\n    # This is used for `input_schema` in relations, typically commands use it\n    # for processing input\n    #\n    # @return [Dry::Types::Hash]\n    #\n    # @api private\n    def to_input_hash\n      HASH_SCHEMA.schema(\n        to_h { |attr| [attr.name, attr.to_write_type] }\n      )\n    end\n\n    # Return AST for the schema\n    #\n    # @return [Array]\n    #\n    # @api public\n    def to_ast = [:schema, [name, attributes.map(&:to_ast)]]\n\n    # @api private\n    def set!(key, value)\n      instance_variable_set(\"@#{key}\", value)\n      options[key] = value\n    end\n\n    private\n\n    # @api private\n    def count_index\n      to_h { |attr| [attr.name, count { |a| a.name.eql?(attr.name) }] }\n    end\n\n    # @api private\n    def name_index = to_h { |attr| [attr.name, attr] }\n\n    # @api private\n    def source_index\n      select(&:source)\n        .group_by(&:source)\n        .to_h { |src, grp| [src.to_sym, grp.to_h { |attr| [attr.name, attr] }] }\n    end\n\n    # @api private\n    def new(attributes)\n      self.class.new(name, **options, attributes: attributes)\n    end\n\n    # @api private\n    def initialize_primary_key_names\n      return if primary_key.empty?\n\n      set!(:primary_key_name, primary_key[0].name)\n      set!(:primary_key_names, primary_key.map(&:name))\n    end\n\n    memoize :count_index, :name_index, :source_index, :to_ast, :to_input_hash, :to_output_hash\n  end\n  # rubocop:enable Metrics/ClassLength\nend\n", "language": "ruby", "function_component": {"name": "[]", "signature": "def [](key, src = name.to_sym)", "start_line": 220, "end_line": 231}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 414}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/create_container.rb", "focal_code": "def initialize(*args, &)\n      case args.first\n      when Configuration\n        environment = args.first.environment\n        setup = args.first.setup\n      when Environment\n        environment = args.first\n        setup = args[1]\n      else\n        configuration = Configuration.new(*args, &)\n        environment = configuration.environment\n        setup = configuration.setup\n      end\n\n      super(environment, setup)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/configuration'\nrequire 'rom/environment'\nrequire 'rom/setup'\nrequire 'rom/setup/finalize'\n\nmodule ROM\n  # @api private\n  class CreateContainer\n    # @api private\n    attr_reader :container\n\n    # @api private\n    def initialize(environment, setup)\n      @container = finalize(environment, setup)\n    end\n\n    private\n\n    # @api private\n    def finalize(environment, setup)\n      environment.configure do |config|\n        environment.gateways.each_key do |key|\n          gateway_config = config.gateways[key]\n          gateway_config.infer_relations = true unless gateway_config.key?(:infer_relations)\n        end\n      end\n\n      finalize = Finalize.new(\n        gateways: environment.gateways,\n        relation_classes: setup.relation_classes,\n        command_classes: setup.command_classes,\n        mappers: setup.mapper_classes,\n        plugins: setup.plugins,\n        notifications: setup.notifications,\n        config: environment.config.dup.freeze\n      )\n\n      finalize.run!\n    end\n  end\n\n  # @api private\n  class InlineCreateContainer < CreateContainer\n    # @api private\n    def initialize(*args, &)\n      case args.first\n      when Configuration\n        environment = args.first.environment\n        setup = args.first.setup\n      when Environment\n        environment = args.first\n        setup = args[1]\n      else\n        configuration = Configuration.new(*args, &)\n        environment = configuration.environment\n        setup = configuration.setup\n      end\n\n      super(environment, setup)\n    end\n  end\n\n  # @api private\n  def self.container(...) = InlineCreateContainer.new(...).container\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(*args, &)", "start_line": 47, "end_line": 62}, "metadata": {"module": "ROM", "class_name": "InlineCreateContainer", "class_signature": "class InlineCreateContainer < < CreateContainer"}, "task_id": 415}
{"function_name": "method_missing", "file_path": "rom/core/lib/rom/pipeline.rb", "focal_code": "def method_missing(name, ...)\n        if left.respond_to?(name)\n          response = left.__send__(name, ...)\n\n          if decorate?(response)\n            self.class.new(response, right)\n          else\n            response\n          end\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # Data pipeline common interface\n  #\n  # @api private\n  module Pipeline\n    # Common `>>` operator extension\n    #\n    # @api private\n    module Operator\n      # Compose two relation with a left-to-right composition\n      #\n      # @example\n      #   users.by_name('Jane') >> tasks.for_users\n      #\n      # @param [Relation] other The right relation\n      #\n      # @return [Relation::Composite]\n      #\n      # @api public\n      def >>(other) = composite_class.new(self, other)\n\n      private\n\n      # @api private\n      def composite_class = raise ::NotImplementedError\n    end\n\n    include Operator\n\n    # Send data through specified mappers\n    #\n    # @return [Relation::Composite]\n    #\n    # @api public\n    def map_with(*names)\n      [self, *names.map { |name| mappers[name] }]\n        .reduce { |a, e| composite_class.new(a, e) }\n    end\n\n    # Forwards messages to the left side of a pipeline\n    #\n    # @api private\n    module Proxy\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        left.respond_to?(name) || super\n      end\n\n      private\n\n      # Check if response from method missing should be decorated\n      #\n      # @api private\n      def decorate?(response) = response.is_a?(left.class)\n\n      # @api private\n      def method_missing(name, ...)\n        if left.respond_to?(name)\n          response = left.__send__(name, ...)\n\n          if decorate?(response)\n            self.class.new(response, right)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n\n    # Base composite class with left-to-right pipeline behavior\n    #\n    # @api private\n    class Composite < ::BasicObject\n      %i[block_given? respond_to_missing?].each do |method|\n        define_method(method, ::Kernel.instance_method(method))\n        private method\n      end\n\n      %i[class to_s inspect is_a? instance_of? to_enum].each do |method|\n        define_method(method, ::Kernel.instance_method(method))\n      end\n\n      include ::Dry::Equalizer(:left, :right)\n      include ::ROM::Pipeline::Proxy\n\n      # @api private\n      attr_reader :left\n\n      # @api private\n      attr_reader :right\n\n      # @api private\n      def initialize(left, right)\n        @left = left\n        @right = right\n      end\n\n      # Compose this composite with another object\n      #\n      # @api public\n      def >>(other) = self.class.new(self, other)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, ...)", "start_line": 59, "end_line": 71}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 416}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/header.rb", "focal_code": "def initialize(attributes, options = {})\n      @options = options\n      @model = options[:model]\n      @copy_keys = options.fetch(:copy_keys, false)\n      @reject_keys = options.fetch(:reject_keys, false)\n\n      @attributes = attributes\n      initialize_mapping\n      initialize_tuple_keys\n      initialize_pop_keys\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header/attribute'\n\nmodule ROM\n  # Header provides information about data mapping of a specific relation\n  #\n  # Processors use headers to build objects that process raw relations that go\n  # through mappers.\n  #\n  # @private\n  class Header\n    include ::Enumerable\n    include ::Dry::Equalizer(:attributes, :model)\n\n    # @return [Class] optional model associated with a header\n    #\n    # @api private\n    attr_reader :model\n\n    # @api private\n    attr_reader :reject_keys\n\n    # @api private\n    attr_reader :copy_keys\n\n    # @api private\n    attr_reader :attributes\n\n    # @return [Hash] attribute key/name mapping for all primitive attributes\n    #\n    # @api private\n    attr_reader :mapping\n\n    # @return [Array] all attribute keys that are in a tuple\n    #\n    # @api private\n    attr_reader :tuple_keys\n\n    # @return [Array] all attribute names that are popping from a tuple\n    #\n    # @api private\n    attr_reader :pop_keys\n\n    # Coerce array with attribute definitions into a header object\n    #\n    # @param [Array<Array>] input attribute name/option pairs\n    # @param [Hash] options\n    #\n    # @return [Header]\n    #\n    # @api private\n    def self.coerce(input, options = {})\n      if input.instance_of?(self)\n        input\n      else\n        attributes = input.to_h { [_1.first, Attribute.coerce(_1)] }\n\n        new(attributes, options)\n      end\n    end\n\n    # @api private\n    def initialize(attributes, options = {})\n      @options = options\n      @model = options[:model]\n      @copy_keys = options.fetch(:copy_keys, false)\n      @reject_keys = options.fetch(:reject_keys, false)\n\n      @attributes = attributes\n      initialize_mapping\n      initialize_tuple_keys\n      initialize_pop_keys\n    end\n\n    # Iterate over attributes\n    #\n    # @yield [Attribute]\n    #\n    # @api private\n    def each(&) = attributes.each_value(&)\n\n    # Return if there are any aliased attributes\n    #\n    # @api private\n    def aliased? = any?(&:aliased?)\n\n    # Return attribute keys\n    #\n    # An attribute key corresponds to tuple attribute names\n    #\n    # @api private\n    def keys = attributes.keys\n\n    # Return attribute identified by its name\n    #\n    # @return [Attribute]\n    #\n    # @api private\n    def [](name) = attributes.fetch(name)\n\n    # Return all Combined attributes\n    #\n    # @return [Array<Combined>]\n    #\n    # @api private\n    def combined = by_type(Combined)\n\n    # Returns all attributes that require preprocessing\n    #\n    # @return [Array<Group,Fold>]\n    #\n    # @api private\n    def preprocessed = by_type(Group, Fold)\n\n    # Returns all attributes that require postprocessing\n    #\n    # @return [Array<Ungroup,Unfold>]\n    #\n    # @api private\n    def postprocessed = by_type(Ungroup, Unfold)\n\n    # Return all Wrap attributes\n    #\n    # @return [Array<Wrap>]\n    #\n    # @api private\n    def wraps = by_type(Wrap)\n\n    # Return all non-primitive attributes that don't require mapping\n    #\n    # @return [Array<Group,Fold,Ungroup,Unfold,Wrap,Unwrap>]\n    #\n    # @api private\n    def non_primitives = preprocessed + wraps\n\n    # Return all primitive attributes that require mapping\n    #\n    # @return [Array<Attribute>]\n    #\n    # @api private\n    def primitives = to_a - non_primitives\n\n    private\n\n    # Find all attribute matching specific attribute class (not kind)\n    #\n    # @return [Array<Attribute>]\n    #\n    # @api private\n    def by_type(*types)\n      select { |attribute| types.include?(attribute.class) }\n    end\n\n    # Set mapping hash from primitive attributes\n    #\n    # @api private\n    def initialize_mapping\n      @mapping = primitives.map(&:mapping).reduce(:merge) || {}\n    end\n\n    # Set all tuple keys from all attributes going deep into Wrap and Group too\n    #\n    # @api private\n    def initialize_tuple_keys\n      @tuple_keys = mapping.keys.flatten + non_primitives.flat_map(&:tuple_keys)\n    end\n\n    # Set all tuple keys from all attributes popping from Unwrap and Ungroup\n    #\n    # @api private\n    def initialize_pop_keys\n      @pop_keys = mapping.values + non_primitives.flat_map(&:tuple_keys)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attributes, options = {})", "start_line": 64, "end_line": 74}, "metadata": {"module": "ROM", "class_name": "Header", "class_signature": "class Header"}, "task_id": 417}
{"function_name": "call", "file_path": "rom/core/lib/rom/command_compiler.rb", "focal_code": "def call(*args)\n      cache.fetch_or_store(args.hash) do\n        type, adapter, ast, plugins, plugins_options, meta = args\n\n        compiler = with(\n          id: type,\n          adapter: adapter,\n          plugins: Array(plugins),\n          plugins_options: plugins_options,\n          meta: meta\n        )\n\n        graph_opts = compiler.visit(ast)\n        command = ROM::Commands::Graph.build(registry, graph_opts)\n\n        if command.graph?\n          CommandProxy.new(command)\n        elsif command.lazy?\n          command.unwrap\n        else\n          command\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/commands'\nrequire 'rom/command_proxy'\n\nmodule ROM\n  # Builds commands for relations.\n  #\n  # This class is used by repositories to automatically create commands for\n  # their relations. This is used both by `Repository#command` method and\n  # `commands` repository class macros.\n  #\n  # @api private\n  class CommandCompiler\n    extend Initializer\n\n    # @api private\n    def self.registry\n      Hash.new { |h, k| h[k] = {} }\n    end\n\n    # @!attribute [r] gateways\n    #   @return [ROM::Registry] Gateways used for command extensions\n    param :gateways\n\n    # @!attribute [r] relations\n    #   @return [ROM::RelationRegistry] Relations used with a given compiler\n    param :relations\n\n    # @!attribute [r] commands\n    #   @return [ROM::Registry] Command registries with custom commands\n    param :commands\n\n    # @!attribute [r] notifications\n    #   @return [Notifications::EventBus] Configuration notifications event bus\n    param :notifications\n\n    # @!attribute [r] id\n    #   @return [Symbol] The command type registry identifier\n    option :id, optional: true\n\n    # @!attribute [r] adapter\n    #   @return [Symbol] The adapter identifier ie :sql or :http\n    option :adapter, optional: true\n\n    # @!attribute [r] registry\n    #   @return [Hash] local registry where commands will be stored during compilation\n    option :registry, optional: true, default: -> { self.class.registry }\n\n    # @!attribute [r] plugins\n    #   @return [Array<Symbol>] a list of optional plugins that will be enabled for commands\n    option :plugins, optional: true, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] plugins_options\n    #   @return [Hash] a hash of options for the plugins\n    option :plugins_options, optional: true, default: -> { EMPTY_HASH }\n\n    # @!attribute [r] meta\n    #   @return [Array<Symbol>] Meta data for a command\n    option :meta, optional: true\n\n    # @!attribute [r] cache\n    #   @return [Cache] local cache instance\n    option :cache, default: -> { Cache.new }\n\n    # Return a specific command type for a given adapter and relation AST\n    #\n    # This class holds its own registry where all generated commands are being\n    # stored\n    #\n    # CommandProxy is returned for complex command graphs as they expect root\n    # relation name to be present in the input, which we don't want to have\n    # in repositories. It might be worth looking into removing this requirement\n    # from rom core Command::Graph API.\n    #\n    # @overload [](type, adapter, ast, plugins, meta)\n    #   @param type [Symbol] The type of command\n    #   @param adapter [Symbol] The adapter identifier\n    #   @param ast [Array] The AST representation of a relation\n    #   @param plugins [Array<Symbol>] A list of optional command plugins that should be used\n    #   @param meta [Hash] Meta data for a command\n    #\n    #   @return [Command, CommandProxy]\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args.hash) do\n        type, adapter, ast, plugins, plugins_options, meta = args\n\n        compiler = with(\n          id: type,\n          adapter: adapter,\n          plugins: Array(plugins),\n          plugins_options: plugins_options,\n          meta: meta\n        )\n\n        graph_opts = compiler.visit(ast)\n        command = ROM::Commands::Graph.build(registry, graph_opts)\n\n        if command.graph?\n          CommandProxy.new(command)\n        elsif command.lazy?\n          command.unwrap\n        else\n          command\n        end\n      end\n    end\n    alias_method :[], :call\n\n    # @api private\n    def type\n      @_type ||= Commands.const_get(Inflector.classify(id))[adapter]\n    rescue ::NameError\n      nil\n    end\n\n    # @api private\n    def visit(ast, *args)\n      name, node = ast\n      __send__(:\"visit_#{name}\", node, *args)\n    end\n\n    private\n\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def visit_relation(node, parent_relation = nil)\n      name, header, meta = node\n      other = header.map { |attr| visit(attr, name) }.compact\n\n      if type\n        register_command(name, type, meta, parent_relation)\n\n        default_mapping =\n          if meta[:combine_type] == :many\n            name\n          else\n            { Inflector.singularize(name).to_sym => name }\n          end\n\n        mapping =\n          if parent_relation\n            associations = relations[parent_relation].associations\n\n            assoc = associations[meta[:combine_name]]\n\n            if assoc\n              { assoc.key => assoc.target.name.to_sym }\n            else\n              default_mapping\n            end\n          else\n            default_mapping\n          end\n\n        if other.empty?\n          [mapping, type]\n        else\n          [mapping, [type, other]]\n        end\n      else\n        registry[name][id] = commands[name][id]\n        [name, id]\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    # @api private\n    def visit_attribute(*) = nil\n\n    # Build a command object for a specific relation\n    #\n    # The command will be prepared for handling associations if it's a combined\n    # relation. Additional plugins will be enabled if they are configured for\n    # this compiler.\n    #\n    # @param [Symbol] rel_name A relation identifier from the container registry\n    # @param [Symbol] type The command type\n    # @param [Hash] rel_meta Meta information from relation AST\n    # @param [Symbol] parent_relation Optional parent relation identifier\n    #\n    # @return [ROM::Command]\n    #\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize\n    def register_command(rel_name, type, rel_meta, parent_relation = nil)\n      relation = relations[rel_name]\n\n      type.create_class(rel_name, type) do |klass|\n        klass.result(rel_meta.fetch(:combine_type, result))\n\n        meta.each do |name, value|\n          klass.public_send(name, value)\n        end\n\n        setup_associates(klass, relation, rel_meta, parent_relation) if rel_meta[:combine_type]\n\n        plugins.each do |plugin|\n          plugin_options = plugins_options.fetch(plugin) { EMPTY_HASH }\n          klass.use(plugin, **plugin_options)\n        end\n\n        gateway = gateways[relation.gateway]\n\n        notifications.trigger(\n          'configuration.commands.class.before_build',\n          command: klass, gateway: gateway, dataset: relation.dataset, adapter: adapter\n        )\n\n        klass.extend_for_relation(relation) if klass.restrictable\n\n        registry[rel_name][type] = klass.build(relation)\n      end\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # Return default result type\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def result = meta.fetch(:result, :one)\n\n    # Sets up `associates` plugin for a given command class and relation\n    #\n    # @param [Class] klass The command class\n    # @param [Relation] relation The relation for the command\n    #\n    # @api private\n    def setup_associates(klass, relation, _meta, parent_relation)\n      assoc_name =\n        if relation.associations.key?(parent_relation)\n          parent_relation\n        else\n          singular_name = Inflector.singularize(parent_relation).to_sym\n          singular_name if relation.associations.key?(singular_name)\n        end\n\n      klass.associates(assoc_name || parent_relation)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 89, "end_line": 112}, "metadata": {"module": "ROM", "class_name": "CommandCompiler", "class_signature": "class CommandCompiler"}, "task_id": 418}
{"function_name": "visit_relation", "file_path": "rom/core/lib/rom/command_compiler.rb", "focal_code": "def visit_relation(node, parent_relation = nil)\n      name, header, meta = node\n      other = header.map { |attr| visit(attr, name) }.compact\n\n      if type\n        register_command(name, type, meta, parent_relation)\n\n        default_mapping =\n          if meta[:combine_type] == :many\n            name\n          else\n            { Inflector.singularize(name).to_sym => name }\n          end\n\n        mapping =\n          if parent_relation\n            associations = relations[parent_relation].associations\n\n            assoc = associations[meta[:combine_name]]\n\n            if assoc\n              { assoc.key => assoc.target.name.to_sym }\n            else\n              default_mapping\n            end\n          else\n            default_mapping\n          end\n\n        if other.empty?\n          [mapping, type]\n        else\n          [mapping, [type, other]]\n        end\n      else\n        registry[name][id] = commands[name][id]\n        [name, id]\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/commands'\nrequire 'rom/command_proxy'\n\nmodule ROM\n  # Builds commands for relations.\n  #\n  # This class is used by repositories to automatically create commands for\n  # their relations. This is used both by `Repository#command` method and\n  # `commands` repository class macros.\n  #\n  # @api private\n  class CommandCompiler\n    extend Initializer\n\n    # @api private\n    def self.registry\n      Hash.new { |h, k| h[k] = {} }\n    end\n\n    # @!attribute [r] gateways\n    #   @return [ROM::Registry] Gateways used for command extensions\n    param :gateways\n\n    # @!attribute [r] relations\n    #   @return [ROM::RelationRegistry] Relations used with a given compiler\n    param :relations\n\n    # @!attribute [r] commands\n    #   @return [ROM::Registry] Command registries with custom commands\n    param :commands\n\n    # @!attribute [r] notifications\n    #   @return [Notifications::EventBus] Configuration notifications event bus\n    param :notifications\n\n    # @!attribute [r] id\n    #   @return [Symbol] The command type registry identifier\n    option :id, optional: true\n\n    # @!attribute [r] adapter\n    #   @return [Symbol] The adapter identifier ie :sql or :http\n    option :adapter, optional: true\n\n    # @!attribute [r] registry\n    #   @return [Hash] local registry where commands will be stored during compilation\n    option :registry, optional: true, default: -> { self.class.registry }\n\n    # @!attribute [r] plugins\n    #   @return [Array<Symbol>] a list of optional plugins that will be enabled for commands\n    option :plugins, optional: true, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] plugins_options\n    #   @return [Hash] a hash of options for the plugins\n    option :plugins_options, optional: true, default: -> { EMPTY_HASH }\n\n    # @!attribute [r] meta\n    #   @return [Array<Symbol>] Meta data for a command\n    option :meta, optional: true\n\n    # @!attribute [r] cache\n    #   @return [Cache] local cache instance\n    option :cache, default: -> { Cache.new }\n\n    # Return a specific command type for a given adapter and relation AST\n    #\n    # This class holds its own registry where all generated commands are being\n    # stored\n    #\n    # CommandProxy is returned for complex command graphs as they expect root\n    # relation name to be present in the input, which we don't want to have\n    # in repositories. It might be worth looking into removing this requirement\n    # from rom core Command::Graph API.\n    #\n    # @overload [](type, adapter, ast, plugins, meta)\n    #   @param type [Symbol] The type of command\n    #   @param adapter [Symbol] The adapter identifier\n    #   @param ast [Array] The AST representation of a relation\n    #   @param plugins [Array<Symbol>] A list of optional command plugins that should be used\n    #   @param meta [Hash] Meta data for a command\n    #\n    #   @return [Command, CommandProxy]\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args.hash) do\n        type, adapter, ast, plugins, plugins_options, meta = args\n\n        compiler = with(\n          id: type,\n          adapter: adapter,\n          plugins: Array(plugins),\n          plugins_options: plugins_options,\n          meta: meta\n        )\n\n        graph_opts = compiler.visit(ast)\n        command = ROM::Commands::Graph.build(registry, graph_opts)\n\n        if command.graph?\n          CommandProxy.new(command)\n        elsif command.lazy?\n          command.unwrap\n        else\n          command\n        end\n      end\n    end\n    alias_method :[], :call\n\n    # @api private\n    def type\n      @_type ||= Commands.const_get(Inflector.classify(id))[adapter]\n    rescue ::NameError\n      nil\n    end\n\n    # @api private\n    def visit(ast, *args)\n      name, node = ast\n      __send__(:\"visit_#{name}\", node, *args)\n    end\n\n    private\n\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def visit_relation(node, parent_relation = nil)\n      name, header, meta = node\n      other = header.map { |attr| visit(attr, name) }.compact\n\n      if type\n        register_command(name, type, meta, parent_relation)\n\n        default_mapping =\n          if meta[:combine_type] == :many\n            name\n          else\n            { Inflector.singularize(name).to_sym => name }\n          end\n\n        mapping =\n          if parent_relation\n            associations = relations[parent_relation].associations\n\n            assoc = associations[meta[:combine_name]]\n\n            if assoc\n              { assoc.key => assoc.target.name.to_sym }\n            else\n              default_mapping\n            end\n          else\n            default_mapping\n          end\n\n        if other.empty?\n          [mapping, type]\n        else\n          [mapping, [type, other]]\n        end\n      else\n        registry[name][id] = commands[name][id]\n        [name, id]\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    # @api private\n    def visit_attribute(*) = nil\n\n    # Build a command object for a specific relation\n    #\n    # The command will be prepared for handling associations if it's a combined\n    # relation. Additional plugins will be enabled if they are configured for\n    # this compiler.\n    #\n    # @param [Symbol] rel_name A relation identifier from the container registry\n    # @param [Symbol] type The command type\n    # @param [Hash] rel_meta Meta information from relation AST\n    # @param [Symbol] parent_relation Optional parent relation identifier\n    #\n    # @return [ROM::Command]\n    #\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize\n    def register_command(rel_name, type, rel_meta, parent_relation = nil)\n      relation = relations[rel_name]\n\n      type.create_class(rel_name, type) do |klass|\n        klass.result(rel_meta.fetch(:combine_type, result))\n\n        meta.each do |name, value|\n          klass.public_send(name, value)\n        end\n\n        setup_associates(klass, relation, rel_meta, parent_relation) if rel_meta[:combine_type]\n\n        plugins.each do |plugin|\n          plugin_options = plugins_options.fetch(plugin) { EMPTY_HASH }\n          klass.use(plugin, **plugin_options)\n        end\n\n        gateway = gateways[relation.gateway]\n\n        notifications.trigger(\n          'configuration.commands.class.before_build',\n          command: klass, gateway: gateway, dataset: relation.dataset, adapter: adapter\n        )\n\n        klass.extend_for_relation(relation) if klass.restrictable\n\n        registry[rel_name][type] = klass.build(relation)\n      end\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # Return default result type\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def result = meta.fetch(:result, :one)\n\n    # Sets up `associates` plugin for a given command class and relation\n    #\n    # @param [Class] klass The command class\n    # @param [Relation] relation The relation for the command\n    #\n    # @api private\n    def setup_associates(klass, relation, _meta, parent_relation)\n      assoc_name =\n        if relation.associations.key?(parent_relation)\n          parent_relation\n        else\n          singular_name = Inflector.singularize(parent_relation).to_sym\n          singular_name if relation.associations.key?(singular_name)\n        end\n\n      klass.associates(assoc_name || parent_relation)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_relation", "signature": "def visit_relation(node, parent_relation = nil)", "start_line": 133, "end_line": 171}, "metadata": {"module": "ROM", "class_name": "CommandCompiler", "class_signature": "class CommandCompiler"}, "task_id": 419}
{"function_name": "register_command", "file_path": "rom/core/lib/rom/command_compiler.rb", "focal_code": "def register_command(rel_name, type, rel_meta, parent_relation = nil)\n      relation = relations[rel_name]\n\n      type.create_class(rel_name, type) do |klass|\n        klass.result(rel_meta.fetch(:combine_type, result))\n\n        meta.each do |name, value|\n          klass.public_send(name, value)\n        end\n\n        setup_associates(klass, relation, rel_meta, parent_relation) if rel_meta[:combine_type]\n\n        plugins.each do |plugin|\n          plugin_options = plugins_options.fetch(plugin) { EMPTY_HASH }\n          klass.use(plugin, **plugin_options)\n        end\n\n        gateway = gateways[relation.gateway]\n\n        notifications.trigger(\n          'configuration.commands.class.before_build',\n          command: klass, gateway: gateway, dataset: relation.dataset, adapter: adapter\n        )\n\n        klass.extend_for_relation(relation) if klass.restrictable\n\n        registry[rel_name][type] = klass.build(relation)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/commands'\nrequire 'rom/command_proxy'\n\nmodule ROM\n  # Builds commands for relations.\n  #\n  # This class is used by repositories to automatically create commands for\n  # their relations. This is used both by `Repository#command` method and\n  # `commands` repository class macros.\n  #\n  # @api private\n  class CommandCompiler\n    extend Initializer\n\n    # @api private\n    def self.registry\n      Hash.new { |h, k| h[k] = {} }\n    end\n\n    # @!attribute [r] gateways\n    #   @return [ROM::Registry] Gateways used for command extensions\n    param :gateways\n\n    # @!attribute [r] relations\n    #   @return [ROM::RelationRegistry] Relations used with a given compiler\n    param :relations\n\n    # @!attribute [r] commands\n    #   @return [ROM::Registry] Command registries with custom commands\n    param :commands\n\n    # @!attribute [r] notifications\n    #   @return [Notifications::EventBus] Configuration notifications event bus\n    param :notifications\n\n    # @!attribute [r] id\n    #   @return [Symbol] The command type registry identifier\n    option :id, optional: true\n\n    # @!attribute [r] adapter\n    #   @return [Symbol] The adapter identifier ie :sql or :http\n    option :adapter, optional: true\n\n    # @!attribute [r] registry\n    #   @return [Hash] local registry where commands will be stored during compilation\n    option :registry, optional: true, default: -> { self.class.registry }\n\n    # @!attribute [r] plugins\n    #   @return [Array<Symbol>] a list of optional plugins that will be enabled for commands\n    option :plugins, optional: true, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] plugins_options\n    #   @return [Hash] a hash of options for the plugins\n    option :plugins_options, optional: true, default: -> { EMPTY_HASH }\n\n    # @!attribute [r] meta\n    #   @return [Array<Symbol>] Meta data for a command\n    option :meta, optional: true\n\n    # @!attribute [r] cache\n    #   @return [Cache] local cache instance\n    option :cache, default: -> { Cache.new }\n\n    # Return a specific command type for a given adapter and relation AST\n    #\n    # This class holds its own registry where all generated commands are being\n    # stored\n    #\n    # CommandProxy is returned for complex command graphs as they expect root\n    # relation name to be present in the input, which we don't want to have\n    # in repositories. It might be worth looking into removing this requirement\n    # from rom core Command::Graph API.\n    #\n    # @overload [](type, adapter, ast, plugins, meta)\n    #   @param type [Symbol] The type of command\n    #   @param adapter [Symbol] The adapter identifier\n    #   @param ast [Array] The AST representation of a relation\n    #   @param plugins [Array<Symbol>] A list of optional command plugins that should be used\n    #   @param meta [Hash] Meta data for a command\n    #\n    #   @return [Command, CommandProxy]\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args.hash) do\n        type, adapter, ast, plugins, plugins_options, meta = args\n\n        compiler = with(\n          id: type,\n          adapter: adapter,\n          plugins: Array(plugins),\n          plugins_options: plugins_options,\n          meta: meta\n        )\n\n        graph_opts = compiler.visit(ast)\n        command = ROM::Commands::Graph.build(registry, graph_opts)\n\n        if command.graph?\n          CommandProxy.new(command)\n        elsif command.lazy?\n          command.unwrap\n        else\n          command\n        end\n      end\n    end\n    alias_method :[], :call\n\n    # @api private\n    def type\n      @_type ||= Commands.const_get(Inflector.classify(id))[adapter]\n    rescue ::NameError\n      nil\n    end\n\n    # @api private\n    def visit(ast, *args)\n      name, node = ast\n      __send__(:\"visit_#{name}\", node, *args)\n    end\n\n    private\n\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def visit_relation(node, parent_relation = nil)\n      name, header, meta = node\n      other = header.map { |attr| visit(attr, name) }.compact\n\n      if type\n        register_command(name, type, meta, parent_relation)\n\n        default_mapping =\n          if meta[:combine_type] == :many\n            name\n          else\n            { Inflector.singularize(name).to_sym => name }\n          end\n\n        mapping =\n          if parent_relation\n            associations = relations[parent_relation].associations\n\n            assoc = associations[meta[:combine_name]]\n\n            if assoc\n              { assoc.key => assoc.target.name.to_sym }\n            else\n              default_mapping\n            end\n          else\n            default_mapping\n          end\n\n        if other.empty?\n          [mapping, type]\n        else\n          [mapping, [type, other]]\n        end\n      else\n        registry[name][id] = commands[name][id]\n        [name, id]\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    # @api private\n    def visit_attribute(*) = nil\n\n    # Build a command object for a specific relation\n    #\n    # The command will be prepared for handling associations if it's a combined\n    # relation. Additional plugins will be enabled if they are configured for\n    # this compiler.\n    #\n    # @param [Symbol] rel_name A relation identifier from the container registry\n    # @param [Symbol] type The command type\n    # @param [Hash] rel_meta Meta information from relation AST\n    # @param [Symbol] parent_relation Optional parent relation identifier\n    #\n    # @return [ROM::Command]\n    #\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize\n    def register_command(rel_name, type, rel_meta, parent_relation = nil)\n      relation = relations[rel_name]\n\n      type.create_class(rel_name, type) do |klass|\n        klass.result(rel_meta.fetch(:combine_type, result))\n\n        meta.each do |name, value|\n          klass.public_send(name, value)\n        end\n\n        setup_associates(klass, relation, rel_meta, parent_relation) if rel_meta[:combine_type]\n\n        plugins.each do |plugin|\n          plugin_options = plugins_options.fetch(plugin) { EMPTY_HASH }\n          klass.use(plugin, **plugin_options)\n        end\n\n        gateway = gateways[relation.gateway]\n\n        notifications.trigger(\n          'configuration.commands.class.before_build',\n          command: klass, gateway: gateway, dataset: relation.dataset, adapter: adapter\n        )\n\n        klass.extend_for_relation(relation) if klass.restrictable\n\n        registry[rel_name][type] = klass.build(relation)\n      end\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # Return default result type\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def result = meta.fetch(:result, :one)\n\n    # Sets up `associates` plugin for a given command class and relation\n    #\n    # @param [Class] klass The command class\n    # @param [Relation] relation The relation for the command\n    #\n    # @api private\n    def setup_associates(klass, relation, _meta, parent_relation)\n      assoc_name =\n        if relation.associations.key?(parent_relation)\n          parent_relation\n        else\n          singular_name = Inflector.singularize(parent_relation).to_sym\n          singular_name if relation.associations.key?(singular_name)\n        end\n\n      klass.associates(assoc_name || parent_relation)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "register_command", "signature": "def register_command(rel_name, type, rel_meta, parent_relation = nil)", "start_line": 193, "end_line": 221}, "metadata": {"module": "ROM", "class_name": "CommandCompiler", "class_signature": "class CommandCompiler"}, "task_id": 420}
{"function_name": "setup_associates", "file_path": "rom/core/lib/rom/command_compiler.rb", "focal_code": "def setup_associates(klass, relation, _meta, parent_relation)\n      assoc_name =\n        if relation.associations.key?(parent_relation)\n          parent_relation\n        else\n          singular_name = Inflector.singularize(parent_relation).to_sym\n          singular_name if relation.associations.key?(singular_name)\n        end\n\n      klass.associates(assoc_name || parent_relation)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/initializer'\nrequire 'rom/commands'\nrequire 'rom/command_proxy'\n\nmodule ROM\n  # Builds commands for relations.\n  #\n  # This class is used by repositories to automatically create commands for\n  # their relations. This is used both by `Repository#command` method and\n  # `commands` repository class macros.\n  #\n  # @api private\n  class CommandCompiler\n    extend Initializer\n\n    # @api private\n    def self.registry\n      Hash.new { |h, k| h[k] = {} }\n    end\n\n    # @!attribute [r] gateways\n    #   @return [ROM::Registry] Gateways used for command extensions\n    param :gateways\n\n    # @!attribute [r] relations\n    #   @return [ROM::RelationRegistry] Relations used with a given compiler\n    param :relations\n\n    # @!attribute [r] commands\n    #   @return [ROM::Registry] Command registries with custom commands\n    param :commands\n\n    # @!attribute [r] notifications\n    #   @return [Notifications::EventBus] Configuration notifications event bus\n    param :notifications\n\n    # @!attribute [r] id\n    #   @return [Symbol] The command type registry identifier\n    option :id, optional: true\n\n    # @!attribute [r] adapter\n    #   @return [Symbol] The adapter identifier ie :sql or :http\n    option :adapter, optional: true\n\n    # @!attribute [r] registry\n    #   @return [Hash] local registry where commands will be stored during compilation\n    option :registry, optional: true, default: -> { self.class.registry }\n\n    # @!attribute [r] plugins\n    #   @return [Array<Symbol>] a list of optional plugins that will be enabled for commands\n    option :plugins, optional: true, default: -> { EMPTY_ARRAY }\n\n    # @!attribute [r] plugins_options\n    #   @return [Hash] a hash of options for the plugins\n    option :plugins_options, optional: true, default: -> { EMPTY_HASH }\n\n    # @!attribute [r] meta\n    #   @return [Array<Symbol>] Meta data for a command\n    option :meta, optional: true\n\n    # @!attribute [r] cache\n    #   @return [Cache] local cache instance\n    option :cache, default: -> { Cache.new }\n\n    # Return a specific command type for a given adapter and relation AST\n    #\n    # This class holds its own registry where all generated commands are being\n    # stored\n    #\n    # CommandProxy is returned for complex command graphs as they expect root\n    # relation name to be present in the input, which we don't want to have\n    # in repositories. It might be worth looking into removing this requirement\n    # from rom core Command::Graph API.\n    #\n    # @overload [](type, adapter, ast, plugins, meta)\n    #   @param type [Symbol] The type of command\n    #   @param adapter [Symbol] The adapter identifier\n    #   @param ast [Array] The AST representation of a relation\n    #   @param plugins [Array<Symbol>] A list of optional command plugins that should be used\n    #   @param meta [Hash] Meta data for a command\n    #\n    #   @return [Command, CommandProxy]\n    #\n    # @api private\n    def call(*args)\n      cache.fetch_or_store(args.hash) do\n        type, adapter, ast, plugins, plugins_options, meta = args\n\n        compiler = with(\n          id: type,\n          adapter: adapter,\n          plugins: Array(plugins),\n          plugins_options: plugins_options,\n          meta: meta\n        )\n\n        graph_opts = compiler.visit(ast)\n        command = ROM::Commands::Graph.build(registry, graph_opts)\n\n        if command.graph?\n          CommandProxy.new(command)\n        elsif command.lazy?\n          command.unwrap\n        else\n          command\n        end\n      end\n    end\n    alias_method :[], :call\n\n    # @api private\n    def type\n      @_type ||= Commands.const_get(Inflector.classify(id))[adapter]\n    rescue ::NameError\n      nil\n    end\n\n    # @api private\n    def visit(ast, *args)\n      name, node = ast\n      __send__(:\"visit_#{name}\", node, *args)\n    end\n\n    private\n\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n    def visit_relation(node, parent_relation = nil)\n      name, header, meta = node\n      other = header.map { |attr| visit(attr, name) }.compact\n\n      if type\n        register_command(name, type, meta, parent_relation)\n\n        default_mapping =\n          if meta[:combine_type] == :many\n            name\n          else\n            { Inflector.singularize(name).to_sym => name }\n          end\n\n        mapping =\n          if parent_relation\n            associations = relations[parent_relation].associations\n\n            assoc = associations[meta[:combine_name]]\n\n            if assoc\n              { assoc.key => assoc.target.name.to_sym }\n            else\n              default_mapping\n            end\n          else\n            default_mapping\n          end\n\n        if other.empty?\n          [mapping, type]\n        else\n          [mapping, [type, other]]\n        end\n      else\n        registry[name][id] = commands[name][id]\n        [name, id]\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n    # @api private\n    def visit_attribute(*) = nil\n\n    # Build a command object for a specific relation\n    #\n    # The command will be prepared for handling associations if it's a combined\n    # relation. Additional plugins will be enabled if they are configured for\n    # this compiler.\n    #\n    # @param [Symbol] rel_name A relation identifier from the container registry\n    # @param [Symbol] type The command type\n    # @param [Hash] rel_meta Meta information from relation AST\n    # @param [Symbol] parent_relation Optional parent relation identifier\n    #\n    # @return [ROM::Command]\n    #\n    # @api private\n    #\n    # rubocop:disable Metrics/AbcSize\n    def register_command(rel_name, type, rel_meta, parent_relation = nil)\n      relation = relations[rel_name]\n\n      type.create_class(rel_name, type) do |klass|\n        klass.result(rel_meta.fetch(:combine_type, result))\n\n        meta.each do |name, value|\n          klass.public_send(name, value)\n        end\n\n        setup_associates(klass, relation, rel_meta, parent_relation) if rel_meta[:combine_type]\n\n        plugins.each do |plugin|\n          plugin_options = plugins_options.fetch(plugin) { EMPTY_HASH }\n          klass.use(plugin, **plugin_options)\n        end\n\n        gateway = gateways[relation.gateway]\n\n        notifications.trigger(\n          'configuration.commands.class.before_build',\n          command: klass, gateway: gateway, dataset: relation.dataset, adapter: adapter\n        )\n\n        klass.extend_for_relation(relation) if klass.restrictable\n\n        registry[rel_name][type] = klass.build(relation)\n      end\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # Return default result type\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def result = meta.fetch(:result, :one)\n\n    # Sets up `associates` plugin for a given command class and relation\n    #\n    # @param [Class] klass The command class\n    # @param [Relation] relation The relation for the command\n    #\n    # @api private\n    def setup_associates(klass, relation, _meta, parent_relation)\n      assoc_name =\n        if relation.associations.key?(parent_relation)\n          parent_relation\n        else\n          singular_name = Inflector.singularize(parent_relation).to_sym\n          singular_name if relation.associations.key?(singular_name)\n        end\n\n      klass.associates(assoc_name || parent_relation)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "setup_associates", "signature": "def setup_associates(klass, relation, _meta, parent_relation)", "start_line": 237, "end_line": 247}, "metadata": {"module": "ROM", "class_name": "CommandCompiler", "class_signature": "class CommandCompiler"}, "task_id": 421}
{"function_name": "setup", "file_path": "rom/core/lib/rom/gateway.rb", "focal_code": "def self.setup(gateway_or_scheme, *args, **kwargs)\n      case gateway_or_scheme\n      when String\n        raise ArgumentError, <<-STRING.gsub(/^ {10}/, '')\n          URIs without an explicit scheme are not supported anymore.\n          See https://github.com/rom-rb/rom/blob/master/CHANGELOG.md\n        STRING\n      when Symbol\n        klass = class_from_symbol(gateway_or_scheme)\n\n        if klass.instance_method(:initialize).arity.zero?\n          klass.new\n        else\n          klass.new(*args, **kwargs)\n        end\n      else\n        raise ArgumentError, \"Can't accept arguments when passing an instance\" unless args.empty?\n\n        gateway_or_scheme\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/transaction'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  # Abstract gateway class\n  #\n  # Every adapter needs to inherit from this class and implement\n  # required interface\n  #\n  # @abstract\n  #\n  # @api public\n  class Gateway\n    extend Dry::Core::ClassAttributes\n    extend Notifications::Listener\n\n    # @!method self.adapter\n    #  Get or set gateway's adapter identifier\n    #\n    #  @overload adapter\n    #    Return adapter identifier\n    #    @return [Symbol]\n    #\n    #  @overload gateway(adapter)\n    #    @example\n    #      class MyGateway < ROM::Gateway\n    #        adapter :my_adapter\n    #      end\n    #\n    #    @param [Symbol] adapter The adapter identifier\n    defines :adapter\n\n    # @!attribute [r] connection\n    #   @return [Object] The gateway's connection object (type varies across adapters)\n    attr_reader :connection\n\n    # Set up a gateway\n    #\n    # @overload setup(type, *args)\n    #   Sets up a single-gateway given a gateway type.\n    #   For custom gateways, create an instance and pass it directly.\n    #\n    #   @example\n    #     module SuperDB\n    #       class Gateway < ROM::Gateway\n    #         def initialize(options)\n    #         end\n    #       end\n    #     end\n    #\n    #     ROM.register_adapter(:super_db, SuperDB)\n    #\n    #     Gateway.setup(:super_db, some: 'options')\n    #     # SuperDB::Gateway.new(some: 'options') is called\n    #\n    #   @param [Symbol] type Registered gateway identifier\n    #   @param [Array] args Additional gateway options\n    #\n    # @overload setup(gateway)\n    #   Set up a gateway instance\n    #\n    #   @example\n    #     module SuperDB\n    #       class Gateway < ROM::Gateway\n    #         def initialize(options)\n    #         end\n    #       end\n    #     end\n    #\n    #     ROM.register_adapter(:super_db, SuperDB)\n    #\n    #     Gateway.setup(SuperDB::Gateway.new(some: 'options'))\n    #\n    #   @param [Gateway] gateway\n    #\n    # @return [Gateway] a specific gateway subclass\n    #\n    # @api public\n    def self.setup(gateway_or_scheme, *args, **kwargs)\n      case gateway_or_scheme\n      when String\n        raise ArgumentError, <<-STRING.gsub(/^ {10}/, '')\n          URIs without an explicit scheme are not supported anymore.\n          See https://github.com/rom-rb/rom/blob/master/CHANGELOG.md\n        STRING\n      when Symbol\n        klass = class_from_symbol(gateway_or_scheme)\n\n        if klass.instance_method(:initialize).arity.zero?\n          klass.new\n        else\n          klass.new(*args, **kwargs)\n        end\n      else\n        raise ArgumentError, \"Can't accept arguments when passing an instance\" unless args.empty?\n\n        gateway_or_scheme\n      end\n    end\n\n    # Get gateway subclass for a specific adapter\n    #\n    # @param [Symbol] type Adapter identifier\n    #\n    # @return [Class]\n    #\n    # @api private\n    def self.class_from_symbol(type)\n      adapter = ROM.adapters.fetch(type) do\n        begin\n          require \"rom/#{type}\"\n        rescue LoadError\n          raise AdapterLoadError, \"Failed to load adapter rom/#{type}\"\n        end\n\n        ROM.adapters.fetch(type)\n      end\n\n      adapter.const_get(:Gateway)\n    end\n\n    # Returns the adapter, defined for the class\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    def adapter\n      self.class.adapter || raise(\n        MissingAdapterIdentifierError,\n        \"gateway class +#{self}+ is missing the adapter identifier\"\n      )\n    end\n\n    # A generic interface for setting up a logger\n    #\n    # This is not a required interface, it's a no-op by default\n    #\n    # @abstract\n    #\n    # @api public\n    def use_logger(*)\n      # noop\n    end\n\n    # A generic interface for returning default logger\n    #\n    # Adapters should implement this method as handling loggers is different\n    # across adapters. This is a no-op by default and returns nil.\n    #\n    # @return [NilClass]\n    #\n    # @api public\n    def logger\n      # noop\n    end\n\n    # Disconnect is optional and it's a no-op by default\n    #\n    # @api public\n    def disconnect\n      # noop\n    end\n\n    # Runs a block inside a transaction. The underlying transaction engine\n    # is adapter-specific\n    #\n    # @param [Hash] opts Transaction options\n    #\n    # @return The result of yielding the block or +nil+ if\n    #         the transaction was rolled back\n    #\n    # @api public\n    def transaction(opts = EMPTY_HASH, &) = transaction_runner(opts).run(opts, &)\n\n    private\n\n    # @api private\n    def transaction_runner(_) = Transaction::NoOp\n  end\nend\n", "language": "ruby", "function_component": {"name": "setup", "signature": "def self.setup(gateway_or_scheme, *args, **kwargs)", "start_line": 81, "end_line": 101}, "metadata": {"module": "ROM", "class_name": "Gateway", "class_signature": "class Gateway"}, "task_id": 422}
{"function_name": "class_from_symbol", "file_path": "rom/core/lib/rom/gateway.rb", "focal_code": "def self.class_from_symbol(type)\n      adapter = ROM.adapters.fetch(type) do\n        begin\n          require \"rom/#{type}\"\n        rescue LoadError\n          raise AdapterLoadError, \"Failed to load adapter rom/#{type}\"\n        end\n\n        ROM.adapters.fetch(type)\n      end\n\n      adapter.const_get(:Gateway)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/transaction'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  # Abstract gateway class\n  #\n  # Every adapter needs to inherit from this class and implement\n  # required interface\n  #\n  # @abstract\n  #\n  # @api public\n  class Gateway\n    extend Dry::Core::ClassAttributes\n    extend Notifications::Listener\n\n    # @!method self.adapter\n    #  Get or set gateway's adapter identifier\n    #\n    #  @overload adapter\n    #    Return adapter identifier\n    #    @return [Symbol]\n    #\n    #  @overload gateway(adapter)\n    #    @example\n    #      class MyGateway < ROM::Gateway\n    #        adapter :my_adapter\n    #      end\n    #\n    #    @param [Symbol] adapter The adapter identifier\n    defines :adapter\n\n    # @!attribute [r] connection\n    #   @return [Object] The gateway's connection object (type varies across adapters)\n    attr_reader :connection\n\n    # Set up a gateway\n    #\n    # @overload setup(type, *args)\n    #   Sets up a single-gateway given a gateway type.\n    #   For custom gateways, create an instance and pass it directly.\n    #\n    #   @example\n    #     module SuperDB\n    #       class Gateway < ROM::Gateway\n    #         def initialize(options)\n    #         end\n    #       end\n    #     end\n    #\n    #     ROM.register_adapter(:super_db, SuperDB)\n    #\n    #     Gateway.setup(:super_db, some: 'options')\n    #     # SuperDB::Gateway.new(some: 'options') is called\n    #\n    #   @param [Symbol] type Registered gateway identifier\n    #   @param [Array] args Additional gateway options\n    #\n    # @overload setup(gateway)\n    #   Set up a gateway instance\n    #\n    #   @example\n    #     module SuperDB\n    #       class Gateway < ROM::Gateway\n    #         def initialize(options)\n    #         end\n    #       end\n    #     end\n    #\n    #     ROM.register_adapter(:super_db, SuperDB)\n    #\n    #     Gateway.setup(SuperDB::Gateway.new(some: 'options'))\n    #\n    #   @param [Gateway] gateway\n    #\n    # @return [Gateway] a specific gateway subclass\n    #\n    # @api public\n    def self.setup(gateway_or_scheme, *args, **kwargs)\n      case gateway_or_scheme\n      when String\n        raise ArgumentError, <<-STRING.gsub(/^ {10}/, '')\n          URIs without an explicit scheme are not supported anymore.\n          See https://github.com/rom-rb/rom/blob/master/CHANGELOG.md\n        STRING\n      when Symbol\n        klass = class_from_symbol(gateway_or_scheme)\n\n        if klass.instance_method(:initialize).arity.zero?\n          klass.new\n        else\n          klass.new(*args, **kwargs)\n        end\n      else\n        raise ArgumentError, \"Can't accept arguments when passing an instance\" unless args.empty?\n\n        gateway_or_scheme\n      end\n    end\n\n    # Get gateway subclass for a specific adapter\n    #\n    # @param [Symbol] type Adapter identifier\n    #\n    # @return [Class]\n    #\n    # @api private\n    def self.class_from_symbol(type)\n      adapter = ROM.adapters.fetch(type) do\n        begin\n          require \"rom/#{type}\"\n        rescue LoadError\n          raise AdapterLoadError, \"Failed to load adapter rom/#{type}\"\n        end\n\n        ROM.adapters.fetch(type)\n      end\n\n      adapter.const_get(:Gateway)\n    end\n\n    # Returns the adapter, defined for the class\n    #\n    # @return [Symbol]\n    #\n    # @api public\n    def adapter\n      self.class.adapter || raise(\n        MissingAdapterIdentifierError,\n        \"gateway class +#{self}+ is missing the adapter identifier\"\n      )\n    end\n\n    # A generic interface for setting up a logger\n    #\n    # This is not a required interface, it's a no-op by default\n    #\n    # @abstract\n    #\n    # @api public\n    def use_logger(*)\n      # noop\n    end\n\n    # A generic interface for returning default logger\n    #\n    # Adapters should implement this method as handling loggers is different\n    # across adapters. This is a no-op by default and returns nil.\n    #\n    # @return [NilClass]\n    #\n    # @api public\n    def logger\n      # noop\n    end\n\n    # Disconnect is optional and it's a no-op by default\n    #\n    # @api public\n    def disconnect\n      # noop\n    end\n\n    # Runs a block inside a transaction. The underlying transaction engine\n    # is adapter-specific\n    #\n    # @param [Hash] opts Transaction options\n    #\n    # @return The result of yielding the block or +nil+ if\n    #         the transaction was rolled back\n    #\n    # @api public\n    def transaction(opts = EMPTY_HASH, &) = transaction_runner(opts).run(opts, &)\n\n    private\n\n    # @api private\n    def transaction_runner(_) = Transaction::NoOp\n  end\nend\n", "language": "ruby", "function_component": {"name": "class_from_symbol", "signature": "def self.class_from_symbol(type)", "start_line": 110, "end_line": 122}, "metadata": {"module": "ROM", "class_name": "Gateway", "class_signature": "class Gateway"}, "task_id": 423}
{"function_name": "nodes", "file_path": "rom/core/lib/rom/relation.rb", "focal_code": "def nodes(*args)\n      args.reduce([]) do |acc, arg|\n        case arg\n        when Symbol\n          acc << node(arg)\n        when Hash\n          acc.concat(arg.map { |name, opts| node(name).combine(opts) })\n        when Array\n          acc.concat(arg.map { |opts| nodes(opts) }.reduce(:concat))\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/struct'\nrequire 'rom/constants'\nrequire 'rom/initializer'\nrequire 'rom/support/memoizable'\n\nrequire 'rom/relation/class_interface'\n\nrequire 'rom/auto_curry'\nrequire 'rom/pipeline'\nrequire 'rom/mapper_registry'\nrequire 'rom/command_registry'\n\nrequire 'rom/relation/loaded'\nrequire 'rom/relation/curried'\nrequire 'rom/relation/commands'\nrequire 'rom/relation/composite'\nrequire 'rom/relation/combined'\nrequire 'rom/relation/wrap'\nrequire 'rom/relation/materializable'\nrequire 'rom/association_set'\n\nrequire 'rom/types'\nrequire 'rom/schema'\n\nmodule ROM\n  # Base relation class\n  #\n  # Relation is a proxy for the dataset object provided by the gateway. It\n  # can forward methods to the dataset, which is why the \"native\" interface of\n  # the underlying gateway is available in the relation\n  #\n  # Individual adapters sets up their relation classes and provide different APIs\n  # depending on their persistence backend.\n  #\n  # @api public\n  class Relation\n    # Default no-op output schema which is called in `Relation#each`\n    NOOP_OUTPUT_SCHEMA = -> tuple { tuple }.freeze\n\n    extend Initializer\n    extend ClassInterface\n\n    include Relation::Commands\n    include Memoizable\n\n    extend Dry::Core::ClassAttributes\n\n    defines :adapter, :schema_opts, :schema_class,\n            :schema_attr_class, :schema_inferrer, :schema_dsl,\n            :wrap_class\n\n    # @!method self.gateway\n    #  Manage the gateway\n    #\n    #  @overload gateway\n    #    Return the gateway key that the relation is associated with\n    #    @return [Symbol]\n    #\n    #  @overload gateway(gateway_key)\n    #    Link the relation to a gateway. Change this setting if the\n    #    relation is defined on a non-default gateway\n    #\n    #    @example\n    #      class Users < ROM::Relation[:sql]\n    #        gateway :custom\n    #      end\n    #\n    #    @param [Symbol] gateway_key\n    defines :gateway\n\n    # @!method self.auto_map\n    #   Whether or not a relation and its compositions should be auto-mapped\n    #\n    #   @overload auto_map\n    #     Return auto_map setting value\n    #     @return [Boolean]\n    #\n    #   @overload auto_map(value)\n    #     Set auto_map value\n    defines :auto_map\n\n    # @!method self.auto_struct\n    #   Whether or not tuples should be auto-mapped to structs\n    #\n    #   @overload auto_struct\n    #     Return auto_struct setting value\n    #     @return [Boolean]\n    #\n    #   @overload auto_struct(value)\n    #     Set auto_struct value\n    defines :auto_struct\n\n    # @!method self.struct_namespace\n    #  Get or set a namespace for auto-generated struct classes.\n    #  By default, new struct classes are created within ROM::Struct\n    #\n    #   @example using custom namespace\n    #     class Users < ROM::Relation[:sql]\n    #       struct_namespace Entities\n    #     end\n    #\n    #     users.by_pk(1).one! # => #<Entities::User id=1 name=\"Jane Doe\">\n    #\n    #  @overload struct_namespace\n    #    @return [Module] Default struct namespace\n    #\n    #  @overload struct_namespace(namespace)\n    #    @param [Module] namespace\n    #\n    defines :struct_namespace\n\n    gateway :default\n\n    auto_map true\n    auto_struct false\n    struct_namespace ROM::Struct\n\n    schema_opts EMPTY_HASH\n    schema_dsl Schema::DSL\n    schema_attr_class Attribute\n    schema_class Schema\n    schema_inferrer Schema::DEFAULT_INFERRER\n\n    wrap_class Relation::Wrap\n\n    include Dry::Equalizer(:name, :dataset)\n    include Materializable\n    include Pipeline\n\n    # @!attribute [r] dataset\n    #   @return [Object] dataset used by the relation provided by relation's gateway\n    #   @api public\n    param :dataset\n\n    # @!attribute [r] schema\n    #   @return [Schema] relation schema, defaults to class-level canonical\n    #                    schema (if it was defined) and sets an empty one as\n    #                    the fallback\n    #   @api public\n    option :schema, default: -> { self.class.schema || self.class.default_schema }\n\n    # @!attribute [r] name\n    #   @return [Object] The relation name\n    #   @api public\n    option :name, default: lambda {\n      self.class.schema ? self.class.schema.name : self.class.default_name\n    }\n\n    # @!attribute [r] input_schema\n    #   @return [Object#[]] tuple processing function, uses schema or defaults to Hash[]\n    #   @api private\n    option :input_schema, default: -> { schema.to_input_hash }\n\n    # @!attribute [r] output_schema\n    #   @return [Object#[]] tuple processing function, uses schema or defaults to NOOP_OUTPUT_SCHEMA\n    #   @api private\n    option :output_schema, default: lambda {\n      schema.any?(&:read?) ? schema.to_output_hash : NOOP_OUTPUT_SCHEMA\n    }\n\n    # @!attribute [r] auto_map\n    #   @return [true, false] Whether or not a relation and its\n    #                         compositions should be auto-mapped\n    #   @api private\n    option :auto_map, default: -> { self.class.auto_map }\n\n    # @!attribute [r] auto_struct\n    #   @return [true, false] Whether or not tuples should be auto-mapped to structs\n    #   @api private\n    option :auto_struct, default: -> { self.class.auto_struct }\n\n    # @!attribute [r] struct_namespace\n    #   @return [Module] Custom struct namespace\n    #   @api private\n    option :struct_namespace, reader: false, default: -> { self.class.struct_namespace }\n\n    # @!attribute [r] mappers\n    #   @return [MapperRegistry] an optional mapper registry (empty by default)\n    option :mappers, default: -> { self.class.mapper_registry }\n\n    # @!attribute [r] commands\n    #   @return [CommandRegistry] Command registry\n    #   @api private\n    option :commands, default: -> { CommandRegistry.new({}, relation_name: name.relation) }\n\n    # @!attribute [r] meta\n    #   @return [Hash] Meta data stored in a hash\n    #   @api private\n    option :meta, reader: true, default: -> { EMPTY_HASH }\n\n    # Return schema attribute\n    #\n    # @example accessing canonical attribute\n    #   users[:id]\n    #   # => #<ROM::SQL::Attribute[Integer] primary_key=true\n    #   #     name=:id source=ROM::Relation::Name(users)>\n    #\n    # @example accessing joined attribute\n    #   tasks_with_users = tasks.join(users).select_append(tasks[:title])\n    #   tasks_with_users[:title, :tasks]\n    #   # => #<ROM::SQL::Attribute[String] primary_key=false\n    #   #     name=:title source=ROM::Relation::Name(tasks)>\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def [](name) = schema[name]\n\n    # Yields relation tuples\n    #\n    # Every tuple is processed through Relation#output_schema, it's a no-op by default\n    #\n    # @yield [Hash]\n    #\n    # @return [Enumerator] if block is not provided\n    #\n    # @api public\n    def each(&)\n      return to_enum unless block_given?\n\n      if auto_map?\n        mapper.(dataset.map { |tuple| output_schema[tuple] }).each(&)\n      else\n        dataset.each { |tuple| yield(output_schema[tuple]) }\n      end\n    end\n\n    # Combine with other relations using configured associations\n    #\n    # @overload combine(*associations)\n    #   @example\n    #     users.combine(:tasks, :posts)\n    #\n    #   @param *associations [Array<Symbol>] A list of association names\n    #\n    # @overload combine(*associations, **nested_associations)\n    #   @example\n    #     users.combine(:tasks, posts: :authors)\n    #\n    #   @param *associations [Array<Symbol>] A list of association names\n    #   @param *nested_associations [Hash] A hash with nested association names\n    #\n    # @overload combine(associations)\n    #   @example\n    #     users.combine(posts: [:authors, reviews: [:tags, comments: :author])\n    #\n    #   @param *associations [Hash] A hash with nested association names\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def combine(*args) = combine_with(*nodes(*args))\n\n    # Composes with other relations\n    #\n    # @param [Array<Relation>] others The other relation(s) to compose with\n    #\n    # @return [Relation::Graph]\n    #\n    # @api public\n    def combine_with(*others) = Combined.new(self, others)\n\n    # @api private\n    def nodes(*args)\n      args.reduce([]) do |acc, arg|\n        case arg\n        when Symbol\n          acc << node(arg)\n        when Hash\n          acc.concat(arg.map { |name, opts| node(name).combine(opts) })\n        when Array\n          acc.concat(arg.map { |opts| nodes(opts) }.reduce(:concat))\n        end\n      end\n    end\n\n    # Create a graph node for a given association identifier\n    #\n    # @param [Symbol, Relation::Name] name\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def node(name)\n      assoc = associations[name]\n      other = assoc.node\n      other.eager_load(assoc)\n    end\n\n    # Return a graph node prepared by the given association\n    #\n    # @param [Association] assoc An association object\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def eager_load(assoc)\n      relation = assoc.prepare(self)\n\n      if assoc.override?\n        relation.(assoc)\n      else\n        relation.preload_assoc(assoc)\n      end\n    end\n\n    # Preload other relation via association\n    #\n    # This is used internally when relations are composed\n    #\n    # @return [Relation::Curried]\n    #\n    # @api private\n    def preload_assoc(assoc, other) = assoc.preload(self, other)\n\n    # Wrap other relations using association names\n    #\n    # @example\n    #   tasks.wrap(:owner)\n    #\n    # @param [Array<Symbol>] names A list with association identifiers\n    #\n    # @return [Wrap]\n    #\n    # @api public\n    def wrap(*names)\n      wrap_around(*names.map { |n| associations[n].wrap })\n    end\n\n    # Wrap around other relations\n    #\n    # @param [Array<Relation>] others Other relations\n    #\n    # @return [Relation::Wrap]\n    #\n    # @api public\n    def wrap_around(*others) = wrap_class.new(self, others)\n\n    # Loads a relation\n    #\n    # @return [Relation::Loaded]\n    #\n    # @api public\n    def call = Loaded.new(self)\n\n    # Materializes a relation into an array\n    #\n    # @return [Array<Hash>]\n    #\n    # @api public\n    def to_a = to_enum.to_a\n\n    # Returns if this relation is curried\n    #\n    # @return [false]\n    #\n    # @api private\n    def curried? = false\n\n    # Returns if this relation is a graph\n    #\n    # @return [false]\n    #\n    # @api private\n    def graph? = false\n\n    # Return if this is a wrap relation\n    #\n    # @return [false]\n    #\n    # @api private\n    def wrap? = false\n\n    # Returns true if a relation has schema defined\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api private\n    def schema? = !schema.empty?\n\n    # Return a new relation with provided dataset and additional options\n    #\n    # Use this method whenever you need to use dataset API to get a new dataset\n    # and you want to return a relation back. Typically relation API should be\n    # enough though. If you find yourself using this method, it might be worth\n    # to consider reporting an issue that some dataset functionality is not available\n    # through relation API.\n    #\n    # @example with a new dataset\n    #   users.new(users.dataset.some_method)\n    #\n    # @example with a new dataset and options\n    #   users.new(users.dataset.some_method, other: 'options')\n    #\n    # @param [Object] dataset\n    # @param [Hash] new_opts Additional options\n    #\n    # @api public\n    def new(dataset, **new_opts)\n      opts =\n        if new_opts.empty?\n          options\n        elsif new_opts.key?(:schema)\n          options.merge(new_opts).except(:input_schema, :output_schema)\n        else\n          options.merge(new_opts)\n        end\n\n      self.class.new(dataset, **opts)\n    end\n\n    undef_method :with\n\n    # Returns a new instance with the same dataset but new options\n    #\n    # @example\n    #   users.with(output_schema: -> tuple { .. })\n    #\n    # @param [Hash] opts New options\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def with(opts)\n      new_options =\n        if opts.key?(:meta)\n          opts.merge(meta: meta.merge(opts[:meta]))\n        else\n          opts\n        end\n\n      new(dataset, **options, **new_options)\n    end\n\n    # Return schema's association set (empty by default)\n    #\n    # @return [AssociationSet] Schema's association set (empty by default)\n    #\n    # @api public\n    def associations = schema.associations\n\n    # Returns AST for the wrapped relation\n    #\n    # @return [Array]\n    #\n    # @api public\n    def to_ast = [:relation, [name.relation, attr_ast, meta_ast]]\n\n    # @api private\n    def attr_ast = schema.map(&:to_read_ast)\n\n    # @api private\n    def meta_ast\n      meta = self.meta.merge(dataset: name.dataset, alias: name.aliaz,\n                             struct_namespace: options[:struct_namespace])\n      meta[:model] = false unless auto_struct? || meta[:model]\n      meta\n    end\n\n    # @api private\n    def auto_map? = (auto_map || auto_struct) && !meta[:combine_type]\n\n    # @api private\n    def auto_struct? = auto_struct && !meta[:combine_type]\n\n    # @api private\n    def mapper = mappers[to_ast]\n\n    # Maps relation with custom mappers available in the registry\n    #\n    # When `auto_map` is enabled, your mappers will be applied after performing\n    # default auto-mapping. This means that you can compose complex relations\n    # and have them auto-mapped, and use much simpler custom mappers to adjust\n    # resulting data according to your requirements.\n    #\n    # @overload map_with(*mappers)\n    #   Map tuples using registered mappers\n    #\n    #   @example\n    #     users.map_with(:my_mapper, :my_other_mapper)\n    #\n    #   @param [Array<Symbol>] mappers A list of mapper identifiers\n    #\n    # @overload map_with(*mappers, auto_map: true)\n    #   Map tuples using custom registered mappers and enforce auto-mapping\n    #\n    #   @example\n    #     users.map_with(:my_mapper, :my_other_mapper, auto_map: true)\n    #\n    #   @param [Array<Symbol>] mappers A list of mapper identifiers\n    #\n    # @return [Relation::Composite] Mapped relation\n    #\n    # @api public\n    def map_with(*names, **opts) = super(*names).with(opts)\n\n    # Return a new relation that will map its tuples to instances of the provided class\n    #\n    # @example\n    #   users.map_to(MyUserModel)\n    #\n    # @param [Class] klass Your custom model class\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def map_to(klass, **opts)\n      with(opts.merge(auto_map: false, auto_struct: true, meta: { model: klass }))\n    end\n\n    # Return a new relation with an aliased name\n    #\n    # @example\n    #   users.as(:people)\n    #\n    # @param [Symbol] aliaz Aliased name\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def as(aliaz) = with(name: name.as(aliaz))\n\n    # @return [Symbol] The wrapped relation's adapter identifier ie :sql or :http\n    #\n    # @api private\n    def adapter = self.class.adapter\n\n    # Return name of the source gateway of this relation\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def gateway = self.class.gateway\n\n    # Return all registered relation schemas\n    #\n    # This holds all schemas defined via `view` DSL\n    #\n    # @return [Hash<Symbol=>Schema>]\n    #\n    # @api public\n    def schemas = self.class.schemas\n\n    # Return a foreign key name for the provided relation name\n    #\n    # @param [Name] name The relation name object\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def foreign_key(name)\n      attr = schema.foreign_key(name.dataset)\n\n      if attr\n        attr.name\n      else\n        :\"#{Inflector.singularize(name.dataset)}_id\"\n      end\n    end\n\n    # Return a new relation configured with the provided struct namespace\n    #\n    # @param [Module] ns Custom namespace module for auto-structs\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def struct_namespace(ns)\n      options[:struct_namespace] == ns ? self : with(struct_namespace: ns)\n    end\n\n    memoize :to_ast, :auto_map?, :auto_struct?, :foreign_key, :combine, :wrap, :node\n\n    # we do it here because we want to avoid previous methods to be auto_curried\n    # via method_added hook, which is what AutoCurry uses\n    extend AutoCurry\n\n    auto_curry :preload_assoc\n\n    private\n\n    # Hook used by `Pipeline` to get the class that should be used for composition\n    #\n    # @return [Class]\n    #\n    # @api private\n    def composite_class = Relation::Composite\n\n    # Return configured \"wrap\" relation class used in Relation#wrap\n    #\n    # @return [Class]\n    #\n    # @api private\n    def wrap_class = self.class.wrap_class\n  end\nend\n", "language": "ruby", "function_component": {"name": "nodes", "signature": "def nodes(*args)", "start_line": 266, "end_line": 277}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 424}
{"function_name": "new", "file_path": "rom/core/lib/rom/relation.rb", "focal_code": "def new(dataset, **new_opts)\n      opts =\n        if new_opts.empty?\n          options\n        elsif new_opts.key?(:schema)\n          options.merge(new_opts).except(:input_schema, :output_schema)\n        else\n          options.merge(new_opts)\n        end\n\n      self.class.new(dataset, **opts)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/struct'\nrequire 'rom/constants'\nrequire 'rom/initializer'\nrequire 'rom/support/memoizable'\n\nrequire 'rom/relation/class_interface'\n\nrequire 'rom/auto_curry'\nrequire 'rom/pipeline'\nrequire 'rom/mapper_registry'\nrequire 'rom/command_registry'\n\nrequire 'rom/relation/loaded'\nrequire 'rom/relation/curried'\nrequire 'rom/relation/commands'\nrequire 'rom/relation/composite'\nrequire 'rom/relation/combined'\nrequire 'rom/relation/wrap'\nrequire 'rom/relation/materializable'\nrequire 'rom/association_set'\n\nrequire 'rom/types'\nrequire 'rom/schema'\n\nmodule ROM\n  # Base relation class\n  #\n  # Relation is a proxy for the dataset object provided by the gateway. It\n  # can forward methods to the dataset, which is why the \"native\" interface of\n  # the underlying gateway is available in the relation\n  #\n  # Individual adapters sets up their relation classes and provide different APIs\n  # depending on their persistence backend.\n  #\n  # @api public\n  class Relation\n    # Default no-op output schema which is called in `Relation#each`\n    NOOP_OUTPUT_SCHEMA = -> tuple { tuple }.freeze\n\n    extend Initializer\n    extend ClassInterface\n\n    include Relation::Commands\n    include Memoizable\n\n    extend Dry::Core::ClassAttributes\n\n    defines :adapter, :schema_opts, :schema_class,\n            :schema_attr_class, :schema_inferrer, :schema_dsl,\n            :wrap_class\n\n    # @!method self.gateway\n    #  Manage the gateway\n    #\n    #  @overload gateway\n    #    Return the gateway key that the relation is associated with\n    #    @return [Symbol]\n    #\n    #  @overload gateway(gateway_key)\n    #    Link the relation to a gateway. Change this setting if the\n    #    relation is defined on a non-default gateway\n    #\n    #    @example\n    #      class Users < ROM::Relation[:sql]\n    #        gateway :custom\n    #      end\n    #\n    #    @param [Symbol] gateway_key\n    defines :gateway\n\n    # @!method self.auto_map\n    #   Whether or not a relation and its compositions should be auto-mapped\n    #\n    #   @overload auto_map\n    #     Return auto_map setting value\n    #     @return [Boolean]\n    #\n    #   @overload auto_map(value)\n    #     Set auto_map value\n    defines :auto_map\n\n    # @!method self.auto_struct\n    #   Whether or not tuples should be auto-mapped to structs\n    #\n    #   @overload auto_struct\n    #     Return auto_struct setting value\n    #     @return [Boolean]\n    #\n    #   @overload auto_struct(value)\n    #     Set auto_struct value\n    defines :auto_struct\n\n    # @!method self.struct_namespace\n    #  Get or set a namespace for auto-generated struct classes.\n    #  By default, new struct classes are created within ROM::Struct\n    #\n    #   @example using custom namespace\n    #     class Users < ROM::Relation[:sql]\n    #       struct_namespace Entities\n    #     end\n    #\n    #     users.by_pk(1).one! # => #<Entities::User id=1 name=\"Jane Doe\">\n    #\n    #  @overload struct_namespace\n    #    @return [Module] Default struct namespace\n    #\n    #  @overload struct_namespace(namespace)\n    #    @param [Module] namespace\n    #\n    defines :struct_namespace\n\n    gateway :default\n\n    auto_map true\n    auto_struct false\n    struct_namespace ROM::Struct\n\n    schema_opts EMPTY_HASH\n    schema_dsl Schema::DSL\n    schema_attr_class Attribute\n    schema_class Schema\n    schema_inferrer Schema::DEFAULT_INFERRER\n\n    wrap_class Relation::Wrap\n\n    include Dry::Equalizer(:name, :dataset)\n    include Materializable\n    include Pipeline\n\n    # @!attribute [r] dataset\n    #   @return [Object] dataset used by the relation provided by relation's gateway\n    #   @api public\n    param :dataset\n\n    # @!attribute [r] schema\n    #   @return [Schema] relation schema, defaults to class-level canonical\n    #                    schema (if it was defined) and sets an empty one as\n    #                    the fallback\n    #   @api public\n    option :schema, default: -> { self.class.schema || self.class.default_schema }\n\n    # @!attribute [r] name\n    #   @return [Object] The relation name\n    #   @api public\n    option :name, default: lambda {\n      self.class.schema ? self.class.schema.name : self.class.default_name\n    }\n\n    # @!attribute [r] input_schema\n    #   @return [Object#[]] tuple processing function, uses schema or defaults to Hash[]\n    #   @api private\n    option :input_schema, default: -> { schema.to_input_hash }\n\n    # @!attribute [r] output_schema\n    #   @return [Object#[]] tuple processing function, uses schema or defaults to NOOP_OUTPUT_SCHEMA\n    #   @api private\n    option :output_schema, default: lambda {\n      schema.any?(&:read?) ? schema.to_output_hash : NOOP_OUTPUT_SCHEMA\n    }\n\n    # @!attribute [r] auto_map\n    #   @return [true, false] Whether or not a relation and its\n    #                         compositions should be auto-mapped\n    #   @api private\n    option :auto_map, default: -> { self.class.auto_map }\n\n    # @!attribute [r] auto_struct\n    #   @return [true, false] Whether or not tuples should be auto-mapped to structs\n    #   @api private\n    option :auto_struct, default: -> { self.class.auto_struct }\n\n    # @!attribute [r] struct_namespace\n    #   @return [Module] Custom struct namespace\n    #   @api private\n    option :struct_namespace, reader: false, default: -> { self.class.struct_namespace }\n\n    # @!attribute [r] mappers\n    #   @return [MapperRegistry] an optional mapper registry (empty by default)\n    option :mappers, default: -> { self.class.mapper_registry }\n\n    # @!attribute [r] commands\n    #   @return [CommandRegistry] Command registry\n    #   @api private\n    option :commands, default: -> { CommandRegistry.new({}, relation_name: name.relation) }\n\n    # @!attribute [r] meta\n    #   @return [Hash] Meta data stored in a hash\n    #   @api private\n    option :meta, reader: true, default: -> { EMPTY_HASH }\n\n    # Return schema attribute\n    #\n    # @example accessing canonical attribute\n    #   users[:id]\n    #   # => #<ROM::SQL::Attribute[Integer] primary_key=true\n    #   #     name=:id source=ROM::Relation::Name(users)>\n    #\n    # @example accessing joined attribute\n    #   tasks_with_users = tasks.join(users).select_append(tasks[:title])\n    #   tasks_with_users[:title, :tasks]\n    #   # => #<ROM::SQL::Attribute[String] primary_key=false\n    #   #     name=:title source=ROM::Relation::Name(tasks)>\n    #\n    # @return [Attribute]\n    #\n    # @api public\n    def [](name) = schema[name]\n\n    # Yields relation tuples\n    #\n    # Every tuple is processed through Relation#output_schema, it's a no-op by default\n    #\n    # @yield [Hash]\n    #\n    # @return [Enumerator] if block is not provided\n    #\n    # @api public\n    def each(&)\n      return to_enum unless block_given?\n\n      if auto_map?\n        mapper.(dataset.map { |tuple| output_schema[tuple] }).each(&)\n      else\n        dataset.each { |tuple| yield(output_schema[tuple]) }\n      end\n    end\n\n    # Combine with other relations using configured associations\n    #\n    # @overload combine(*associations)\n    #   @example\n    #     users.combine(:tasks, :posts)\n    #\n    #   @param *associations [Array<Symbol>] A list of association names\n    #\n    # @overload combine(*associations, **nested_associations)\n    #   @example\n    #     users.combine(:tasks, posts: :authors)\n    #\n    #   @param *associations [Array<Symbol>] A list of association names\n    #   @param *nested_associations [Hash] A hash with nested association names\n    #\n    # @overload combine(associations)\n    #   @example\n    #     users.combine(posts: [:authors, reviews: [:tags, comments: :author])\n    #\n    #   @param *associations [Hash] A hash with nested association names\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def combine(*args) = combine_with(*nodes(*args))\n\n    # Composes with other relations\n    #\n    # @param [Array<Relation>] others The other relation(s) to compose with\n    #\n    # @return [Relation::Graph]\n    #\n    # @api public\n    def combine_with(*others) = Combined.new(self, others)\n\n    # @api private\n    def nodes(*args)\n      args.reduce([]) do |acc, arg|\n        case arg\n        when Symbol\n          acc << node(arg)\n        when Hash\n          acc.concat(arg.map { |name, opts| node(name).combine(opts) })\n        when Array\n          acc.concat(arg.map { |opts| nodes(opts) }.reduce(:concat))\n        end\n      end\n    end\n\n    # Create a graph node for a given association identifier\n    #\n    # @param [Symbol, Relation::Name] name\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def node(name)\n      assoc = associations[name]\n      other = assoc.node\n      other.eager_load(assoc)\n    end\n\n    # Return a graph node prepared by the given association\n    #\n    # @param [Association] assoc An association object\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def eager_load(assoc)\n      relation = assoc.prepare(self)\n\n      if assoc.override?\n        relation.(assoc)\n      else\n        relation.preload_assoc(assoc)\n      end\n    end\n\n    # Preload other relation via association\n    #\n    # This is used internally when relations are composed\n    #\n    # @return [Relation::Curried]\n    #\n    # @api private\n    def preload_assoc(assoc, other) = assoc.preload(self, other)\n\n    # Wrap other relations using association names\n    #\n    # @example\n    #   tasks.wrap(:owner)\n    #\n    # @param [Array<Symbol>] names A list with association identifiers\n    #\n    # @return [Wrap]\n    #\n    # @api public\n    def wrap(*names)\n      wrap_around(*names.map { |n| associations[n].wrap })\n    end\n\n    # Wrap around other relations\n    #\n    # @param [Array<Relation>] others Other relations\n    #\n    # @return [Relation::Wrap]\n    #\n    # @api public\n    def wrap_around(*others) = wrap_class.new(self, others)\n\n    # Loads a relation\n    #\n    # @return [Relation::Loaded]\n    #\n    # @api public\n    def call = Loaded.new(self)\n\n    # Materializes a relation into an array\n    #\n    # @return [Array<Hash>]\n    #\n    # @api public\n    def to_a = to_enum.to_a\n\n    # Returns if this relation is curried\n    #\n    # @return [false]\n    #\n    # @api private\n    def curried? = false\n\n    # Returns if this relation is a graph\n    #\n    # @return [false]\n    #\n    # @api private\n    def graph? = false\n\n    # Return if this is a wrap relation\n    #\n    # @return [false]\n    #\n    # @api private\n    def wrap? = false\n\n    # Returns true if a relation has schema defined\n    #\n    # @return [TrueClass, FalseClass]\n    #\n    # @api private\n    def schema? = !schema.empty?\n\n    # Return a new relation with provided dataset and additional options\n    #\n    # Use this method whenever you need to use dataset API to get a new dataset\n    # and you want to return a relation back. Typically relation API should be\n    # enough though. If you find yourself using this method, it might be worth\n    # to consider reporting an issue that some dataset functionality is not available\n    # through relation API.\n    #\n    # @example with a new dataset\n    #   users.new(users.dataset.some_method)\n    #\n    # @example with a new dataset and options\n    #   users.new(users.dataset.some_method, other: 'options')\n    #\n    # @param [Object] dataset\n    # @param [Hash] new_opts Additional options\n    #\n    # @api public\n    def new(dataset, **new_opts)\n      opts =\n        if new_opts.empty?\n          options\n        elsif new_opts.key?(:schema)\n          options.merge(new_opts).except(:input_schema, :output_schema)\n        else\n          options.merge(new_opts)\n        end\n\n      self.class.new(dataset, **opts)\n    end\n\n    undef_method :with\n\n    # Returns a new instance with the same dataset but new options\n    #\n    # @example\n    #   users.with(output_schema: -> tuple { .. })\n    #\n    # @param [Hash] opts New options\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def with(opts)\n      new_options =\n        if opts.key?(:meta)\n          opts.merge(meta: meta.merge(opts[:meta]))\n        else\n          opts\n        end\n\n      new(dataset, **options, **new_options)\n    end\n\n    # Return schema's association set (empty by default)\n    #\n    # @return [AssociationSet] Schema's association set (empty by default)\n    #\n    # @api public\n    def associations = schema.associations\n\n    # Returns AST for the wrapped relation\n    #\n    # @return [Array]\n    #\n    # @api public\n    def to_ast = [:relation, [name.relation, attr_ast, meta_ast]]\n\n    # @api private\n    def attr_ast = schema.map(&:to_read_ast)\n\n    # @api private\n    def meta_ast\n      meta = self.meta.merge(dataset: name.dataset, alias: name.aliaz,\n                             struct_namespace: options[:struct_namespace])\n      meta[:model] = false unless auto_struct? || meta[:model]\n      meta\n    end\n\n    # @api private\n    def auto_map? = (auto_map || auto_struct) && !meta[:combine_type]\n\n    # @api private\n    def auto_struct? = auto_struct && !meta[:combine_type]\n\n    # @api private\n    def mapper = mappers[to_ast]\n\n    # Maps relation with custom mappers available in the registry\n    #\n    # When `auto_map` is enabled, your mappers will be applied after performing\n    # default auto-mapping. This means that you can compose complex relations\n    # and have them auto-mapped, and use much simpler custom mappers to adjust\n    # resulting data according to your requirements.\n    #\n    # @overload map_with(*mappers)\n    #   Map tuples using registered mappers\n    #\n    #   @example\n    #     users.map_with(:my_mapper, :my_other_mapper)\n    #\n    #   @param [Array<Symbol>] mappers A list of mapper identifiers\n    #\n    # @overload map_with(*mappers, auto_map: true)\n    #   Map tuples using custom registered mappers and enforce auto-mapping\n    #\n    #   @example\n    #     users.map_with(:my_mapper, :my_other_mapper, auto_map: true)\n    #\n    #   @param [Array<Symbol>] mappers A list of mapper identifiers\n    #\n    # @return [Relation::Composite] Mapped relation\n    #\n    # @api public\n    def map_with(*names, **opts) = super(*names).with(opts)\n\n    # Return a new relation that will map its tuples to instances of the provided class\n    #\n    # @example\n    #   users.map_to(MyUserModel)\n    #\n    # @param [Class] klass Your custom model class\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def map_to(klass, **opts)\n      with(opts.merge(auto_map: false, auto_struct: true, meta: { model: klass }))\n    end\n\n    # Return a new relation with an aliased name\n    #\n    # @example\n    #   users.as(:people)\n    #\n    # @param [Symbol] aliaz Aliased name\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def as(aliaz) = with(name: name.as(aliaz))\n\n    # @return [Symbol] The wrapped relation's adapter identifier ie :sql or :http\n    #\n    # @api private\n    def adapter = self.class.adapter\n\n    # Return name of the source gateway of this relation\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def gateway = self.class.gateway\n\n    # Return all registered relation schemas\n    #\n    # This holds all schemas defined via `view` DSL\n    #\n    # @return [Hash<Symbol=>Schema>]\n    #\n    # @api public\n    def schemas = self.class.schemas\n\n    # Return a foreign key name for the provided relation name\n    #\n    # @param [Name] name The relation name object\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def foreign_key(name)\n      attr = schema.foreign_key(name.dataset)\n\n      if attr\n        attr.name\n      else\n        :\"#{Inflector.singularize(name.dataset)}_id\"\n      end\n    end\n\n    # Return a new relation configured with the provided struct namespace\n    #\n    # @param [Module] ns Custom namespace module for auto-structs\n    #\n    # @return [Relation]\n    #\n    # @api public\n    def struct_namespace(ns)\n      options[:struct_namespace] == ns ? self : with(struct_namespace: ns)\n    end\n\n    memoize :to_ast, :auto_map?, :auto_struct?, :foreign_key, :combine, :wrap, :node\n\n    # we do it here because we want to avoid previous methods to be auto_curried\n    # via method_added hook, which is what AutoCurry uses\n    extend AutoCurry\n\n    auto_curry :preload_assoc\n\n    private\n\n    # Hook used by `Pipeline` to get the class that should be used for composition\n    #\n    # @return [Class]\n    #\n    # @api private\n    def composite_class = Relation::Composite\n\n    # Return configured \"wrap\" relation class used in Relation#wrap\n    #\n    # @return [Class]\n    #\n    # @api private\n    def wrap_class = self.class.wrap_class\n  end\nend\n", "language": "ruby", "function_component": {"name": "new", "signature": "def new(dataset, **new_opts)", "start_line": 401, "end_line": 412}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 425}
{"function_name": "build_class", "file_path": "rom/core/lib/rom/mapper/builder.rb", "focal_code": "def self.build_class(name, mapper_registry, options = EMPTY_HASH, &)\n        class_name = \"ROM::Mapper[#{name}]\"\n\n        parent = options[:parent]\n        inherit_header = options.fetch(:inherit_header) { ROM::Mapper.inherit_header }\n\n        parent_class =\n          if parent\n            mapper_registry.detect { |klass| klass.relation == parent }\n          else\n            ROM::Mapper\n          end\n\n        Dry::Core::ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|\n          klass.register_as(name)\n          klass.relation(name)\n          klass.inherit_header(inherit_header)\n\n          klass.class_eval(&) if block_given?\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Mapper\n    # Setup DSL-specific mapper extensions\n    #\n    # @private\n    class Builder\n      # Generate a mapper subclass\n      #\n      # This is used by Setup#mappers DSL\n      #\n      # @api private\n      def self.build_class(name, mapper_registry, options = EMPTY_HASH, &)\n        class_name = \"ROM::Mapper[#{name}]\"\n\n        parent = options[:parent]\n        inherit_header = options.fetch(:inherit_header) { ROM::Mapper.inherit_header }\n\n        parent_class =\n          if parent\n            mapper_registry.detect { |klass| klass.relation == parent }\n          else\n            ROM::Mapper\n          end\n\n        Dry::Core::ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|\n          klass.register_as(name)\n          klass.relation(name)\n          klass.inherit_header(inherit_header)\n\n          klass.class_eval(&) if block_given?\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_class", "signature": "def self.build_class(name, mapper_registry, options = EMPTY_HASH, &)", "start_line": 14, "end_line": 34}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 426}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attributes, options)", "start_line": 36, "end_line": 45}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 427}
{"function_name": "attribute", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "attribute", "signature": "def attribute(name, options = EMPTY_HASH, &block)", "start_line": 90, "end_line": 99}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 428}
{"function_name": "embedded", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "embedded", "signature": "def embedded(name, options, &)", "start_line": 143, "end_line": 160}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 429}
{"function_name": "wrap", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "wrap", "signature": "def wrap(*args, &)", "start_line": 181, "end_line": 193}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 430}
{"function_name": "unwrap", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "unwrap", "signature": "def unwrap(*args, &)", "start_line": 214, "end_line": 224}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 431}
{"function_name": "group", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "group", "signature": "def group(*args, &)", "start_line": 243, "end_line": 255}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 432}
{"function_name": "combine", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "combine", "signature": "def combine(name, options, &)", "start_line": 344, "end_line": 355}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 433}
{"function_name": "ensure_mapper_configuration", "file_path": "rom/core/lib/rom/mapper/attribute_dsl.rb", "focal_code": "def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/header'\nrequire 'rom/mapper/model_dsl'\n\nmodule ROM\n  class Mapper\n    # Mapper attribute DSL exposed by mapper subclasses\n    #\n    # This class is private even though its methods are exposed by mappers.\n    # Typically it's not meant to be used directly.\n    #\n    # TODO: break this madness down into smaller pieces\n    #\n    # @api private\n    # rubocop:disable Metrics/ClassLength\n    class AttributeDSL\n      include ModelDSL\n\n      attr_reader :attributes\n\n      attr_reader :options\n\n      attr_reader :copy_keys\n\n      attr_reader :symbolize_keys\n\n      attr_reader :reject_keys\n\n      attr_reader :steps\n\n      # @param [Array] attributes accumulator array\n      # @param [Hash] options\n      #\n      # @api private\n      def initialize(attributes, options)\n        @attributes = attributes\n        @options = options\n        @copy_keys = options.fetch(:copy_keys)\n        @symbolize_keys = options.fetch(:symbolize_keys)\n        @prefix = options.fetch(:prefix)\n        @prefix_separator = options.fetch(:prefix_separator)\n        @reject_keys = options.fetch(:reject_keys)\n        @steps = []\n      end\n\n      # Redefine the prefix for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix, 'user')\n      #\n      # @api public\n      def prefix(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix\n        else\n          @prefix = value\n        end\n      end\n\n      # Redefine the prefix separator for the following attributes\n      #\n      # @example\n      #\n      #   dsl = AttributeDSL.new([])\n      #   dsl.attribute(:prefix_separator, '.')\n      #\n      # @api public\n      def prefix_separator(value = Undefined)\n        if value.equal?(Undefined)\n          @prefix_separator\n        else\n          @prefix_separator = value\n        end\n      end\n\n      # Define a mapping attribute with its options and/or block\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.attribute(:name)\n      #   dsl.attribute(:email, from: 'user_email')\n      #   dsl.attribute(:name) { 'John' }\n      #   dsl.attribute(:name) { |t| t.upcase }\n      #\n      # @api public\n      def attribute(name, options = EMPTY_HASH, &block)\n        with_attr_options(name, options) do |attr_options|\n          if options[:type] && block_given?\n            raise ArgumentError,\n                  \"can't specify type and block at the same time\"\n          end\n          attr_options[:coercer] = block if block_given?\n          add_attribute(name, attr_options)\n        end\n      end\n\n      def exclude(name)\n        attributes << [name,  exclude: true]\n      end\n\n      # Perform transformations sequentially\n      #\n      # @example\n      #   dsl = AttributeDSL.new()\n      #\n      #   dsl.step do\n      #     attribute :name\n      #   end\n      #\n      # @api public\n      def step(options = EMPTY_HASH, &)\n        steps << new(options, &)\n      end\n\n      # Define an embedded attribute\n      #\n      # Block exposes the attribute dsl too\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.embedded :tags, type: :array do\n      #     attribute :name\n      #   end\n      #\n      #   dsl.embedded :address, type: :hash do\n      #     model Address\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name attribute\n      #\n      # @param [Hash] options\n      # @option options [Symbol] :type Embedded type can be :hash or :array\n      # @option options [Symbol] :prefix Prefix that should be used for\n      #                                  its attributes\n      #\n      # @api public\n      def embedded(name, options, &)\n        with_attr_options(name) do |attr_options|\n          mapper = options[:mapper]\n\n          if mapper\n            embedded_options = { type: :array }.update(options)\n            attributes_from_mapper(\n              mapper, name, embedded_options.update(attr_options)\n            )\n          else\n            dsl = new(options, &)\n            attr_options.update(options)\n            add_attribute(\n              name, { header: dsl.header, type: :array }.update(attr_options)\n            )\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"wrapping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.wrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.wrap(:address) do\n      #     model Address\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def wrap(*args, &)\n        ensure_mapper_configuration('wrap', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          wrap_options = { type: :hash, wrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, wrap_options)\n          else\n            dsl(name, wrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unwrapping\" transformation\n      #\n      # Typically this is used in no-sql context to normalize data before\n      # inserting to sql gateway.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unwrap(address: [:street, :zipcode, :city])\n      #\n      #   dsl.unwrap(:address) do\n      #     attribute :street\n      #     attribute :zipcode\n      #     attribute :city\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unwrap(*args, &)\n        with_name_or_options(*args) do |name, options, mapper|\n          unwrap_options = { type: :hash, unwrap: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, unwrap_options)\n          else\n            dsl(name, unwrap_options, &)\n          end\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"grouping\" transformation\n      #\n      # Typically this is used in sql context when relation is a join.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.group(tags: [:name])\n      #\n      #   dsl.group(:tags) do\n      #     model Tag\n      #     attribute :name\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def group(*args, &)\n        ensure_mapper_configuration('group', args, block_given?)\n\n        with_name_or_options(*args) do |name, options, mapper|\n          group_options = { type: :array, group: true }.update(options)\n\n          if mapper\n            attributes_from_mapper(mapper, name, group_options)\n          else\n            dsl(name, group_options, &)\n          end\n        end\n      end\n\n      # Define an embedded array attribute that requires \"ungrouping\" transformation\n      #\n      # Typically this is used in non-sql context being prepared for import to sql.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #   dsl.ungroup(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def ungroup(*args, &)\n        with_name_or_options(*args) do |name, options, *|\n          ungroup_options = { type: :array, ungroup: true }.update(options)\n          dsl(name, ungroup_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"fold\" transformation\n      #\n      # Typically this is used in sql context to fold single joined field\n      # to the array of values.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.fold(tags: [:name])\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def fold(*args, &)\n        with_name_or_options(*args) do |name, *|\n          fold_options = { type: :array, fold: true }\n          dsl(name, fold_options, &)\n        end\n      end\n\n      # Define an embedded hash attribute that requires \"unfold\" transformation\n      #\n      # Typically this is used in non-sql context to convert array of\n      # values (like in Cassandra 'SET' or 'LIST' types) to array of tuples.\n      #\n      # Source values are assigned to the first key, the other keys being left blank.\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.unfold(tags: [:name, :type], from: :tags_list)\n      #\n      #   dsl.unfold :tags, from: :tags_list do\n      #     attribute :name, from: :tag_name\n      #     attribute :type, from: :tag_type\n      #   end\n      #\n      # @see AttributeDSL#embedded\n      #\n      # @api public\n      def unfold(name, options = EMPTY_HASH)\n        with_attr_options(name, options) do |attr_options|\n          old_name = attr_options.fetch(:from, name)\n          dsl(old_name, type: :array, unfold: true) do\n            attribute name, attr_options\n            yield if block_given?\n          end\n        end\n      end\n\n      # Define an embedded combined attribute that requires \"combine\" transformation\n      #\n      # Typically this can be used to process results of eager-loading\n      #\n      # @example\n      #   dsl = AttributeDSL.new([])\n      #\n      #   dsl.combine(:tags, user_id: :id) do\n      #     model Tag\n      #\n      #     attribute :name\n      #   end\n      #\n      # @param [Symbol] name\n      # @param [Hash] options\n      #   @option options [Hash] :on The \"join keys\"\n      #   @option options [Symbol] :type The type, either :array (default) or :hash\n      #\n      # @api public\n      def combine(name, options, &)\n        dsl = new(options, &)\n\n        attr_opts = {\n          type: options.fetch(:type, :array),\n          keys: options.fetch(:on),\n          combine: true,\n          header: dsl.header\n        }\n\n        add_attribute(name, attr_opts)\n      end\n\n      # Generate a header from attribute definitions\n      #\n      # @return [Header]\n      #\n      # @api private\n      def header\n        Header.coerce(attributes, copy_keys: copy_keys, model: model, reject_keys: reject_keys)\n      end\n\n      private\n\n      # Remove the attribute used somewhere else (in wrap, group, model etc.)\n      #\n      # @api private\n      def remove(*names)\n        attributes.delete_if { |attr| names.include?(attr.first) }\n      end\n\n      # Handle attribute options common for all definitions\n      #\n      # @api private\n      def with_attr_options(name, options = EMPTY_HASH)\n        attr_options = options.dup\n\n        if @prefix\n          attr_options[:from] ||= \"#{@prefix}#{@prefix_separator}#{name}\"\n          attr_options[:from] = attr_options[:from].to_sym if name.is_a? Symbol\n        end\n\n        attr_options.update(from: attr_options.fetch(:from) { name }.to_s) if symbolize_keys\n\n        yield(attr_options)\n      end\n\n      # Handle \"name or options\" syntax used by `wrap` and `group`\n      #\n      # @api private\n      def with_name_or_options(*args)\n        name, options =\n          if args.size > 1\n            args\n          else\n            [args.first, {}]\n          end\n\n        yield(name, options, options[:mapper])\n      end\n\n      # Create another instance of the dsl for nested definitions\n      #\n      # This is used by embedded, wrap and group\n      #\n      # @api private\n      def dsl(name_or_attrs, options, &)\n        if block_given?\n          attributes_from_block(name_or_attrs, options, &)\n        else\n          attributes_from_hash(name_or_attrs, options)\n        end\n      end\n\n      # Define attributes from a nested block\n      #\n      # Used by embedded, wrap and group\n      #\n      # @api private\n      def attributes_from_block(name, options, &)\n        dsl = new(options, &)\n        header = dsl.header\n        add_attribute(name, options.update(header: header))\n        header.each { |attr| remove(attr.key) unless name == attr.key }\n      end\n\n      # Define attributes from the `name => attributes` hash syntax\n      #\n      # Used by wrap and group\n      #\n      # @api private\n      def attributes_from_hash(hash, options)\n        hash.each do |name, header|\n          with_attr_options(name, options) do |attr_options|\n            add_attribute(name, attr_options.update(header: header.zip))\n            header.each { |attr| remove(attr) unless name == attr }\n          end\n        end\n      end\n\n      # Infer mapper header for an embedded attribute\n      #\n      # @api private\n      def attributes_from_mapper(mapper, name, options)\n        if mapper.is_a?(Class)\n          add_attribute(name, { header: mapper.header }.update(options))\n        else\n          raise(\n            ArgumentError, \":mapper must be a class #{mapper.inspect}\"\n          )\n        end\n      end\n\n      # Add a new attribute and make sure it overrides previous definition\n      #\n      # @api private\n      def add_attribute(name, options)\n        remove(name, name.to_s)\n        attributes << [name, options]\n      end\n\n      # Create a new dsl instance of potentially overidden options\n      #\n      # Embedded, wrap and group can override top-level options like `prefix`\n      #\n      # @api private\n      def new(options, &)\n        dsl = self.class.new([], @options.merge(options))\n        dsl.instance_exec(&) if block_given?\n        dsl\n      end\n\n      # Ensure the mapping configuration isn't ambiguous\n      #\n      # @api private\n      def ensure_mapper_configuration(method_name, args, block_present)\n        if args.first.is_a?(Hash) && block_present\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a block\"\n        end\n        if args.first.is_a?(Hash) && args.first[:mapper]\n          raise MapperMisconfiguredError,\n                \"Cannot configure `#{method_name}#` using both options and a mapper\"\n        end\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "ensure_mapper_configuration", "signature": "def ensure_mapper_configuration(method_name, args, block_present)", "start_line": 479, "end_line": 488}, "metadata": {"module": "ROM", "class_name": "Mapper", "class_signature": "class Mapper"}, "task_id": 434}
{"function_name": "visit_attribute", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_attribute", "signature": "def visit_attribute(attribute)", "start_line": 139, "end_line": 151}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 435}
{"function_name": "visit_combined", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_combined", "signature": "def visit_combined(attribute)", "start_line": 168, "end_line": 185}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 436}
{"function_name": "visit_group", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_group", "signature": "def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 242, "end_line": 260}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 437}
{"function_name": "visit_ungroup", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_ungroup", "signature": "def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 272, "end_line": 289}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 438}
{"function_name": "visit_fold", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_fold", "signature": "def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 300, "end_line": 311}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 439}
{"function_name": "visit_unfold", "file_path": "rom/core/lib/rom/processor/transproc.rb", "focal_code": "def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/all'\n\nrequire 'rom/processor'\n\nmodule ROM\n  class Processor\n    # Data mapping transformer builder using Transproc\n    #\n    # This builds a transproc function that is used to map a whole relation\n    #\n    # @see https://github.com/solnic/transproc too\n    #\n    # @private\n    # rubocop:disable Metrics/ClassLength\n    class Transproc < Processor\n      include ::Transproc::Composer\n\n      module Functions\n        extend ::Transproc::Registry\n\n        import ::Transproc::Coercions\n        import ::Transproc::ArrayTransformations\n        import ::Transproc::HashTransformations\n        import ::Transproc::ClassTransformations\n        import ::Transproc::ProcTransformations\n        import ::Transproc::Conditional\n\n        INVALID_INJECT_UNION_VALUE = '%s attribute: block is required for :from with union value.'\n\n        def self.get(arr, idx)\n          arr[idx]\n        end\n\n        def self.filter_empty(arr)\n          arr.reject { |row| row.values.all?(&:nil?) }\n        end\n\n        def self.inject_union_value(tuple, name, keys, coercer)\n          raise ROM::MapperMisconfiguredError, INVALID_INJECT_UNION_VALUE % [name] unless coercer\n\n          values = tuple.values_at(*keys)\n          result = coercer.call(*values)\n\n          tuple.merge(name => result)\n        end\n      end\n\n      # @return [Mapper] mapper that this processor belongs to\n      #\n      # @api private\n      attr_reader :mapper\n\n      # @return [Header] header from a mapper\n      #\n      # @api private\n      attr_reader :header\n\n      # @return [Class] model class from a mapper\n      #\n      # @api private\n      attr_reader :model\n\n      # @return [Hash] header's attribute mapping\n      #\n      # @api private\n      attr_reader :mapping\n\n      # @return [Proc] row-processing proc\n      #\n      # @api private\n      attr_reader :row_proc\n\n      # Build a transproc function from the header\n      #\n      # @param [ROM::Header] header\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      def self.build(mapper, header)\n        new(mapper, header).to_transproc\n      end\n\n      # @api private\n      def initialize(mapper, header)\n        super()\n        @mapper = mapper\n        @header = header\n        @model = header.model\n        @mapping = header.mapping\n        initialize_row_proc\n      end\n\n      # Coerce mapper header to a transproc data mapping function\n      #\n      # @return [Transproc::Function]\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def to_transproc\n        compose(t(:identity)) do |ops|\n          combined = header.combined\n          ops << t(:combine, combined.map(&method(:combined_args))) if combined.any?\n          ops << header.preprocessed.map { |attr| visit(attr, true) }\n          ops << t(:map_array, row_proc) if row_proc\n          ops << header.postprocessed.map { |attr| visit(attr, true) }\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Visit an attribute from the header\n      #\n      # This forwards to a specialized visitor based on the attribute type\n      #\n      # @param [Header::Attribute] attribute\n      # @param [Array] args Allows to send `preprocess: true`\n      #\n      # @api private\n      def visit(attribute, *args)\n        type = attribute.class.name.split('::').last.downcase\n        send(\"visit_#{type}\", attribute, *args)\n      end\n\n      # Visit plain attribute\n      #\n      # It will call block transformation if it's used\n      #\n      # If it's a typed attribute a coercion transformation is added\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize\n      def visit_attribute(attribute)\n        coercer = attribute.meta[:coercer]\n        if attribute.union?\n          compose do |ops|\n            ops << t(:inject_union_value, attribute.name, attribute.key, coercer)\n            ops << t(:reject_keys, attribute.key) unless header.copy_keys\n          end\n        elsif coercer\n          t(:map_value, attribute.name, t(:bind, mapper, coercer))\n        elsif attribute.typed?\n          t(:map_value, attribute.name, t(:\"to_#{attribute.type}\"))\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit hash attribute\n      #\n      # @param [Header::Attribute::Hash] attribute\n      #\n      # @api private\n      def visit_hash(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, row_proc)\n        end\n      end\n\n      # Visit combined attribute\n      #\n      # @api private\n      def visit_combined(attribute)\n        op = with_row_proc(attribute) do |row_proc|\n          array_proc =\n            if attribute.type == :hash\n              t(:map_array, row_proc) >> t(:get, 0)\n            else\n              t(:map_array, row_proc)\n            end\n\n          t(:map_value, attribute.name, array_proc)\n        end\n\n        if op\n          op\n        elsif attribute.type == :hash\n          t(:map_value, attribute.name, t(:get, 0))\n        end\n      end\n\n      # Visit array attribute\n      #\n      # @param [Header::Attribute::Array] attribute\n      #\n      # @api private\n      def visit_array(attribute)\n        with_row_proc(attribute) do |row_proc|\n          t(:map_value, attribute.name, t(:map_array, row_proc))\n        end\n      end\n\n      # Visit wrapped hash attribute\n      #\n      # :nest transformation is added to handle wrapping\n      #\n      # @param [Header::Attribute::Wrap] attribute\n      #\n      # @api private\n      def visit_wrap(attribute)\n        name = attribute.name\n        keys = attribute.tuple_keys\n\n        compose do |ops|\n          ops << t(:nest, name, keys)\n          ops << visit_hash(attribute)\n        end\n      end\n\n      # Visit unwrap attribute\n      #\n      # :unwrap transformation is added to handle unwrapping\n      #\n      # @param [Header::Attributes::Unwrap] attribute\n      #\n      # @api private\n      def visit_unwrap(attribute)\n        name = attribute.name\n        keys = attribute.pop_keys\n\n        compose do |ops|\n          ops << visit_hash(attribute)\n          ops << t(:unwrap, name, keys)\n        end\n      end\n\n      # Visit group hash attribute\n      #\n      # :group transformation is added to handle grouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Group] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_group(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.tuple_keys\n\n          others = header.preprocessed\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit ungroup attribute\n      #\n      # :ungroup transforation is added to handle ungrouping during preprocessing.\n      # Otherwise we simply use array visitor for the attribute.\n      #\n      # @param [Header::Attribute::Ungroup] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_ungroup(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          header = attribute.header\n          keys = attribute.pop_keys\n\n          others = header.postprocessed\n\n          compose do |ops|\n            ops << others.map { |attr|\n              t(:map_array, t(:map_value, name, visit(attr, true)))\n            }\n            ops << t(:ungroup, name, keys)\n          end\n        else\n          visit_array(attribute)\n        end\n      end\n\n      # Visit fold hash attribute\n      #\n      # :fold transformation is added to handle folding during preprocessing.\n      #\n      # @param [Header::Attribute::Fold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      def visit_fold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        if preprocess\n          name = attribute.name\n          keys = attribute.tuple_keys\n\n          compose do |ops|\n            ops << t(:group, name, keys)\n            ops << t(:map_array, t(:map_value, name, t(:filter_empty)))\n            ops << t(:map_array, t(:fold, name, keys.first))\n          end\n        end\n      end\n\n      # Visit unfold hash attribute\n      #\n      # :unfold transformation is added to handle unfolding during preprocessing.\n      #\n      # @param [Header::Attribute::Unfold] attribute\n      # @param [Boolean] preprocess true if we are building a relation preprocessing\n      #                             function that is applied to the whole relation\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter\n        return unless preprocess\n\n        name = attribute.name\n        header = attribute.header\n        keys = attribute.pop_keys\n        key = keys.first\n\n        others = header.postprocessed\n\n        compose do |ops|\n          ops << others.map { |attr|\n            t(:map_array, t(:map_value, name, visit(attr, true)))\n          }\n          ops << t(:map_array, t(:map_value, name, t(:insert_key, key)))\n          ops << t(:map_array, t(:reject_keys, [key] - [name]))\n          ops << t(:ungroup, name, [key])\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Visit excluded attribute\n      #\n      # @param [Header::Attribute::Exclude] attribute\n      #\n      # @api private\n      def visit_exclude(attribute)\n        t(:reject_keys, [attribute.name])\n      end\n\n      # @api private\n      def combined_args(attribute)\n        other = attribute.header.combined\n\n        if other.any?\n          children = other.map(&method(:combined_args))\n          [attribute.name, attribute.meta[:keys], children]\n        else\n          [attribute.name, attribute.meta[:keys]]\n        end\n      end\n\n      # Build row_proc\n      #\n      # This transproc function is applied to each row in a dataset\n      #\n      # @api private\n      def initialize_row_proc\n        @row_proc = compose { |ops|\n          alias_handler = header.copy_keys ? :copy_keys : :rename_keys\n          process_header_keys(ops)\n\n          ops << t(alias_handler, mapping) if header.aliased?\n          ops << header.map { |attr| visit(attr) }\n          ops << t(:constructor_inject, model) if model\n        }\n      end\n\n      # Process row_proc header keys\n      #\n      # @api private\n      def process_header_keys(ops)\n        if header.reject_keys\n          all_keys = header.tuple_keys + header.non_primitives.map(&:key)\n          ops << t(:accept_keys, all_keys)\n        end\n        ops\n      end\n\n      # Yield row proc for a given attribute if any\n      #\n      # @param [Header::Attribute] attribute\n      #\n      # @api private\n      def with_row_proc(attribute)\n        row_proc = row_proc_from(attribute)\n        yield(row_proc) if row_proc\n      end\n\n      # Build a row_proc from a given attribute\n      #\n      # This is used by embedded attribute visitors\n      #\n      # @api private\n      def row_proc_from(attribute)\n        new(mapper, attribute.header).row_proc\n      end\n\n      # Return a new instance of the processor\n      #\n      # @api private\n      def new(*args)\n        self.class.new(*args)\n      end\n\n      # @api private\n      def t(*args)\n        Functions[*args]\n      end\n    end\n    # rubocop:enable Metrics/ClassLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "visit_unfold", "signature": "def visit_unfold(attribute, preprocess = false) # rubocop:disable Style/OptionalBooleanParameter", "start_line": 323, "end_line": 341}, "metadata": {"module": "ROM", "class_name": "Processor", "class_signature": "class Processor"}, "task_id": 440}
{"function_name": "associate", "file_path": "rom/core/lib/rom/associations/many_to_many.rb", "focal_code": "def associate(children, parent)\n        ((spk, sfk), (tfk, tpk)) = join_key_map\n\n        case parent\n        when Array\n          parent.map { |p| associate(children, p) }.flatten(1)\n        else\n          children.map { |tuple|\n            { sfk => tuple.fetch(spk), tfk => parent.fetch(tpk) }\n          }\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/associations/abstract'\n\nmodule ROM\n  module Associations\n    # Abstract many-to-many association type\n    #\n    # @api public\n    class ManyToMany < Abstract\n      # @!attribute [r] join_relation\n      #   @return [Relation] Intermediate join relation\n      attr_reader :join_relation\n\n      # @api private\n      def initialize(*, **)\n        super\n        @join_relation = relations[through]\n      end\n\n      # Adapters should implement this method\n      #\n      # @abstract\n      #\n      # @api public\n      def call(*)\n        raise NotImplementedError\n      end\n\n      # Return configured or inferred FK name\n      #\n      # @return [Symbol]\n      #\n      # @api public\n      def foreign_key\n        definition.foreign_key || join_relation.foreign_key(source.name)\n      end\n\n      # Return join-relation name\n      #\n      # @return [Symbol]\n      #\n      # @api public\n      def through\n        definition.through\n      end\n\n      # Return parent's relation combine keys\n      #\n      # @return [Hash<Symbol=>Symbol>]\n      #\n      # @api private\n      def parent_combine_keys\n        target.associations[source.name].combine_keys.to_a.flatten(1)\n      end\n\n      # Associate child tuples with the provided parent\n      #\n      # @param [Array<Hash>] children An array with child tuples\n      # @param [Array,Hash] parent An array with parent tuples or a single tuple\n      #\n      # @return [Array<Hash>]\n      #\n      # @api private\n      def associate(children, parent)\n        ((spk, sfk), (tfk, tpk)) = join_key_map\n\n        case parent\n        when Array\n          parent.map { |p| associate(children, p) }.flatten(1)\n        else\n          children.map { |tuple|\n            { sfk => tuple.fetch(spk), tfk => parent.fetch(tpk) }\n          }\n        end\n      end\n\n      protected\n\n      # Primary key name on the source side\n      #\n      # @return [Symbol]\n      #\n      # @api protected\n      def source_key\n        source.primary_key\n      end\n\n      # Foreign key name on the target side\n      #\n      # @return [Symbol]\n      #\n      # @api protected\n      def target_key\n        foreign_key\n      end\n\n      # Return association for many-to-many-through\n      #\n      # @return [Association]\n      #\n      # @api protected\n      def join_assoc\n        if join_relation.associations.key?(through.assoc_name)\n          join_relation.associations[through.assoc_name]\n        else\n          join_relation.associations[through.target]\n        end\n      end\n\n      # Return a [pk, fk] mapping for source/target relations\n      #\n      # @return [Array<Symbol>]\n      #\n      # @api protected\n      def join_key_map\n        left = super\n        right = join_assoc.join_key_map\n\n        [left, right]\n      end\n\n      memoize :foreign_key, :join_assoc, :join_key_map\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "associate", "signature": "def associate(children, parent)", "start_line": 66, "end_line": 77}, "metadata": {"module": "ROM", "class_name": "ManyToMany", "class_signature": "class ManyToMany < < Abstract"}, "task_id": 441}
{"function_name": "join", "file_path": "rom/core/lib/rom/memory/dataset.rb", "focal_code": "def join(*args)\n        left, right = args.size > 1 ? args : [self, args.first]\n\n        join_map = left.each_with_object({}) { |tuple, h|\n          others = right.to_a.find_all { |t| tuple.to_a.intersect?(t.to_a) }\n          (h[tuple] ||= []).concat(others)\n        }\n\n        tuples = left.flat_map { |tuple|\n          join_map[tuple].map { |other| tuple.merge(other) }\n        }\n\n        self.class.new(tuples, **options)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/array_dataset'\n\nmodule ROM\n  module Memory\n    # In-memory dataset\n    #\n    # This class can be used as a base class for other adapters.\n    #\n    # @api public\n    class Dataset\n      include ArrayDataset\n\n      # Join with other datasets\n      #\n      # @param [Array<Dataset>] args A list of dataset to join with\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize\n      def join(*args)\n        left, right = args.size > 1 ? args : [self, args.first]\n\n        join_map = left.each_with_object({}) { |tuple, h|\n          others = right.to_a.find_all { |t| tuple.to_a.intersect?(t.to_a) }\n          (h[tuple] ||= []).concat(others)\n        }\n\n        tuples = left.flat_map { |tuple|\n          join_map[tuple].map { |other| tuple.merge(other) }\n        }\n\n        self.class.new(tuples, **options)\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Restrict a dataset\n      #\n      # @param [Hash] criteria A hash with conditions\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def restrict(criteria = nil, &)\n        return find_all(&) unless criteria\n\n        find_all do |tuple|\n          criteria.all? do |k, v|\n            case v\n            when ::Array then v.include?(tuple[k])\n            when ::Regexp then tuple[k].match(v)\n            else tuple[k].eql?(v)\n            end\n          end\n        end\n      end\n\n      # Project a dataset\n      #\n      # @param [Array<Symbol>] names A list of attribute names\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def project(*names)\n        map { |tuple| tuple.select { |key| names.include?(key) } }\n      end\n\n      # Sort a dataset\n      #\n      # @param [Array<Symbol>] fields\n      #   Names of fields to order tuples by\n      #\n      # @option [Boolean] :nils_first (false)\n      #   Whether `nil` values should be placed before others\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def order(*fields)\n        nils_first = fields.pop[:nils_first] if fields.last.is_a?(Hash)\n\n        sort do |a, b|\n          fields # finds the first difference between selected fields of tuples\n            .map { |n| __compare__ a[n], b[n], nils_first }\n            .detect(-> { 0 }) { |r| r != 0 }\n        end\n      end\n\n      # Insert tuple into a dataset\n      #\n      # @param [Hash] tuple A new tuple for insertion\n      #\n      # @api public\n      #\n      # @return [Dataset]\n      def insert(tuple)\n        data << tuple\n        self\n      end\n      alias_method :<<, :insert\n\n      # Delete tuples from a dataset\n      #\n      # @param [Hash] tuple A new tuple for deletion\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def delete(tuple)\n        data.delete(tuple)\n        self\n      end\n\n      private\n\n      # Compares two values, that are either comparable, or can be nils\n      #\n      # @api private\n      def __compare__(a, b, nils_first)\n        return a <=> b unless a.nil? ^ b.nil?\n\n        nils_first ^ b.nil? ? -1 : 1\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "join", "signature": "def join(*args)", "start_line": 23, "end_line": 36}, "metadata": {"module": "ROM", "class_name": "Dataset", "class_signature": "class Dataset"}, "task_id": 442}
{"function_name": "restrict", "file_path": "rom/core/lib/rom/memory/dataset.rb", "focal_code": "def restrict(criteria = nil, &)\n        return find_all(&) unless criteria\n\n        find_all do |tuple|\n          criteria.all? do |k, v|\n            case v\n            when ::Array then v.include?(tuple[k])\n            when ::Regexp then tuple[k].match(v)\n            else tuple[k].eql?(v)\n            end\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/array_dataset'\n\nmodule ROM\n  module Memory\n    # In-memory dataset\n    #\n    # This class can be used as a base class for other adapters.\n    #\n    # @api public\n    class Dataset\n      include ArrayDataset\n\n      # Join with other datasets\n      #\n      # @param [Array<Dataset>] args A list of dataset to join with\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize\n      def join(*args)\n        left, right = args.size > 1 ? args : [self, args.first]\n\n        join_map = left.each_with_object({}) { |tuple, h|\n          others = right.to_a.find_all { |t| tuple.to_a.intersect?(t.to_a) }\n          (h[tuple] ||= []).concat(others)\n        }\n\n        tuples = left.flat_map { |tuple|\n          join_map[tuple].map { |other| tuple.merge(other) }\n        }\n\n        self.class.new(tuples, **options)\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Restrict a dataset\n      #\n      # @param [Hash] criteria A hash with conditions\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def restrict(criteria = nil, &)\n        return find_all(&) unless criteria\n\n        find_all do |tuple|\n          criteria.all? do |k, v|\n            case v\n            when ::Array then v.include?(tuple[k])\n            when ::Regexp then tuple[k].match(v)\n            else tuple[k].eql?(v)\n            end\n          end\n        end\n      end\n\n      # Project a dataset\n      #\n      # @param [Array<Symbol>] names A list of attribute names\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def project(*names)\n        map { |tuple| tuple.select { |key| names.include?(key) } }\n      end\n\n      # Sort a dataset\n      #\n      # @param [Array<Symbol>] fields\n      #   Names of fields to order tuples by\n      #\n      # @option [Boolean] :nils_first (false)\n      #   Whether `nil` values should be placed before others\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def order(*fields)\n        nils_first = fields.pop[:nils_first] if fields.last.is_a?(Hash)\n\n        sort do |a, b|\n          fields # finds the first difference between selected fields of tuples\n            .map { |n| __compare__ a[n], b[n], nils_first }\n            .detect(-> { 0 }) { |r| r != 0 }\n        end\n      end\n\n      # Insert tuple into a dataset\n      #\n      # @param [Hash] tuple A new tuple for insertion\n      #\n      # @api public\n      #\n      # @return [Dataset]\n      def insert(tuple)\n        data << tuple\n        self\n      end\n      alias_method :<<, :insert\n\n      # Delete tuples from a dataset\n      #\n      # @param [Hash] tuple A new tuple for deletion\n      #\n      # @return [Dataset]\n      #\n      # @api public\n      def delete(tuple)\n        data.delete(tuple)\n        self\n      end\n\n      private\n\n      # Compares two values, that are either comparable, or can be nils\n      #\n      # @api private\n      def __compare__(a, b, nils_first)\n        return a <=> b unless a.nil? ^ b.nil?\n\n        nils_first ^ b.nil? ? -1 : 1\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "restrict", "signature": "def restrict(criteria = nil, &)", "start_line": 46, "end_line": 58}, "metadata": {"module": "ROM", "class_name": "Dataset", "class_signature": "class Dataset"}, "task_id": 443}
{"function_name": "initialize", "file_path": "rom/core/lib/rom/setup/finalize.rb", "focal_code": "def initialize(options)\n      @gateways = options.fetch(:gateways)\n\n      @relation_classes = options.fetch(:relation_classes)\n      @command_classes = options.fetch(:command_classes)\n\n      mappers = options.fetch(:mappers, [])\n      @mapper_classes = mappers.select { |mapper| mapper.is_a?(Class) }\n      @mapper_objects = (mappers - @mapper_classes).reduce(:merge) || {}\n\n      @config = options.fetch(:config)\n      @notifications = options.fetch(:notifications)\n\n      @plugins = options.fetch(:plugins)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/relation'\nrequire 'rom/command'\n\nrequire 'rom/registry'\nrequire 'rom/command_registry'\nrequire 'rom/mapper_registry'\n\nrequire 'rom/container'\nrequire 'rom/setup/finalize/finalize_commands'\nrequire 'rom/setup/finalize/finalize_relations'\nrequire 'rom/setup/finalize/finalize_mappers'\n\n# temporary\nrequire 'rom/configuration_dsl/relation'\n\nmodule ROM\n  # This giant builds an container using defined classes for core parts of ROM\n  #\n  # It is used by the setup object after it's done gathering class definitions\n  #\n  # @private\n  class Finalize\n    attr_reader :gateways\n\n    attr_reader :repo_adapter\n\n    attr_reader :relation_classes\n\n    attr_reader :mapper_classes\n\n    attr_reader :mapper_objects\n\n    attr_reader :command_classes\n\n    attr_reader :plugins\n\n    attr_reader :config\n\n    attr_reader :notifications\n\n    # @api private\n    def initialize(options)\n      @gateways = options.fetch(:gateways)\n\n      @relation_classes = options.fetch(:relation_classes)\n      @command_classes = options.fetch(:command_classes)\n\n      mappers = options.fetch(:mappers, [])\n      @mapper_classes = mappers.select { |mapper| mapper.is_a?(Class) }\n      @mapper_objects = (mappers - @mapper_classes).reduce(:merge) || {}\n\n      @config = options.fetch(:config)\n      @notifications = options.fetch(:notifications)\n\n      @plugins = options.fetch(:plugins)\n    end\n\n    # Return adapter identifier for a given gateway object\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def adapter_for(gateway)\n      gateways[gateway].adapter\n    end\n\n    # Run the finalization process\n    #\n    # This creates relations, mappers and commands\n    #\n    # @return [Container]\n    #\n    # @api private\n    def run!\n      mappers = load_mappers\n      relations = load_relations(mappers)\n      commands = load_commands(relations)\n\n      container = Container.new(gateways, relations, mappers, commands)\n      container.freeze\n      container\n    end\n\n    private\n\n    # Build entire relation registry from all known relation subclasses\n    #\n    # This includes both classes created via DSL and explicit definitions\n    #\n    # @api private\n    def load_relations(mappers)\n      global_plugins = plugins.select { |p| p.type == :relation || p.type == :schema }\n\n      FinalizeRelations.new(\n        gateways,\n        relation_classes,\n        mappers: mappers,\n        plugins: global_plugins,\n        notifications: notifications\n      ).run!\n    end\n\n    # @api private\n    def load_mappers\n      FinalizeMappers.new(mapper_classes, mapper_objects).run!\n    end\n\n    # Build entire command registries\n    #\n    # This includes both classes created via DSL and explicit definitions\n    #\n    # @api private\n    def load_commands(relations)\n      FinalizeCommands.new(relations, gateways, command_classes, notifications).run!\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(options)", "start_line": 44, "end_line": 58}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 444}
{"function_name": "load_relations", "file_path": "rom/core/lib/rom/setup/finalize.rb", "focal_code": "def load_relations(mappers)\n      global_plugins = plugins.select { |p| p.type == :relation || p.type == :schema }\n\n      FinalizeRelations.new(\n        gateways,\n        relation_classes,\n        mappers: mappers,\n        plugins: global_plugins,\n        notifications: notifications\n      ).run!\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/relation'\nrequire 'rom/command'\n\nrequire 'rom/registry'\nrequire 'rom/command_registry'\nrequire 'rom/mapper_registry'\n\nrequire 'rom/container'\nrequire 'rom/setup/finalize/finalize_commands'\nrequire 'rom/setup/finalize/finalize_relations'\nrequire 'rom/setup/finalize/finalize_mappers'\n\n# temporary\nrequire 'rom/configuration_dsl/relation'\n\nmodule ROM\n  # This giant builds an container using defined classes for core parts of ROM\n  #\n  # It is used by the setup object after it's done gathering class definitions\n  #\n  # @private\n  class Finalize\n    attr_reader :gateways\n\n    attr_reader :repo_adapter\n\n    attr_reader :relation_classes\n\n    attr_reader :mapper_classes\n\n    attr_reader :mapper_objects\n\n    attr_reader :command_classes\n\n    attr_reader :plugins\n\n    attr_reader :config\n\n    attr_reader :notifications\n\n    # @api private\n    def initialize(options)\n      @gateways = options.fetch(:gateways)\n\n      @relation_classes = options.fetch(:relation_classes)\n      @command_classes = options.fetch(:command_classes)\n\n      mappers = options.fetch(:mappers, [])\n      @mapper_classes = mappers.select { |mapper| mapper.is_a?(Class) }\n      @mapper_objects = (mappers - @mapper_classes).reduce(:merge) || {}\n\n      @config = options.fetch(:config)\n      @notifications = options.fetch(:notifications)\n\n      @plugins = options.fetch(:plugins)\n    end\n\n    # Return adapter identifier for a given gateway object\n    #\n    # @return [Symbol]\n    #\n    # @api private\n    def adapter_for(gateway)\n      gateways[gateway].adapter\n    end\n\n    # Run the finalization process\n    #\n    # This creates relations, mappers and commands\n    #\n    # @return [Container]\n    #\n    # @api private\n    def run!\n      mappers = load_mappers\n      relations = load_relations(mappers)\n      commands = load_commands(relations)\n\n      container = Container.new(gateways, relations, mappers, commands)\n      container.freeze\n      container\n    end\n\n    private\n\n    # Build entire relation registry from all known relation subclasses\n    #\n    # This includes both classes created via DSL and explicit definitions\n    #\n    # @api private\n    def load_relations(mappers)\n      global_plugins = plugins.select { |p| p.type == :relation || p.type == :schema }\n\n      FinalizeRelations.new(\n        gateways,\n        relation_classes,\n        mappers: mappers,\n        plugins: global_plugins,\n        notifications: notifications\n      ).run!\n    end\n\n    # @api private\n    def load_mappers\n      FinalizeMappers.new(mapper_classes, mapper_objects).run!\n    end\n\n    # Build entire command registries\n    #\n    # This includes both classes created via DSL and explicit definitions\n    #\n    # @api private\n    def load_commands(relations)\n      FinalizeCommands.new(relations, gateways, command_classes, notifications).run!\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_relations", "signature": "def load_relations(mappers)", "start_line": 93, "end_line": 103}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 445}
{"function_name": "load_entities", "file_path": "rom/core/lib/rom/setup/auto_registration.rb", "focal_code": "def load_entities(entity)\n      Dir[globs[entity]].map do |file|\n        require file\n        klass_name =\n          case namespace\n          when String\n            AutoRegistrationStrategies::CustomNamespace.new(\n              namespace: namespace, file: file, directory: directory\n            ).call\n          when TrueClass\n            AutoRegistrationStrategies::WithNamespace.new(\n              file: file, directory: directory\n            ).call\n          when FalseClass\n            AutoRegistrationStrategies::NoNamespace.new(\n              file: file, directory: directory, entity: component_dirs.fetch(entity)\n            ).call\n          end\n\n        Inflector.constantize(klass_name)\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire 'pathname'\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/types'\nrequire 'rom/initializer'\nrequire 'rom/setup/auto_registration_strategies/no_namespace'\nrequire 'rom/setup/auto_registration_strategies/with_namespace'\nrequire 'rom/setup/auto_registration_strategies/custom_namespace'\n\nmodule ROM\n  # AutoRegistration is used to load component files automatically from the provided directory path\n  #\n  # @api public\n  class AutoRegistration\n    extend Initializer\n\n    NamespaceType = Types::Strict::Bool | Types::Strict::String\n\n    PathnameType = Types.Constructor(Pathname, &Kernel.method(:Pathname))\n\n    DEFAULT_MAPPING = {\n      relations: :relations,\n      mappers: :mappers,\n      commands: :commands\n    }.freeze\n\n    # @!attribute [r] directory\n    #   @return [Pathname] The root path\n    param :directory, type: PathnameType\n\n    # @!attribute [r] namespace\n    #   @return [Boolean,String]\n    #     The name of the top level namespace or true/false which\n    #     enables/disables default top level namespace inferred from the dir name\n    option :namespace, type: NamespaceType, default: -> { true }\n\n    # @!attribute [r] component_dirs\n    #   @return [Hash] component => dir-name map\n    option :component_dirs, type: Types::Strict::Hash, default: -> { DEFAULT_MAPPING }\n\n    # @!attribute [r] globs\n    #   @return [Hash] File globbing functions for each component dir\n    option :globs, default: lambda {\n      component_dirs.transform_values { |path|\n        directory.join(\"#{path}/**/*.rb\")\n      }\n    }\n\n    # Load relation files\n    #\n    # @api private\n    def relations\n      load_entities(:relations)\n    end\n\n    # Load command files\n    #\n    # @api private\n    def commands\n      load_entities(:commands)\n    end\n\n    # Load mapper files\n    #\n    # @api private\n    def mappers\n      load_entities(:mappers)\n    end\n\n    private\n\n    # Load given component files\n    #\n    # @api private\n    def load_entities(entity)\n      Dir[globs[entity]].map do |file|\n        require file\n        klass_name =\n          case namespace\n          when String\n            AutoRegistrationStrategies::CustomNamespace.new(\n              namespace: namespace, file: file, directory: directory\n            ).call\n          when TrueClass\n            AutoRegistrationStrategies::WithNamespace.new(\n              file: file, directory: directory\n            ).call\n          when FalseClass\n            AutoRegistrationStrategies::NoNamespace.new(\n              file: file, directory: directory, entity: component_dirs.fetch(entity)\n            ).call\n          end\n\n        Inflector.constantize(klass_name)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_entities", "signature": "def load_entities(entity)", "start_line": 78, "end_line": 99}, "metadata": {"module": "ROM", "class_name": "AutoRegistration", "class_signature": "class AutoRegistration"}, "task_id": 446}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/graph.rb", "focal_code": "def call(*args)\n        left = root.call(*args)\n\n        right = nodes.map { |node|\n          response =\n            if node.lazy?\n              node.call(args.first, left)\n            else\n              node.call(left)\n            end\n\n          if node.one? && !node.graph?\n            [response]\n          else\n            response\n          end\n        }\n\n        if one?\n          [[left], right]\n        else\n          [left, right]\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/initializer'\nrequire 'rom/pipeline'\nrequire 'rom/commands/graph/class_interface'\n\nmodule ROM\n  module Commands\n    # Command graph\n    #\n    # @api private\n    class Graph\n      extend Initializer\n      include Dry::Equalizer(:root, :nodes)\n\n      extend ClassInterface\n\n      include Pipeline\n      include Pipeline::Proxy\n\n      # @attr_reader [Command] root The root command\n      param :root\n\n      # @attr_reader [Array<Command>] nodes The child commands\n      param :nodes\n\n      alias_method :left, :root\n      alias_method :right, :nodes\n\n      # @attr_reader [Symbol] root's relation name\n      option :name, default: -> { root.name }\n\n      option :mappers, default: -> { MapperRegistry.new }\n\n      # Calls root and all nodes with the result from root\n      #\n      # Graph results are mappable through `combine` operation in mapper DSL\n      #\n      # @example\n      #   create_user = rom.commands[:users].create\n      #   create_task = rom.commands[:tasks].create\n      #\n      #   command = create_user\n      #     .curry(name: 'Jane')\n      #     .combine(create_task.curry(title: 'Task'))\n      #\n      #   command.call\n      #\n      # @return [Array] nested array with command results\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/PerceivedComplexity\n      def call(*args)\n        left = root.call(*args)\n\n        right = nodes.map { |node|\n          response =\n            if node.lazy?\n              node.call(args.first, left)\n            else\n              node.call(left)\n            end\n\n          if node.one? && !node.graph?\n            [response]\n          else\n            response\n          end\n        }\n\n        if one?\n          [[left], right]\n        else\n          [left, right]\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      # @api private\n      def graph?\n        true\n      end\n\n      private\n\n      # @api public\n      def composite_class\n        Command::Composite\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 54, "end_line": 77}, "metadata": {"module": "ROM", "class_name": "Graph", "class_signature": "class Graph"}, "task_id": 447}
{"function_name": "method_missing", "file_path": "rom/core/lib/rom/commands/lazy.rb", "focal_code": "def method_missing(name, ...)\n        if command.respond_to?(name)\n          response = command.public_send(name, ...)\n\n          if response.instance_of?(command.class)\n            self.class.new(response, evaluator, command_proc)\n          else\n            response\n          end\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/commands/composite'\nrequire 'rom/commands/graph'\n\nmodule ROM\n  module Commands\n    # Lazy command wraps another command and evaluates its input when called\n    #\n    # @api private\n    class Lazy\n      include Dry::Equalizer(:command, :evaluator)\n\n      # @attr_reader [Command] command The wrapped command\n      attr_reader :command\n\n      alias_method :unwrap, :command\n\n      # @attr_reader [Proc] evaluator The proc that will evaluate the input\n      attr_reader :evaluator\n\n      attr_reader :command_proc\n\n      # @api private\n      def self.[](command)\n        case command\n        when Commands::Create then Lazy::Create\n        when Commands::Update then Lazy::Update\n        when Commands::Delete then Lazy::Delete\n        else\n          self\n        end\n      end\n\n      # @api private\n      def initialize(command, evaluator, command_proc = nil)\n        @command = command\n        @evaluator = evaluator\n        @command_proc = command_proc || proc { |*| command }\n      end\n\n      # Evaluate command's input using the input proc and pass to command\n      #\n      # @return [Array,Hash]\n      #\n      # @api public\n      def call(*_args)\n        raise NotImplementedError\n      end\n\n      # Compose a lazy command with another one\n      #\n      # @see Commands::Abstract#>>\n      #\n      # @return [Composite]\n      #\n      # @api public\n      def >>(other)\n        Composite.new(self, other)\n      end\n\n      # Combine with other lazy commands\n      #\n      # @see Abstract#combine\n      #\n      # @return [Graph]\n      #\n      # @api public\n      def combine(*others)\n        Graph.new(self, others)\n      end\n\n      # @api private\n      def lazy?\n        true\n      end\n\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        super || command.respond_to?(name)\n      end\n\n      private\n\n      # @api private\n      def method_missing(name, ...)\n        if command.respond_to?(name)\n          response = command.public_send(name, ...)\n\n          if response.instance_of?(command.class)\n            self.class.new(response, evaluator, command_proc)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n  end\nend\n\nrequire 'rom/commands/lazy/create'\nrequire 'rom/commands/lazy/update'\nrequire 'rom/commands/lazy/delete'\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, ...)", "start_line": 86, "end_line": 98}, "metadata": {"module": "ROM", "class_name": "Lazy", "class_signature": "class Lazy"}, "task_id": 448}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/composite.rb", "focal_code": "def call(*args)\n        response = left.call(*args)\n\n        if response.nil? || (many? && response.empty?)\n          return one? ? nil : EMPTY_ARRAY\n        end\n\n        if one? && !graph?\n          if right.is_a?(Command) || right.is_a?(Commands::Composite)\n            right.call([response].first)\n          else\n            right.call([response]).first\n          end\n        elsif one? && graph?\n          right.call(response).first\n        else\n          right.call(response)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/pipeline'\n\nmodule ROM\n  module Commands\n    # Composite command that consists of left and right commands\n    #\n    # @api public\n    class Composite < Pipeline::Composite\n      # Calls the composite command\n      #\n      # Right command is called with a result from the left one\n      #\n      # @return [Object]\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def call(*args)\n        response = left.call(*args)\n\n        if response.nil? || (many? && response.empty?)\n          return one? ? nil : EMPTY_ARRAY\n        end\n\n        if one? && !graph?\n          if right.is_a?(Command) || right.is_a?(Commands::Composite)\n            right.call([response].first)\n          else\n            right.call([response]).first\n          end\n        elsif one? && graph?\n          right.call(response).first\n        else\n          right.call(response)\n        end\n      end\n      alias_method :[], :call\n      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      # @api private\n      def graph?\n        left.is_a?(Graph)\n      end\n\n      # @api private\n      def result\n        left.result\n      end\n\n      # @api private\n      def decorate?(response)\n        super || response.is_a?(Graph)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 20, "end_line": 38}, "metadata": {"module": "ROM", "class_name": "Composite", "class_signature": "class Composite < < Pipeline::Composite"}, "task_id": 449}
{"function_name": "create_class", "file_path": "rom/core/lib/rom/commands/class_interface.rb", "focal_code": "def create_class(name, type, &)\n        klass = Dry::Core::ClassBuilder\n          .new(name: \"#{Inflector.classify(type)}[:#{name}]\", parent: type)\n          .call\n\n        if block_given?\n          yield(klass)\n        else\n          klass\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nmodule ROM\n  # Base command class with factory class-level interface and setup-related logic\n  #\n  # @private\n  class Command\n    module ClassInterface\n      # This hook sets up default class state\n      #\n      # @api private\n      def inherited(klass)\n        super\n        klass.instance_variable_set(:@before, before.dup)\n        klass.instance_variable_set(:@after, after.dup)\n      end\n\n      # Sets up the base class\n      #\n      # @api private\n      def self.extended(klass)\n        super\n        klass.set_hooks(:before, [])\n        klass.set_hooks(:after, [])\n      end\n\n      # Return adapter specific sub-class based on the adapter identifier\n      #\n      # This is a syntax sugar to make things consistent\n      #\n      # @example\n      #   ROM::Commands::Create[:memory]\n      #   # => ROM::Memory::Commands::Create\n      #\n      # @param [Symbol] adapter identifier\n      #\n      # @return [Class]\n      #\n      # @api public\n      def [](adapter)\n        adapter_namespace(adapter).const_get(Inflector.demodulize(name))\n      end\n\n      # Return namespaces that contains command subclasses of a specific adapter\n      #\n      # @param [Symbol] adapter identifier\n      #\n      # @return [Module]\n      #\n      # @api private\n      def adapter_namespace(adapter)\n        ROM.adapters.fetch(adapter).const_get(:Commands)\n      rescue KeyError\n        raise AdapterNotPresentError.new(adapter, :relation)\n      end\n\n      # Build a command class for a specific relation with options\n      #\n      # @example\n      #   class CreateUser < ROM::Commands::Create[:memory]\n      #   end\n      #\n      #   command = CreateUser.build(rom.relations[:users])\n      #\n      # @param [Relation] relation\n      # @param [Hash] options\n      #\n      # @return [Command]\n      #\n      # @api public\n      def build(relation, **options)\n        new(relation, **self.options, **options)\n      end\n\n      # Create a command class with a specific type\n      #\n      # @param [Symbol] name Command name\n      # @param [Class] type Command class\n      #\n      # @yield [Class]\n      #\n      # @return [Class, Object]\n      #\n      # @api public\n      def create_class(name, type, &)\n        klass = Dry::Core::ClassBuilder\n          .new(name: \"#{Inflector.classify(type)}[:#{name}]\", parent: type)\n          .call\n\n        if block_given?\n          yield(klass)\n        else\n          klass\n        end\n      end\n\n      # Use a configured plugin in this relation\n      #\n      # @example\n      #   class CreateUser < ROM::Commands::Create[:memory]\n      #     use :pagintion\n      #\n      #     per_page 30\n      #   end\n      #\n      # @param [Symbol] plugin\n      # @param [Hash] options\n      # @option options [Symbol] :adapter (:default) first adapter to check for plugin\n      #\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:command].fetch(plugin, adapter).apply_to(self, **options)\n      end\n\n      # Extend a command class with relation view methods\n      #\n      # @param [Relation] relation\n      #\n      # @return [Class]\n      #\n      # @api public\n      def extend_for_relation(relation)\n        include(relation_methods_mod(relation.class))\n      end\n\n      # Set before-execute hooks\n      #\n      # @overload before(hook)\n      #   Set an before hook as a method name\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       before :my_hook\n      #\n      #       def my_hook(tuple, *)\n      #         puts \"hook called#\n      #       end\n      #     end\n      #\n      # @overload before(hook_opts)\n      #   Set an before hook as a method name with arguments\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       before my_hook: { arg1: 1, arg2: 2 }\n      #\n      #       def my_hook(tuple, arg1:, arg2:)\n      #         puts \"hook called with args: #{arg1} and #{arg2}\"\n      #       end\n      #     end\n      #\n      #   @param [Hash<Symbol=>Hash>] hook Options with method name and pre-set args\n      #\n      # @return [Array<Hash, Symbol>] A list of all configured before hooks\n      #\n      # @api public\n      def before(*hooks)\n        if hooks.empty?\n          @before\n        else\n          set_hooks(:before, hooks)\n        end\n      end\n\n      # Set after-execute hooks\n      #\n      # @overload after(hook)\n      #   Set an after hook as a method name\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       after :my_hook\n      #\n      #       def my_hook(tuple, *)\n      #         puts \"hook called#\n      #       end\n      #     end\n      #\n      # @overload after(hook_opts)\n      #   Set an after hook as a method name with arguments\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       after my_hook: { arg1: 1, arg1: 2 }\n      #\n      #       def my_hook(tuple, arg1:, arg2:)\n      #         puts \"hook called with args: #{arg1} and #{arg2}\"\n      #       end\n      #     end\n      #\n      #   @param [Hash<Symbol=>Hash>] hook Options with method name and pre-set args\n      #\n      # @return [Array<Hash, Symbol>] A list of all configured after hooks\n      #\n      # @api public\n      def after(*hooks)\n        if hooks.empty?\n          @after\n        else\n          set_hooks(:after, hooks)\n        end\n      end\n\n      # Set new or more hooks\n      #\n      # @api private\n      def set_hooks(type, hooks)\n        ivar = :\"@#{type}\"\n\n        if instance_variable_defined?(ivar)\n          instance_variable_get(ivar).concat(hooks)\n        else\n          instance_variable_set(ivar, hooks)\n        end\n      end\n\n      # Return default name of the command class based on its name\n      #\n      # During setup phase this is used by defalut as `register_as` option\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      def default_name\n        Inflector.underscore(Inflector.demodulize(name)).to_sym\n      end\n\n      # Return default options based on class macros\n      #\n      # @return [Hash]\n      #\n      # @api private\n      def options\n        { input: input, result: result, before: before, after: after }\n      end\n\n      # @api private\n      def relation_methods_mod(relation_class)\n        Module.new do\n          relation_class.view_methods.each do |meth|\n            module_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n              def #{meth}(*args, **kwargs)                                 # def create(*args, **kwargs)\n                response = relation.public_send(:#{meth}, *args, **kwargs) #   response = relation.public_send(:create, *args, **kwargs)\n                                                                           #\n                if response.is_a?(relation.class)                          #   if response.is_a?(relation.class)\n                  new(response)                                            #     new(response)\n                else                                                       #   else\n                  response                                                 #     response\n                end                                                        #   end\n              end                                                          # end\n            RUBY\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "create_class", "signature": "def create_class(name, type, &)", "start_line": 87, "end_line": 97}, "metadata": {"module": "ROM", "class_name": "Command", "class_signature": "class Command"}, "task_id": 450}
{"function_name": "relation_methods_mod", "file_path": "rom/core/lib/rom/commands/class_interface.rb", "focal_code": "def relation_methods_mod(relation_class)\n        Module.new do\n          relation_class.view_methods.each do |meth|\n            module_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n              def #{meth}(*args, **kwargs)                                 # def create(*args, **kwargs)\n                response = relation.public_send(:#{meth}, *args, **kwargs) #   response = relation.public_send(:create, *args, **kwargs)\n                                                                           #\n                if response.is_a?(relation.class)                          #   if response.is_a?(relation.class)\n                  new(response)                                            #     new(response)\n                else                                                       #   else\n                  response                                                 #     response\n                end                                                        #   end\n              end                                                          # end\n            RUBY\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nmodule ROM\n  # Base command class with factory class-level interface and setup-related logic\n  #\n  # @private\n  class Command\n    module ClassInterface\n      # This hook sets up default class state\n      #\n      # @api private\n      def inherited(klass)\n        super\n        klass.instance_variable_set(:@before, before.dup)\n        klass.instance_variable_set(:@after, after.dup)\n      end\n\n      # Sets up the base class\n      #\n      # @api private\n      def self.extended(klass)\n        super\n        klass.set_hooks(:before, [])\n        klass.set_hooks(:after, [])\n      end\n\n      # Return adapter specific sub-class based on the adapter identifier\n      #\n      # This is a syntax sugar to make things consistent\n      #\n      # @example\n      #   ROM::Commands::Create[:memory]\n      #   # => ROM::Memory::Commands::Create\n      #\n      # @param [Symbol] adapter identifier\n      #\n      # @return [Class]\n      #\n      # @api public\n      def [](adapter)\n        adapter_namespace(adapter).const_get(Inflector.demodulize(name))\n      end\n\n      # Return namespaces that contains command subclasses of a specific adapter\n      #\n      # @param [Symbol] adapter identifier\n      #\n      # @return [Module]\n      #\n      # @api private\n      def adapter_namespace(adapter)\n        ROM.adapters.fetch(adapter).const_get(:Commands)\n      rescue KeyError\n        raise AdapterNotPresentError.new(adapter, :relation)\n      end\n\n      # Build a command class for a specific relation with options\n      #\n      # @example\n      #   class CreateUser < ROM::Commands::Create[:memory]\n      #   end\n      #\n      #   command = CreateUser.build(rom.relations[:users])\n      #\n      # @param [Relation] relation\n      # @param [Hash] options\n      #\n      # @return [Command]\n      #\n      # @api public\n      def build(relation, **options)\n        new(relation, **self.options, **options)\n      end\n\n      # Create a command class with a specific type\n      #\n      # @param [Symbol] name Command name\n      # @param [Class] type Command class\n      #\n      # @yield [Class]\n      #\n      # @return [Class, Object]\n      #\n      # @api public\n      def create_class(name, type, &)\n        klass = Dry::Core::ClassBuilder\n          .new(name: \"#{Inflector.classify(type)}[:#{name}]\", parent: type)\n          .call\n\n        if block_given?\n          yield(klass)\n        else\n          klass\n        end\n      end\n\n      # Use a configured plugin in this relation\n      #\n      # @example\n      #   class CreateUser < ROM::Commands::Create[:memory]\n      #     use :pagintion\n      #\n      #     per_page 30\n      #   end\n      #\n      # @param [Symbol] plugin\n      # @param [Hash] options\n      # @option options [Symbol] :adapter (:default) first adapter to check for plugin\n      #\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:command].fetch(plugin, adapter).apply_to(self, **options)\n      end\n\n      # Extend a command class with relation view methods\n      #\n      # @param [Relation] relation\n      #\n      # @return [Class]\n      #\n      # @api public\n      def extend_for_relation(relation)\n        include(relation_methods_mod(relation.class))\n      end\n\n      # Set before-execute hooks\n      #\n      # @overload before(hook)\n      #   Set an before hook as a method name\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       before :my_hook\n      #\n      #       def my_hook(tuple, *)\n      #         puts \"hook called#\n      #       end\n      #     end\n      #\n      # @overload before(hook_opts)\n      #   Set an before hook as a method name with arguments\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       before my_hook: { arg1: 1, arg2: 2 }\n      #\n      #       def my_hook(tuple, arg1:, arg2:)\n      #         puts \"hook called with args: #{arg1} and #{arg2}\"\n      #       end\n      #     end\n      #\n      #   @param [Hash<Symbol=>Hash>] hook Options with method name and pre-set args\n      #\n      # @return [Array<Hash, Symbol>] A list of all configured before hooks\n      #\n      # @api public\n      def before(*hooks)\n        if hooks.empty?\n          @before\n        else\n          set_hooks(:before, hooks)\n        end\n      end\n\n      # Set after-execute hooks\n      #\n      # @overload after(hook)\n      #   Set an after hook as a method name\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       after :my_hook\n      #\n      #       def my_hook(tuple, *)\n      #         puts \"hook called#\n      #       end\n      #     end\n      #\n      # @overload after(hook_opts)\n      #   Set an after hook as a method name with arguments\n      #\n      #   @example\n      #     class CreateUser < ROM::Commands::Create[:sql]\n      #       relation :users\n      #       register_as :create\n      #\n      #       after my_hook: { arg1: 1, arg1: 2 }\n      #\n      #       def my_hook(tuple, arg1:, arg2:)\n      #         puts \"hook called with args: #{arg1} and #{arg2}\"\n      #       end\n      #     end\n      #\n      #   @param [Hash<Symbol=>Hash>] hook Options with method name and pre-set args\n      #\n      # @return [Array<Hash, Symbol>] A list of all configured after hooks\n      #\n      # @api public\n      def after(*hooks)\n        if hooks.empty?\n          @after\n        else\n          set_hooks(:after, hooks)\n        end\n      end\n\n      # Set new or more hooks\n      #\n      # @api private\n      def set_hooks(type, hooks)\n        ivar = :\"@#{type}\"\n\n        if instance_variable_defined?(ivar)\n          instance_variable_get(ivar).concat(hooks)\n        else\n          instance_variable_set(ivar, hooks)\n        end\n      end\n\n      # Return default name of the command class based on its name\n      #\n      # During setup phase this is used by defalut as `register_as` option\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      def default_name\n        Inflector.underscore(Inflector.demodulize(name)).to_sym\n      end\n\n      # Return default options based on class macros\n      #\n      # @return [Hash]\n      #\n      # @api private\n      def options\n        { input: input, result: result, before: before, after: after }\n      end\n\n      # @api private\n      def relation_methods_mod(relation_class)\n        Module.new do\n          relation_class.view_methods.each do |meth|\n            module_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n              def #{meth}(*args, **kwargs)                                 # def create(*args, **kwargs)\n                response = relation.public_send(:#{meth}, *args, **kwargs) #   response = relation.public_send(:create, *args, **kwargs)\n                                                                           #\n                if response.is_a?(relation.class)                          #   if response.is_a?(relation.class)\n                  new(response)                                            #     new(response)\n                else                                                       #   else\n                  response                                                 #     response\n                end                                                        #   end\n              end                                                          # end\n            RUBY\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "relation_methods_mod", "signature": "def relation_methods_mod(relation_class)", "start_line": 252, "end_line": 268}, "metadata": {"module": "ROM", "class_name": "Command", "class_signature": "class Command"}, "task_id": 451}
{"function_name": "add", "file_path": "rom/core/lib/rom/schema/associations_dsl.rb", "focal_code": "def add(association)\n        key = association.as || association.name\n\n        if registry.key?(key)\n          ::Kernel.raise(\n            ::ArgumentError,\n            \"association #{key.inspect} is already defined for #{source.to_sym.inspect} relation\"\n          )\n        end\n\n        registry[key] = association\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/associations/definitions'\n\nmodule ROM\n  class Schema\n    # Additional schema DSL for definition SQL associations\n    #\n    # This DSL is exposed in `associations do .. end` blocks in schema defintions.\n    #\n    # @api public\n    class AssociationsDSL < BasicObject\n      # @!attribute [r] source\n      #   @return [Relation::Name] The source relation\n      attr_reader :source\n\n      # @!attribute [r] registry\n      #   @return [RelationRegistry] Relations registry from a rom container\n      attr_reader :registry\n\n      # @api private\n      def initialize(source, &)\n        @source = source\n        @registry = {}\n        instance_exec(&)\n      end\n\n      # Establish a one-to-many association\n      #\n      # @example using relation identifier\n      #   has_many :tasks\n      #\n      # @example setting custom foreign key name\n      #   has_many :tasks, foreign_key: :assignee_id\n      #\n      # @example with a :through option\n      #   # this establishes many-to-many association\n      #   has_many :tasks, through: :users_tasks\n      #\n      # @example using a custom view which overrides default one\n      #   has_many :posts, view: :published, override: true\n      #\n      # @example using aliased association with a custom view\n      #   has_many :posts, as: :published_posts, view: :published\n      #\n      # @example using custom target relation\n      #   has_many :user_posts, relation: :posts\n      #\n      # @example using custom target relation and an alias\n      #   has_many :user_posts, relation: :posts, as: :published, view: :published\n      #\n      # @param [Symbol] target The target relation identifier\n      # @param [Hash] options A hash with additional options\n      #\n      # @return [Associations::OneToMany]\n      #\n      # @see #many_to_many\n      #\n      # @api public\n      def one_to_many(target, **options)\n        if options[:through]\n          many_to_many(target, **options)\n        else\n          add(::ROM::Associations::Definitions::OneToMany.new(source, target, **options))\n        end\n      end\n      alias_method :has_many, :one_to_many\n\n      # Establish a one-to-one association\n      #\n      # @example using relation identifier\n      #   one_to_one :addresses, as: :address\n      #\n      # @example with an intermediate join relation\n      #   one_to_one :tasks, as: :priority_task, through: :assignments\n      #\n      # @param [Symbol] target The target relation identifier\n      # @param [Hash] options A hash with additional options\n      #\n      # @return [Associations::OneToOne]\n      #\n      # @see #belongs_to\n      #\n      # @api public\n      def one_to_one(target, **options)\n        if options[:through]\n          one_to_one_through(target, **options)\n        else\n          add(::ROM::Associations::Definitions::OneToOne.new(source, target, **options))\n        end\n      end\n\n      # Establish a one-to-one association with a :through option\n      #\n      # @example\n      #   one_to_one_through :users, as: :author, through: :users_posts\n      #\n      # @return [Associations::OneToOneThrough]\n      #\n      # @api public\n      def one_to_one_through(target, **options)\n        add(::ROM::Associations::Definitions::OneToOneThrough.new(source, target, **options))\n      end\n\n      # Establish a many-to-many association\n      #\n      # @example using relation identifier\n      #   many_to_many :tasks, through: :users_tasks\n      #\n      # @param [Symbol] target The target relation identifier\n      # @param [Hash] options A hash with additional options\n      #\n      # @return [Associations::ManyToMany]\n      #\n      # @see #one_to_many\n      #\n      # @api public\n      def many_to_many(target, **options)\n        add(::ROM::Associations::Definitions::ManyToMany.new(source, target, **options))\n      end\n\n      # Establish a many-to-one association\n      #\n      # @example using relation identifier\n      #   many_to_one :users, as: :author\n      #\n      # @param [Symbol] target The target relation identifier\n      # @param [Hash] options A hash with additional options\n      #\n      # @return [Associations::ManyToOne]\n      #\n      # @see #one_to_many\n      #\n      # @api public\n      def many_to_one(target, **options)\n        add(::ROM::Associations::Definitions::ManyToOne.new(source, target, **options))\n      end\n\n      # Shortcut for many_to_one which sets alias automatically\n      #\n      # @example with an alias (relation identifier is inferred via pluralization)\n      #   belongs_to :user\n      #\n      # @example with an explicit alias\n      #   belongs_to :users, as: :author\n      #\n      # @see #many_to_one\n      #\n      # @return [Associations::ManyToOne]\n      #\n      # @api public\n      def belongs_to(target, **options)\n        many_to_one(dataset_name(target), as: target, **options)\n      end\n\n      # Shortcut for one_to_one which sets alias automatically\n      #\n      # @example with an alias (relation identifier is inferred via pluralization)\n      #   has_one :address\n      #\n      # @example with an explicit alias and a custom view\n      #   has_one :posts, as: :priority_post, view: :prioritized\n      #\n      # @see #one_to_one\n      #\n      # @return [Associations::OneToOne]\n      #\n      # @api public\n      def has_one(target, **options)\n        one_to_one(dataset_name(target), as: target, **options)\n      end\n\n      # Return an association set for a schema\n      #\n      # @return [AssociationSet]\n      #\n      # @api private\n      def call = AssociationSet[source.relation].build(registry)\n\n      private\n\n      # @api private\n      def add(association)\n        key = association.as || association.name\n\n        if registry.key?(key)\n          ::Kernel.raise(\n            ::ArgumentError,\n            \"association #{key.inspect} is already defined for #{source.to_sym.inspect} relation\"\n          )\n        end\n\n        registry[key] = association\n      end\n\n      # @api private\n      def dataset_name(name) = Inflector.pluralize(name).to_sym\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "add", "signature": "def add(association)", "start_line": 185, "end_line": 196}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 452}
{"function_name": "build_attribute_info", "file_path": "rom/core/lib/rom/schema/dsl.rb", "focal_code": "def build_attribute_info(name, type_or_options, options = EMPTY_HASH)\n        type, options = if type_or_options.is_a?(::Hash)\n                          [nil, type_or_options]\n                        else\n                          [build_type(type_or_options, options), options]\n                        end\n        Schema.build_attribute_info(\n          type, **options, name: name\n        )\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/attribute'\nrequire 'rom/schema/associations_dsl'\n\nmodule ROM\n  class Schema\n    # Schema DSL exposed as `schema { .. }` in relation classes\n    #\n    # @api public\n    class DSL < ::BasicObject\n      KERNEL_METHODS = %i[extend method block_given?].freeze\n      KERNEL_METHODS.each { |m| define_method(m, ::Kernel.instance_method(m)) }\n\n      extend Initializer\n\n      # @!attribute [r] relation\n      #   @return [Relation::Name] The name of the schema's relation\n      param :relation\n\n      # @!attribute [r] inferrer\n      #   @return [Inferrer] Optional attribute inferrer\n      option :inferrer, default: -> { DEFAULT_INFERRER }\n\n      # @!attribute [r] schema_class\n      #   @return [Class] Schema class that should be instantiated\n      option :schema_class, default: -> { Schema }\n\n      # @!attribute [r] attr_class\n      #   @return [Class] Attribute class that should be used\n      option :attr_class, default: -> { Attribute }\n\n      # @!attribute [r] adapter\n      #   @return [Symbol] The adapter identifier used in gateways\n      option :adapter, default: -> { :default }\n\n      # @!attribute [r] attributes\n      #   @return [Hash<Symbol, Hash>] A hash with attribute names as\n      #   keys and attribute representations as values.\n      #\n      #   @see [Schema.build_attribute_info]\n      attr_reader :attributes\n\n      # @!attribute [r] plugins\n      #   @return [Hash] A hash with schema plugins enabled in a schema\n      attr_reader :plugins\n\n      # @!attribute [r] definition\n      #   @return [Proc] Definition block passed to DSL\n      attr_reader :definition\n\n      # @!attribute [r] associations_dsl\n      #   @return [AssociationDSL] Associations defined within a block\n      attr_reader :associations_dsl\n\n      # @api private\n      def initialize(*, **, &block)\n        super\n\n        @attributes = {}\n        @plugins = {}\n\n        @definition = block\n      end\n\n      # Defines a relation attribute with its type and options.\n      #\n      # When only options are given, type is left as nil. It makes\n      # sense when it is used alongside an schema inferrer, which will\n      # populate the type.\n      #\n      # @see Relation.schema\n      #\n      # @api public\n      def attribute(name, type_or_options, options = EMPTY_HASH)\n        if attributes.key?(name)\n          ::Kernel.raise ::ROM::AttributeAlreadyDefinedError,\n                         \"Attribute #{name.inspect} already defined\"\n        end\n\n        attributes[name] = build_attribute_info(name, type_or_options, options)\n      end\n\n      # Define associations for a relation\n      #\n      # @example\n      #   class Users < ROM::Relation[:sql]\n      #     schema(infer: true) do\n      #       associations do\n      #         has_many :tasks\n      #         has_many :posts\n      #         has_many :posts, as: :priority_posts, view: :prioritized\n      #         belongs_to :account\n      #       end\n      #     end\n      #   end\n      #\n      #   class Posts < ROM::Relation[:sql]\n      #     schema(infer: true) do\n      #       associations do\n      #         belongs_to :users, as: :author\n      #       end\n      #     end\n      #\n      #     view(:prioritized) do\n      #       where { priority <= 3 }\n      #     end\n      #   end\n      #\n      # @return [AssociationDSL]\n      #\n      # @api public\n      def associations(&)\n        @associations_dsl = AssociationsDSL.new(relation, &)\n      end\n\n      # Builds a representation of the information needed to create an\n      # attribute. It returns a hash with `:type` and `:options` keys.\n      #\n      # @return [Hash]\n      #\n      # @see [Schema.build_attribute_info]\n      #\n      # @api private\n      def build_attribute_info(name, type_or_options, options = EMPTY_HASH)\n        type, options = if type_or_options.is_a?(::Hash)\n                          [nil, type_or_options]\n                        else\n                          [build_type(type_or_options, options), options]\n                        end\n        Schema.build_attribute_info(\n          type, **options, name: name\n        )\n      end\n\n      # Builds a type instance from base type and meta options\n      #\n      # @return [Dry::Types::Type] Type instance\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def build_type(type, options = EMPTY_HASH)\n        if options[:read]\n          type.meta(source: relation, read: options[:read])\n        elsif type.optional? && type.meta[:read]\n          type.meta(source: relation, read: type.meta[:read].optional)\n        else\n          type.meta(source: relation)\n        end.meta(Attribute::META_OPTIONS.map { |opt|\n                   [opt, options[opt]] if options.key?(opt)\n                 }.compact.to_h)\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Specify which key(s) should be the primary key\n      #\n      # @api public\n      def primary_key(*names)\n        names.each do |name|\n          attributes[name][:type] =\n            attributes[name][:type].meta(primary_key: true)\n        end\n        self\n      end\n\n      # Enables for the schema\n      #\n      # @param [Symbol] plugin_name Plugin name\n      # @param [Hash] options Plugin options\n      #\n      # @api public\n      def use(plugin_name, options = ::ROM::EMPTY_HASH)\n        plugin = ::ROM.plugin_registry[:schema].fetch(plugin_name, adapter)\n        app_plugin(plugin, options)\n      end\n\n      # @api private\n      def app_plugin(plugin, options = ::ROM::EMPTY_HASH)\n        plugin.extend_dsl(self)\n        @plugins[plugin.name] = [plugin, plugin.config.to_hash.merge(options)]\n      end\n\n      # @api private\n      def call(&)\n        instance_exec(&) if block_given?\n        instance_exec(&definition) if definition\n\n        schema_class.define(relation, **opts) do |schema|\n          plugins.each_value do |plugin, options|\n            plugin.apply_to(schema, **options)\n          end\n        end\n      end\n\n      # @api private\n      def plugin_options(plugin) = @plugins[plugin][1]\n\n      private\n\n      # Return schema opts\n      #\n      # @return [Hash]\n      #\n      # @api private\n      def opts\n        opts = { attributes: attributes.values, inferrer: inferrer, attr_class: attr_class }\n\n        if associations_dsl\n          { **opts, associations: associations_dsl.call }\n        else\n          opts\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_attribute_info", "signature": "def build_attribute_info(name, type_or_options, options = EMPTY_HASH)", "start_line": 126, "end_line": 135}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 453}
{"function_name": "build_type", "file_path": "rom/core/lib/rom/schema/dsl.rb", "focal_code": "def build_type(type, options = EMPTY_HASH)\n        if options[:read]\n          type.meta(source: relation, read: options[:read])\n        elsif type.optional? && type.meta[:read]\n          type.meta(source: relation, read: type.meta[:read].optional)\n        else\n          type.meta(source: relation)\n        end.meta(Attribute::META_OPTIONS.map { |opt|\n                   [opt, options[opt]] if options.key?(opt)\n                 }.compact.to_h)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/attribute'\nrequire 'rom/schema/associations_dsl'\n\nmodule ROM\n  class Schema\n    # Schema DSL exposed as `schema { .. }` in relation classes\n    #\n    # @api public\n    class DSL < ::BasicObject\n      KERNEL_METHODS = %i[extend method block_given?].freeze\n      KERNEL_METHODS.each { |m| define_method(m, ::Kernel.instance_method(m)) }\n\n      extend Initializer\n\n      # @!attribute [r] relation\n      #   @return [Relation::Name] The name of the schema's relation\n      param :relation\n\n      # @!attribute [r] inferrer\n      #   @return [Inferrer] Optional attribute inferrer\n      option :inferrer, default: -> { DEFAULT_INFERRER }\n\n      # @!attribute [r] schema_class\n      #   @return [Class] Schema class that should be instantiated\n      option :schema_class, default: -> { Schema }\n\n      # @!attribute [r] attr_class\n      #   @return [Class] Attribute class that should be used\n      option :attr_class, default: -> { Attribute }\n\n      # @!attribute [r] adapter\n      #   @return [Symbol] The adapter identifier used in gateways\n      option :adapter, default: -> { :default }\n\n      # @!attribute [r] attributes\n      #   @return [Hash<Symbol, Hash>] A hash with attribute names as\n      #   keys and attribute representations as values.\n      #\n      #   @see [Schema.build_attribute_info]\n      attr_reader :attributes\n\n      # @!attribute [r] plugins\n      #   @return [Hash] A hash with schema plugins enabled in a schema\n      attr_reader :plugins\n\n      # @!attribute [r] definition\n      #   @return [Proc] Definition block passed to DSL\n      attr_reader :definition\n\n      # @!attribute [r] associations_dsl\n      #   @return [AssociationDSL] Associations defined within a block\n      attr_reader :associations_dsl\n\n      # @api private\n      def initialize(*, **, &block)\n        super\n\n        @attributes = {}\n        @plugins = {}\n\n        @definition = block\n      end\n\n      # Defines a relation attribute with its type and options.\n      #\n      # When only options are given, type is left as nil. It makes\n      # sense when it is used alongside an schema inferrer, which will\n      # populate the type.\n      #\n      # @see Relation.schema\n      #\n      # @api public\n      def attribute(name, type_or_options, options = EMPTY_HASH)\n        if attributes.key?(name)\n          ::Kernel.raise ::ROM::AttributeAlreadyDefinedError,\n                         \"Attribute #{name.inspect} already defined\"\n        end\n\n        attributes[name] = build_attribute_info(name, type_or_options, options)\n      end\n\n      # Define associations for a relation\n      #\n      # @example\n      #   class Users < ROM::Relation[:sql]\n      #     schema(infer: true) do\n      #       associations do\n      #         has_many :tasks\n      #         has_many :posts\n      #         has_many :posts, as: :priority_posts, view: :prioritized\n      #         belongs_to :account\n      #       end\n      #     end\n      #   end\n      #\n      #   class Posts < ROM::Relation[:sql]\n      #     schema(infer: true) do\n      #       associations do\n      #         belongs_to :users, as: :author\n      #       end\n      #     end\n      #\n      #     view(:prioritized) do\n      #       where { priority <= 3 }\n      #     end\n      #   end\n      #\n      # @return [AssociationDSL]\n      #\n      # @api public\n      def associations(&)\n        @associations_dsl = AssociationsDSL.new(relation, &)\n      end\n\n      # Builds a representation of the information needed to create an\n      # attribute. It returns a hash with `:type` and `:options` keys.\n      #\n      # @return [Hash]\n      #\n      # @see [Schema.build_attribute_info]\n      #\n      # @api private\n      def build_attribute_info(name, type_or_options, options = EMPTY_HASH)\n        type, options = if type_or_options.is_a?(::Hash)\n                          [nil, type_or_options]\n                        else\n                          [build_type(type_or_options, options), options]\n                        end\n        Schema.build_attribute_info(\n          type, **options, name: name\n        )\n      end\n\n      # Builds a type instance from base type and meta options\n      #\n      # @return [Dry::Types::Type] Type instance\n      #\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def build_type(type, options = EMPTY_HASH)\n        if options[:read]\n          type.meta(source: relation, read: options[:read])\n        elsif type.optional? && type.meta[:read]\n          type.meta(source: relation, read: type.meta[:read].optional)\n        else\n          type.meta(source: relation)\n        end.meta(Attribute::META_OPTIONS.map { |opt|\n                   [opt, options[opt]] if options.key?(opt)\n                 }.compact.to_h)\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      # Specify which key(s) should be the primary key\n      #\n      # @api public\n      def primary_key(*names)\n        names.each do |name|\n          attributes[name][:type] =\n            attributes[name][:type].meta(primary_key: true)\n        end\n        self\n      end\n\n      # Enables for the schema\n      #\n      # @param [Symbol] plugin_name Plugin name\n      # @param [Hash] options Plugin options\n      #\n      # @api public\n      def use(plugin_name, options = ::ROM::EMPTY_HASH)\n        plugin = ::ROM.plugin_registry[:schema].fetch(plugin_name, adapter)\n        app_plugin(plugin, options)\n      end\n\n      # @api private\n      def app_plugin(plugin, options = ::ROM::EMPTY_HASH)\n        plugin.extend_dsl(self)\n        @plugins[plugin.name] = [plugin, plugin.config.to_hash.merge(options)]\n      end\n\n      # @api private\n      def call(&)\n        instance_exec(&) if block_given?\n        instance_exec(&definition) if definition\n\n        schema_class.define(relation, **opts) do |schema|\n          plugins.each_value do |plugin, options|\n            plugin.apply_to(schema, **options)\n          end\n        end\n      end\n\n      # @api private\n      def plugin_options(plugin) = @plugins[plugin][1]\n\n      private\n\n      # Return schema opts\n      #\n      # @return [Hash]\n      #\n      # @api private\n      def opts\n        opts = { attributes: attributes.values, inferrer: inferrer, attr_class: attr_class }\n\n        if associations_dsl\n          { **opts, associations: associations_dsl.call }\n        else\n          opts\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_type", "signature": "def build_type(type, options = EMPTY_HASH)", "start_line": 143, "end_line": 153}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 454}
{"function_name": "call", "file_path": "rom/core/lib/rom/schema/inferrer.rb", "focal_code": "def call(schema, gateway)\n        if enabled?\n          inferred, missing = attributes_inferrer.(schema, gateway, options)\n        else\n          inferred, missing = DEFAULT_ATTRIBUTES\n        end\n\n        attributes = merge_attributes(schema.attributes, inferred)\n\n        check_all_attributes_defined(schema, attributes, missing)\n\n        { attributes: attributes }\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Schema\n    # @api private\n    class Inferrer\n      extend Dry::Core::ClassAttributes\n      extend Initializer\n\n      # @!method self.attributes_inferrer\n      #   @overload attributes_inferrer\n      #     @return [Proc]\n      #\n      #   @overload attributes_inferrer(value)\n      #     @param value [Proc]\n      #     @return [Proc]\n      #\n      # @!method self.attr_class\n      #   @overload attr_class\n      #     @return [Class(ROM::Attribute)]\n      #\n      #   @overload attr_class(value)\n      #     @param value [Class(ROM::Attribute)]\n      #     @return [Class(ROM::Attribute)]\n      defines :attributes_inferrer, :attr_class\n\n      MissingAttributesError = ::Class.new(::StandardError) do\n        def initialize(name, attributes)\n          super(\n            \"Following attributes in #{Relation::Name[name].relation.inspect} schema cannot \" \\\n            \"be inferred and have to be defined explicitly: #{attributes.map(&:inspect).join(', ')}\"\n          )\n        end\n      end\n\n      DEFAULT_ATTRIBUTES = [EMPTY_ARRAY, EMPTY_ARRAY].freeze\n\n      attributes_inferrer -> * { DEFAULT_ATTRIBUTES }\n\n      attr_class Attribute\n\n      include ::Dry::Equalizer(:options)\n\n      # @!attribute [r] attr_class\n      #   @return [Class(ROM::Attribute)]\n      option :attr_class, default: -> { self.class.attr_class }\n\n      # @!attribute [r] enabled\n      #   @return [Boolean]\n      option :enabled, default: -> { true }\n\n      alias_method :enabled?, :enabled\n\n      # @!attribute [r] attributes_inferrer\n      #   @return [ROM::Schema::AttributesInferrer]\n      option :attributes_inferrer, default: -> { self.class.attributes_inferrer }\n\n      # @api private\n      def call(schema, gateway)\n        if enabled?\n          inferred, missing = attributes_inferrer.(schema, gateway, options)\n        else\n          inferred, missing = DEFAULT_ATTRIBUTES\n        end\n\n        attributes = merge_attributes(schema.attributes, inferred)\n\n        check_all_attributes_defined(schema, attributes, missing)\n\n        { attributes: attributes }\n      end\n\n      # @api private\n      def check_all_attributes_defined(schema, all_known, not_inferred)\n        not_defined = not_inferred - all_known.map(&:name)\n\n        raise MissingAttributesError.new(schema.name, not_defined) unless not_defined.empty?\n      end\n\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def merge_attributes(defined, inferred)\n        type_lookup = lambda do |attrs, name|\n          attrs.find { |a| a.name == name }.type\n        end\n        defined_with_type, defined_names =\n          defined.each_with_object([[], []]) do |attr, (attrs, names)|\n            attrs << if attr.type.nil?\n                       attr.class.new(\n                         type_lookup.(inferred, attr.name),\n                         **attr.options\n                       )\n                     else\n                       attr\n                     end\n            names << attr.name\n          end\n\n        defined_with_type + inferred.reject do |attr|\n          defined_names.include?(attr.name)\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(schema, gateway)", "start_line": 59, "end_line": 71}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 455}
{"function_name": "merge_attributes", "file_path": "rom/core/lib/rom/schema/inferrer.rb", "focal_code": "def merge_attributes(defined, inferred)\n        type_lookup = lambda do |attrs, name|\n          attrs.find { |a| a.name == name }.type\n        end\n        defined_with_type, defined_names =\n          defined.each_with_object([[], []]) do |attr, (attrs, names)|\n            attrs << if attr.type.nil?\n                       attr.class.new(\n                         type_lookup.(inferred, attr.name),\n                         **attr.options\n                       )\n                     else\n                       attr\n                     end\n            names << attr.name\n          end\n\n        defined_with_type + inferred.reject do |attr|\n          defined_names.include?(attr.name)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Schema\n    # @api private\n    class Inferrer\n      extend Dry::Core::ClassAttributes\n      extend Initializer\n\n      # @!method self.attributes_inferrer\n      #   @overload attributes_inferrer\n      #     @return [Proc]\n      #\n      #   @overload attributes_inferrer(value)\n      #     @param value [Proc]\n      #     @return [Proc]\n      #\n      # @!method self.attr_class\n      #   @overload attr_class\n      #     @return [Class(ROM::Attribute)]\n      #\n      #   @overload attr_class(value)\n      #     @param value [Class(ROM::Attribute)]\n      #     @return [Class(ROM::Attribute)]\n      defines :attributes_inferrer, :attr_class\n\n      MissingAttributesError = ::Class.new(::StandardError) do\n        def initialize(name, attributes)\n          super(\n            \"Following attributes in #{Relation::Name[name].relation.inspect} schema cannot \" \\\n            \"be inferred and have to be defined explicitly: #{attributes.map(&:inspect).join(', ')}\"\n          )\n        end\n      end\n\n      DEFAULT_ATTRIBUTES = [EMPTY_ARRAY, EMPTY_ARRAY].freeze\n\n      attributes_inferrer -> * { DEFAULT_ATTRIBUTES }\n\n      attr_class Attribute\n\n      include ::Dry::Equalizer(:options)\n\n      # @!attribute [r] attr_class\n      #   @return [Class(ROM::Attribute)]\n      option :attr_class, default: -> { self.class.attr_class }\n\n      # @!attribute [r] enabled\n      #   @return [Boolean]\n      option :enabled, default: -> { true }\n\n      alias_method :enabled?, :enabled\n\n      # @!attribute [r] attributes_inferrer\n      #   @return [ROM::Schema::AttributesInferrer]\n      option :attributes_inferrer, default: -> { self.class.attributes_inferrer }\n\n      # @api private\n      def call(schema, gateway)\n        if enabled?\n          inferred, missing = attributes_inferrer.(schema, gateway, options)\n        else\n          inferred, missing = DEFAULT_ATTRIBUTES\n        end\n\n        attributes = merge_attributes(schema.attributes, inferred)\n\n        check_all_attributes_defined(schema, attributes, missing)\n\n        { attributes: attributes }\n      end\n\n      # @api private\n      def check_all_attributes_defined(schema, all_known, not_inferred)\n        not_defined = not_inferred - all_known.map(&:name)\n\n        raise MissingAttributesError.new(schema.name, not_defined) unless not_defined.empty?\n      end\n\n      # @api private\n      # rubocop:disable Metrics/AbcSize\n      def merge_attributes(defined, inferred)\n        type_lookup = lambda do |attrs, name|\n          attrs.find { |a| a.name == name }.type\n        end\n        defined_with_type, defined_names =\n          defined.each_with_object([[], []]) do |attr, (attrs, names)|\n            attrs << if attr.type.nil?\n                       attr.class.new(\n                         type_lookup.(inferred, attr.name),\n                         **attr.options\n                       )\n                     else\n                       attr\n                     end\n            names << attr.name\n          end\n\n        defined_with_type + inferred.reject do |attr|\n          defined_names.include?(attr.name)\n        end\n      end\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "merge_attributes", "signature": "def merge_attributes(defined, inferred)", "start_line": 82, "end_line": 102}, "metadata": {"module": "ROM", "class_name": "Schema", "class_signature": "class Schema"}, "task_id": 456}
{"function_name": "method_missing", "file_path": "rom/core/lib/rom/support/configurable.rb", "focal_code": "def method_missing(meth, *args, &)\n        return settings.fetch(meth, nil) if frozen?\n\n        name = meth.to_s\n        key = name.gsub(WRITER_REGEXP, '').to_sym\n\n        if writer?(name)\n          settings[key] = args.first\n        else\n          settings.fetch(key) { settings[key] = self.class.new }\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # This extension is only used for environment objects to configure arbitrary options, each\n  # adapter can use them according to what they need.\n  #\n  # @api private\n  module Configurable\n    class Config\n      WRITER_REGEXP = /=$/\n\n      # @!attribute [r] settings\n      #   @return [Hash] A hash with defined settings\n      attr_reader :settings\n\n      # @api private\n      def initialize(settings = {})\n        @settings = settings\n      end\n\n      # Return a setting\n      #\n      # @return [Mixed]\n      #\n      # @api public\n      def [](name) = public_send(name)\n\n      # @api private\n      def key?(name) = settings.key?(name)\n\n      def to_hash = settings\n\n      # @api private\n      def respond_to_missing?(_name, _include_private = false) = true\n\n      # @api private\n      def dup = self.class.new(dup_settings(settings))\n\n      private\n\n      def dup_settings(settings)\n        settings.to_h do |key, value|\n          if value.is_a?(self.class)\n            [key, value.dup]\n          else\n            [key, value]\n          end\n        end\n      end\n\n      # @api private\n      def method_missing(meth, *args, &)\n        return settings.fetch(meth, nil) if frozen?\n\n        name = meth.to_s\n        key = name.gsub(WRITER_REGEXP, '').to_sym\n\n        if writer?(name)\n          settings[key] = args.first\n        else\n          settings.fetch(key) { settings[key] = self.class.new }\n        end\n      end\n\n      # @api private\n      def writer?(name)\n        !WRITER_REGEXP.match(name).nil?\n      end\n    end\n\n    # Return config instance\n    #\n    # @return [Config]\n    #\n    # @api private\n    def config\n      @config ||= Config.new\n    end\n\n    # Yield config instance\n    #\n    # @return [self]\n    #\n    # @api public\n    def configure\n      yield(config)\n      self\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(meth, *args, &)", "start_line": 52, "end_line": 63}, "metadata": {"module": "ROM", "class_name": "Config", "class_signature": "class Config"}, "task_id": 457}
{"function_name": "define_memoizable_names!", "file_path": "rom/core/lib/rom/support/memoizable.rb", "focal_code": "def define_memoizable_names!\n        names.each do |name|\n          meth = klass.instance_method(name)\n\n          if meth.parameters.empty?\n            define_method(name) do\n              __memoized__[name] ||= super()\n            end\n          else\n            define_method(name) do |*args|\n              __memoized__[:\"#{name}_#{args.hash}\"] ||= super(*args)\n            end\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # @api private\n  module Memoizable\n    MEMOIZED_HASH = {}.freeze\n\n    module ClassInterface\n      # @api private\n      def memoize(*names)\n        prepend(Memoizer.new(self, names))\n      end\n\n      def new(*, **, &)\n        obj = super\n        obj.instance_variable_set(:@__memoized__, MEMOIZED_HASH.dup)\n        obj\n      end\n    end\n\n    def self.included(klass)\n      super\n      klass.extend(ClassInterface)\n    end\n\n    attr_reader :__memoized__\n\n    # @api private\n    class Memoizer < ::Module\n      attr_reader :klass\n\n      attr_reader :names\n\n      # @api private\n      def initialize(klass, names)\n        super()\n        @names = names\n        @klass = klass\n        define_memoizable_names!\n      end\n\n      private\n\n      # @api private\n      def define_memoizable_names!\n        names.each do |name|\n          meth = klass.instance_method(name)\n\n          if meth.parameters.empty?\n            define_method(name) do\n              __memoized__[name] ||= super()\n            end\n          else\n            define_method(name) do |*args|\n              __memoized__[:\"#{name}_#{args.hash}\"] ||= super(*args)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_memoizable_names!", "signature": "def define_memoizable_names! names.each do |name|", "start_line": 45, "end_line": 59}, "metadata": {"module": "ROM", "class_name": "Memoizer", "class_signature": "class Memoizer < < ::Module"}, "task_id": 458}
{"function_name": "build_class", "file_path": "rom/core/lib/rom/configuration_dsl/command.rb", "focal_code": "def self.build_class(name, relation, options = EMPTY_HASH, &)\n        type = options.fetch(:type) { name }\n        command_type = Inflector.classify(type)\n        adapter = options.fetch(:adapter)\n        parent = ROM::Command.adapter_namespace(adapter).const_get(command_type)\n        class_name = generate_class_name(adapter, command_type, relation)\n\n        Dry::Core::ClassBuilder.new(name: class_name, parent: parent).call do |klass|\n          klass.register_as(name)\n          klass.relation(relation)\n          klass.class_eval(&) if block_given?\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nmodule ROM\n  module ConfigurationDSL\n    # Setup DSL-specific command extensions\n    #\n    # @private\n    class Command\n      # Generate a command subclass\n      #\n      # This is used by Setup#commands DSL and its `define` block\n      #\n      # @api private\n      def self.build_class(name, relation, options = EMPTY_HASH, &)\n        type = options.fetch(:type) { name }\n        command_type = Inflector.classify(type)\n        adapter = options.fetch(:adapter)\n        parent = ROM::Command.adapter_namespace(adapter).const_get(command_type)\n        class_name = generate_class_name(adapter, command_type, relation)\n\n        Dry::Core::ClassBuilder.new(name: class_name, parent: parent).call do |klass|\n          klass.register_as(name)\n          klass.relation(relation)\n          klass.class_eval(&) if block_given?\n        end\n      end\n\n      # Create a command subclass name based on adapter, type and relation\n      #\n      # @api private\n      def self.generate_class_name(adapter, command_type, relation)\n        pieces = ['ROM']\n        pieces << Inflector.classify(adapter)\n        pieces << 'Commands'\n        pieces << \"#{command_type}[#{Inflector.classify(relation)}s]\"\n        pieces.join('::')\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_class", "signature": "def self.build_class(name, relation, options = EMPTY_HASH, &)", "start_line": 16, "end_line": 28}, "metadata": {"module": "ROM", "class_name": "Command", "class_signature": "class Command"}, "task_id": 459}
{"function_name": "build_class", "file_path": "rom/core/lib/rom/configuration_dsl/relation.rb", "focal_code": "def self.build_class(name, options = EMPTY_HASH)\n        class_name = \"ROM::Relation[#{Inflector.camelize(name)}]\"\n        adapter = options.fetch(:adapter)\n\n        ::Dry::Core::ClassBuilder.new(\n          name: class_name, parent: ::ROM::Relation[adapter]\n        ).call do |klass|\n          klass.gateway(options.fetch(:gateway, :default))\n          klass.schema(name) { nil }\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/inflector'\n\nmodule ROM\n  module ConfigurationDSL\n    # Setup DSL-specific relation extensions\n    #\n    # @private\n    class Relation\n      # Generate a relation subclass\n      #\n      # This is used by Setup#relation DSL\n      #\n      # @api private\n      def self.build_class(name, options = EMPTY_HASH)\n        class_name = \"ROM::Relation[#{Inflector.camelize(name)}]\"\n        adapter = options.fetch(:adapter)\n\n        ::Dry::Core::ClassBuilder.new(\n          name: class_name, parent: ::ROM::Relation[adapter]\n        ).call do |klass|\n          klass.gateway(options.fetch(:gateway, :default))\n          klass.schema(name) { nil }\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_class", "signature": "def self.build_class(name, options = EMPTY_HASH)", "start_line": 16, "end_line": 26}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 460}
{"function_name": "[]", "file_path": "rom/core/lib/rom/relation/name.rb", "focal_code": "def self.[](*args)\n        cache.fetch_or_store(args.hash) do\n          relation, dataset, aliaz = args\n\n          if relation.is_a?(Name)\n            relation\n          else\n            new(relation, dataset, aliaz)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'concurrent/map'\n\nmodule ROM\n  class Relation\n    # Relation name container\n    #\n    # This is a simple struct with two fields.\n    # It handles both relation registration name (i.e. Symbol) and dataset name.\n    # The reason we need it is a simplification of passing around these two objects.\n    # It is quite common to have a dataset named differently from a relation\n    # built on top if you are dealing with a legacy DB and often you need both\n    # to support things such as associations (rom-sql as an example).\n    #\n    # @api private\n    class Name\n      include ::Dry::Equalizer(:relation, :dataset, :key)\n\n      # Coerce an object to a Name instance\n      #\n      # @return [ROM::Relation::Name]\n      #\n      # @api private\n      def self.[](*args)\n        cache.fetch_or_store(args.hash) do\n          relation, dataset, aliaz = args\n\n          if relation.is_a?(Name)\n            relation\n          else\n            new(relation, dataset, aliaz)\n          end\n        end\n      end\n\n      # @api private\n      def self.cache\n        @cache ||= Concurrent::Map.new\n      end\n\n      # Relation registration name\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      attr_reader :relation\n\n      # Underlying dataset name\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      attr_reader :dataset\n\n      attr_reader :aliaz\n      attr_reader :key\n\n      # @api private\n      def initialize(relation, dataset = relation, aliaz = nil)\n        @relation = relation\n        @dataset = dataset || relation\n        @key = aliaz || relation\n        @aliaz = aliaz\n      end\n\n      # @api private\n      def as(aliaz) = self.class[relation, dataset, aliaz]\n\n      # @api private\n      def aliased? = aliaz && aliaz != relation\n\n      # Return relation name\n      #\n      # @return [String]\n      #\n      # @api private\n      def to_s\n        if aliased?\n          \"#{relation} on #{dataset} as #{aliaz}\"\n        elsif relation == dataset\n          relation.to_s\n        else\n          \"#{relation} on #{dataset}\"\n        end\n      end\n\n      # Alias for registration key implicitly called by ROM::Registry\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      def to_sym = relation\n\n      # Return inspected relation\n      #\n      # @return [String]\n      #\n      # @api private\n      def inspect = \"#{self.class.name}(#{self})\"\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "[]", "signature": "def self.[](*args)", "start_line": 25, "end_line": 35}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 461}
{"function_name": "command", "file_path": "rom/core/lib/rom/relation/commands.rb", "focal_code": "def command(type, mapper: nil, use: EMPTY_ARRAY, plugins_options: EMPTY_HASH, **opts)\n        base_command =\n          if commands.key?(type)\n            commands[type]\n          else\n            commands[type, adapter, to_ast, use, plugins_options, opts]\n          end\n\n        command =\n          if mapper\n            base_command >> mappers[mapper]\n          elsif auto_map?\n            base_command >> self.mapper\n          else\n            base_command\n          end\n\n        if command.restrictible?\n          command.new(self)\n        else\n          command\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Relation\n    # Extensions for relation classes which provide access to commands\n    #\n    # @api public\n    module Commands\n      # Return a command for the relation\n      #\n      # This method can either return an existing custom command identified\n      # by `type` param, or generate a command dynamically based on relation\n      # AST.\n      #\n      # @example build a simple :create command\n      #   users.command(:create)\n      #\n      # @example build a command which returns multiple results\n      #   users.command(:create, result: many)\n      #\n      # @example build a command which uses a specific plugin\n      #   users.command(:create, use: :timestamps)\n      #\n      # @example build a command which sends results through a custom mapper\n      #   users.command(:create, mapper: :my_mapper_identifier)\n      #\n      # @example return an existing custom command\n      #   users.command(:my_custom_command_identifier)\n      #\n      # @param type [Symbol] The command type (:create, :update or :delete)\n      # @param opts [Hash] Additional options\n      # @option opts [Symbol] :mapper (nil) An optional mapper applied to the command result\n      # @option opts [Array<Symbol>] :use ([]) A list of command plugins\n      # @option opts [Symbol] :result (:one) Set how many results the command should return.\n      #                                       Can be `:one` or `:many`\n      #\n      # @return [ROM::Command]\n      #\n      # @api public\n      def command(type, mapper: nil, use: EMPTY_ARRAY, plugins_options: EMPTY_HASH, **opts)\n        base_command =\n          if commands.key?(type)\n            commands[type]\n          else\n            commands[type, adapter, to_ast, use, plugins_options, opts]\n          end\n\n        command =\n          if mapper\n            base_command >> mappers[mapper]\n          elsif auto_map?\n            base_command >> self.mapper\n          else\n            base_command\n          end\n\n        if command.restrictible?\n          command.new(self)\n        else\n          command\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "command", "signature": "def command(type, mapper: nil, use: EMPTY_ARRAY, plugins_options: EMPTY_HASH, **opts)", "start_line": 40, "end_line": 62}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 462}
{"function_name": "call", "file_path": "rom/core/lib/rom/relation/curried.rb", "focal_code": "def call(*args)\n        all_args = curry_args + args\n\n        if all_args.empty?\n          raise ArgumentError,\n                \"curried #{relation.class}##{view} relation was called without any arguments\"\n        end\n\n        if args.empty?\n          self\n        elsif arity == all_args.size\n          Loaded.new(relation.__send__(view, *all_args))\n        else\n          __new__(relation, curry_args: all_args)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/initializer'\nrequire 'rom/pipeline'\nrequire 'rom/relation/name'\nrequire 'rom/relation/materializable'\nrequire 'rom/relation/graph'\nrequire 'rom/relation/wrap'\nrequire 'rom/relation/composite'\n\nmodule ROM\n  class Relation\n    # Curried relation is a special relation proxy used by auto-curry mechanism.\n    #\n    # When a relation view method is called without all arguments, a curried proxy\n    # is returned that can be fully applied later on.\n    #\n    # Curried relations are typically used for relation composition\n    #\n    # @api public\n    class Curried\n      extend Initializer\n\n      WRAPS = [Relation, Graph, Wrap, Composite].freeze\n\n      include Dry::Equalizer(:relation, :options)\n      include Materializable\n      include Pipeline\n\n      undef :map_with\n\n      # @!attribute [r] relation\n      #   @return [Relation] The source relation that is curried\n      param :relation\n\n      # @!attribute [r] view\n      #   @return [Symbol] The name of relation's view method\n      option :view, type: Types::Strict::Symbol\n\n      # @!attribute [r] arity\n      #   @return [Integer] View's arity\n      option :arity, type: Types::Strict::Integer\n\n      # @!attribute [r] curry_args\n      #   @return [Array] Arguments that will be passed to curried view\n      option :curry_args, default: -> { EMPTY_ARRAY }\n\n      # Load relation if args match the arity\n      #\n      # @return [Loaded,Curried]\n      #\n      # @api public\n      def call(*args)\n        all_args = curry_args + args\n\n        if all_args.empty?\n          raise ArgumentError,\n                \"curried #{relation.class}##{view} relation was called without any arguments\"\n        end\n\n        if args.empty?\n          self\n        elsif arity == all_args.size\n          Loaded.new(relation.__send__(view, *all_args))\n        else\n          __new__(relation, curry_args: all_args)\n        end\n      end\n      alias_method :[], :call\n\n      # Relations are coercible to an array but a curried relation cannot be coerced\n      # When something tries to do this, an exception will be raised\n      #\n      # @raise ArgumentError\n      #\n      # @api public\n      def to_a\n        raise(\n          ArgumentError,\n          \"#{relation.class}##{view} arity is #{arity} \" \\\n          \"(#{curry_args.size} args given)\"\n        )\n      end\n      alias_method :to_ary, :to_a\n\n      # Return if this lazy relation is curried\n      #\n      # @return [true]\n      #\n      # @api private\n      def curried? = true\n\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        super || relation.respond_to?(name, include_private)\n      end\n\n      private\n\n      # @api private\n      def __new__(relation, **new_opts)\n        self.class.new(relation, **options, **new_opts)\n      end\n\n      # @api private\n      def composite_class = Relation::Composite\n\n      # @api private\n      def method_missing(meth, ...)\n        if relation.respond_to?(meth)\n          response = relation.__send__(meth, ...)\n\n          super if response.is_a?(self.class)\n\n          if WRAPS.any? { |klass| response.is_a?(klass) }\n            __new__(response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 54, "end_line": 69}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 463}
{"function_name": "method_missing", "file_path": "rom/core/lib/rom/relation/curried.rb", "focal_code": "def method_missing(meth, ...)\n        if relation.respond_to?(meth)\n          response = relation.__send__(meth, ...)\n\n          super if response.is_a?(self.class)\n\n          if WRAPS.any? { |klass| response.is_a?(klass) }\n            __new__(response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/types'\nrequire 'rom/initializer'\nrequire 'rom/pipeline'\nrequire 'rom/relation/name'\nrequire 'rom/relation/materializable'\nrequire 'rom/relation/graph'\nrequire 'rom/relation/wrap'\nrequire 'rom/relation/composite'\n\nmodule ROM\n  class Relation\n    # Curried relation is a special relation proxy used by auto-curry mechanism.\n    #\n    # When a relation view method is called without all arguments, a curried proxy\n    # is returned that can be fully applied later on.\n    #\n    # Curried relations are typically used for relation composition\n    #\n    # @api public\n    class Curried\n      extend Initializer\n\n      WRAPS = [Relation, Graph, Wrap, Composite].freeze\n\n      include Dry::Equalizer(:relation, :options)\n      include Materializable\n      include Pipeline\n\n      undef :map_with\n\n      # @!attribute [r] relation\n      #   @return [Relation] The source relation that is curried\n      param :relation\n\n      # @!attribute [r] view\n      #   @return [Symbol] The name of relation's view method\n      option :view, type: Types::Strict::Symbol\n\n      # @!attribute [r] arity\n      #   @return [Integer] View's arity\n      option :arity, type: Types::Strict::Integer\n\n      # @!attribute [r] curry_args\n      #   @return [Array] Arguments that will be passed to curried view\n      option :curry_args, default: -> { EMPTY_ARRAY }\n\n      # Load relation if args match the arity\n      #\n      # @return [Loaded,Curried]\n      #\n      # @api public\n      def call(*args)\n        all_args = curry_args + args\n\n        if all_args.empty?\n          raise ArgumentError,\n                \"curried #{relation.class}##{view} relation was called without any arguments\"\n        end\n\n        if args.empty?\n          self\n        elsif arity == all_args.size\n          Loaded.new(relation.__send__(view, *all_args))\n        else\n          __new__(relation, curry_args: all_args)\n        end\n      end\n      alias_method :[], :call\n\n      # Relations are coercible to an array but a curried relation cannot be coerced\n      # When something tries to do this, an exception will be raised\n      #\n      # @raise ArgumentError\n      #\n      # @api public\n      def to_a\n        raise(\n          ArgumentError,\n          \"#{relation.class}##{view} arity is #{arity} \" \\\n          \"(#{curry_args.size} args given)\"\n        )\n      end\n      alias_method :to_ary, :to_a\n\n      # Return if this lazy relation is curried\n      #\n      # @return [true]\n      #\n      # @api private\n      def curried? = true\n\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        super || relation.respond_to?(name, include_private)\n      end\n\n      private\n\n      # @api private\n      def __new__(relation, **new_opts)\n        self.class.new(relation, **options, **new_opts)\n      end\n\n      # @api private\n      def composite_class = Relation::Composite\n\n      # @api private\n      def method_missing(meth, ...)\n        if relation.respond_to?(meth)\n          response = relation.__send__(meth, ...)\n\n          super if response.is_a?(self.class)\n\n          if WRAPS.any? { |klass| response.is_a?(klass) }\n            __new__(response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(meth, ...)", "start_line": 110, "end_line": 124}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 464}
{"function_name": "schema", "file_path": "rom/core/lib/rom/relation/class_interface.rb", "focal_code": "def schema(dataset = nil, as: nil, infer: false, &)\n        if defined?(@schema) && !block_given? && !infer\n          @schema\n        elsif block_given? || infer\n          raise MissingSchemaClassError, self unless schema_class\n\n          ds_name = dataset || schema_opts.fetch(:dataset, default_name.dataset)\n          relation = as || schema_opts.fetch(:relation, ds_name)\n\n          raise InvalidRelationName, relation if invalid_relation_name?(relation)\n\n          @relation_name = Name[relation, ds_name]\n\n          @schema_proc = proc do |*args, &inner_block|\n            schema_dsl.new(\n              relation_name,\n              schema_class: schema_class,\n              attr_class: schema_attr_class,\n              inferrer: schema_inferrer.with(enabled: infer),\n              &\n            ).call(*args, &inner_block)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'set'\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/constants'\nrequire 'rom/relation/name'\nrequire 'rom/relation/view_dsl'\nrequire 'rom/schema'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  class Relation\n    # Global class-level API for relation classes\n    #\n    # @api public\n    # rubocop:disable Metrics/ModuleLength\n    module ClassInterface\n      extend Notifications::Listener\n\n      subscribe('configuration.relations.object.registered') do |event|\n        relation = event[:relation]\n        registry = event[:registry]\n\n        schemas = relation.schemas.reduce({}) do |h, (a, e)|\n          h.update(a => e.is_a?(Proc) ? relation.class.instance_exec(registry, &e) : e)\n        end\n\n        relation.schemas.update(schemas)\n        relation\n      end\n\n      DEFAULT_DATASET_PROC = -> * { self }.freeze\n      INVALID_RELATIONS_NAMES = [\n        :relations\n      ].freeze\n\n      # Return adapter-specific relation subclass\n      #\n      # @example\n      #   ROM::Relation[:memory]\n      #   # => ROM::Memory::Relation\n      #\n      # @return [Class]\n      #\n      # @api public\n      def [](adapter)\n        ROM.adapters.fetch(adapter).const_get(:Relation)\n      rescue KeyError\n        raise AdapterNotPresentError.new(adapter, :relation)\n      end\n\n      # Set or get custom dataset block\n      #\n      # This block will be evaluated when a relation is instantiated and registered\n      # in a relation registry.\n      #\n      # @example\n      #   class Users < ROM::Relation[:memory]\n      #     dataset { sort_by(:id) }\n      #   end\n      #\n      # @api public\n      def dataset(&block)\n        if defined?(@dataset)\n          @dataset\n        else\n          @dataset = block || DEFAULT_DATASET_PROC\n        end\n      end\n\n      # Specify canonical schema for a relation\n      #\n      # With a schema defined commands will set up a type-safe input handler\n      # automatically\n      #\n      # @example\n      #   class Users < ROM::Relation[:sql]\n      #     schema do\n      #       attribute :id, Types::Serial\n      #       attribute :name, Types::String\n      #     end\n      #   end\n      #\n      #   # access schema from a finalized relation\n      #   users.schema\n      #\n      # @return [Schema]\n      #\n      # @param [Symbol] dataset An optional dataset name\n      # @param [Boolean] infer Whether to do an automatic schema inferring\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def schema(dataset = nil, as: nil, infer: false, &)\n        if defined?(@schema) && !block_given? && !infer\n          @schema\n        elsif block_given? || infer\n          raise MissingSchemaClassError, self unless schema_class\n\n          ds_name = dataset || schema_opts.fetch(:dataset, default_name.dataset)\n          relation = as || schema_opts.fetch(:relation, ds_name)\n\n          raise InvalidRelationName, relation if invalid_relation_name?(relation)\n\n          @relation_name = Name[relation, ds_name]\n\n          @schema_proc = proc do |*args, &inner_block|\n            schema_dsl.new(\n              relation_name,\n              schema_class: schema_class,\n              attr_class: schema_attr_class,\n              inferrer: schema_inferrer.with(enabled: infer),\n              &\n            ).call(*args, &inner_block)\n          end\n        end\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Assign a schema to a relation class\n      #\n      # @param [Schema] schema\n      #\n      # @return [Schema]\n      #\n      # @api private\n      def set_schema!(schema)\n        @schema = schema\n      end\n\n      # @api private\n      attr_reader :schema_proc\n\n      # @!attribute [r] relation_name\n      #   @return [Name] Qualified relation name\n      def relation_name\n        raise MissingSchemaError, self unless defined?(@relation_name)\n\n        @relation_name\n      end\n\n      # Define a relation view with a specific schema\n      #\n      # This method should only be used in cases where a given adapter doesn't\n      # support automatic schema projection at run-time.\n      #\n      # **It's not needed in rom-sql**\n      #\n      # @overload view(name, schema, &block)\n      #   @example View with the canonical schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      #   @example View with a projected schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema.project(:id, :name)) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      # @overload view(name, &block)\n      #   @example View with the canonical schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do |name|\n      #         where(name: name)\n      #       end\n      #     end\n      #\n      #   @example View with projected schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do\n      #         schema { project(:id, :name) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      #   @example View with a schema extended with foreign attributes\n      #     class Users < ROM::Relation[:sql]\n      #       view(:index) do\n      #         schema { append(relations[:tasks][:title]) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      # @return [Symbol] view method name\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n      def view(*args, &block)\n        if args.size == 1 && block.arity.positive?\n          raise ArgumentError, 'schema attribute names must be provided as the second argument'\n        end\n\n        name, new_schema_fn, relation_block =\n          if args.size == 1\n            ViewDSL.new(*args, schema, &block).call\n          else\n            [*args, block]\n          end\n\n        schemas[name] =\n          if args.size == 2\n            -> _ { schema.project(*args[1]) }\n          else\n            new_schema_fn\n          end\n\n        if relation_block.arity.positive?\n          auto_curry_guard do\n            define_method(name, &relation_block)\n\n            auto_curry(name) do\n              schemas[name].(self)\n            end\n          end\n        else\n          define_method(name) do\n            schemas[name].(instance_exec(&relation_block))\n          end\n        end\n\n        name\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n      # Dynamically define a method that will forward to the dataset and wrap\n      # response in the relation itself\n      #\n      # @example\n      #   class SomeAdapterRelation < ROM::Relation\n      #     forward :super_query\n      #   end\n      #\n      # @api public\n      def forward(*methods)\n        methods.each do |method|\n          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n            def #{method}(...)                        # def super_query(...)\n              new(dataset.__send__(:#{method}, ...))  #   new(dataset.__send__(:super_query, ...))\n            end                                       # end\n          RUBY\n        end\n      end\n\n      # Include a registered plugin in this relation class\n      #\n      # @param [Symbol] plugin\n      # @param [Hash] options\n      # @option options [Symbol] :adapter (:default) first adapter to check for plugin\n      #\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:relation].fetch(plugin, adapter).apply_to(self, **options)\n      end\n\n      # Build default mapper registry\n      #\n      # @return [MapperRegistry]\n      #\n      # @api private\n      def mapper_registry(opts = EMPTY_HASH)\n        adapter_ns = ROM.adapters[adapter]\n\n        compiler =\n          if adapter_ns&.const_defined?(:MapperCompiler)\n            adapter_ns.const_get(:MapperCompiler)\n          else\n            MapperCompiler\n          end\n\n        MapperRegistry.new({}, compiler: compiler.new(**opts), **opts)\n      end\n\n      # @api private\n      def curried = Curried\n\n      # @api private\n      def view_methods\n        ancestor_methods = ancestors.reject { |klass| klass == self }\n          .map(&:instance_methods).flatten(1)\n\n        instance_methods - ancestor_methods + auto_curried_methods.to_a\n      end\n\n      # @api private\n      def schemas\n        @schemas ||= {}\n      end\n\n      # Return default relation name used in schemas\n      #\n      # @return [Name]\n      #\n      # @api private\n      def default_name\n        Name[Inflector.underscore(name).tr('/', '_').to_sym]\n      end\n\n      # @api private\n      def default_schema(klass = self)\n        klass.schema ||\n          if klass.schema_proc\n            klass.set_schema!(klass.schema_proc.call)\n          else\n            klass.schema_class.define(klass.default_name)\n          end\n      end\n\n      # @api private\n      def name = super || superclass.name\n\n      private\n\n      def invalid_relation_name?(relation)\n        INVALID_RELATIONS_NAMES.include?(relation.to_sym)\n      end\n    end\n    # rubocop:enable Metrics/ModuleLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "schema", "signature": "def schema(dataset = nil, as: nil, infer: false, &)", "start_line": 96, "end_line": 119}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 465}
{"function_name": "view", "file_path": "rom/core/lib/rom/relation/class_interface.rb", "focal_code": "def view(*args, &block)\n        if args.size == 1 && block.arity.positive?\n          raise ArgumentError, 'schema attribute names must be provided as the second argument'\n        end\n\n        name, new_schema_fn, relation_block =\n          if args.size == 1\n            ViewDSL.new(*args, schema, &block).call\n          else\n            [*args, block]\n          end\n\n        schemas[name] =\n          if args.size == 2\n            -> _ { schema.project(*args[1]) }\n          else\n            new_schema_fn\n          end\n\n        if relation_block.arity.positive?\n          auto_curry_guard do\n            define_method(name, &relation_block)\n\n            auto_curry(name) do\n              schemas[name].(self)\n            end\n          end\n        else\n          define_method(name) do\n            schemas[name].(instance_exec(&relation_block))\n          end\n        end\n\n        name\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'set'\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/constants'\nrequire 'rom/relation/name'\nrequire 'rom/relation/view_dsl'\nrequire 'rom/schema'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  class Relation\n    # Global class-level API for relation classes\n    #\n    # @api public\n    # rubocop:disable Metrics/ModuleLength\n    module ClassInterface\n      extend Notifications::Listener\n\n      subscribe('configuration.relations.object.registered') do |event|\n        relation = event[:relation]\n        registry = event[:registry]\n\n        schemas = relation.schemas.reduce({}) do |h, (a, e)|\n          h.update(a => e.is_a?(Proc) ? relation.class.instance_exec(registry, &e) : e)\n        end\n\n        relation.schemas.update(schemas)\n        relation\n      end\n\n      DEFAULT_DATASET_PROC = -> * { self }.freeze\n      INVALID_RELATIONS_NAMES = [\n        :relations\n      ].freeze\n\n      # Return adapter-specific relation subclass\n      #\n      # @example\n      #   ROM::Relation[:memory]\n      #   # => ROM::Memory::Relation\n      #\n      # @return [Class]\n      #\n      # @api public\n      def [](adapter)\n        ROM.adapters.fetch(adapter).const_get(:Relation)\n      rescue KeyError\n        raise AdapterNotPresentError.new(adapter, :relation)\n      end\n\n      # Set or get custom dataset block\n      #\n      # This block will be evaluated when a relation is instantiated and registered\n      # in a relation registry.\n      #\n      # @example\n      #   class Users < ROM::Relation[:memory]\n      #     dataset { sort_by(:id) }\n      #   end\n      #\n      # @api public\n      def dataset(&block)\n        if defined?(@dataset)\n          @dataset\n        else\n          @dataset = block || DEFAULT_DATASET_PROC\n        end\n      end\n\n      # Specify canonical schema for a relation\n      #\n      # With a schema defined commands will set up a type-safe input handler\n      # automatically\n      #\n      # @example\n      #   class Users < ROM::Relation[:sql]\n      #     schema do\n      #       attribute :id, Types::Serial\n      #       attribute :name, Types::String\n      #     end\n      #   end\n      #\n      #   # access schema from a finalized relation\n      #   users.schema\n      #\n      # @return [Schema]\n      #\n      # @param [Symbol] dataset An optional dataset name\n      # @param [Boolean] infer Whether to do an automatic schema inferring\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def schema(dataset = nil, as: nil, infer: false, &)\n        if defined?(@schema) && !block_given? && !infer\n          @schema\n        elsif block_given? || infer\n          raise MissingSchemaClassError, self unless schema_class\n\n          ds_name = dataset || schema_opts.fetch(:dataset, default_name.dataset)\n          relation = as || schema_opts.fetch(:relation, ds_name)\n\n          raise InvalidRelationName, relation if invalid_relation_name?(relation)\n\n          @relation_name = Name[relation, ds_name]\n\n          @schema_proc = proc do |*args, &inner_block|\n            schema_dsl.new(\n              relation_name,\n              schema_class: schema_class,\n              attr_class: schema_attr_class,\n              inferrer: schema_inferrer.with(enabled: infer),\n              &\n            ).call(*args, &inner_block)\n          end\n        end\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Assign a schema to a relation class\n      #\n      # @param [Schema] schema\n      #\n      # @return [Schema]\n      #\n      # @api private\n      def set_schema!(schema)\n        @schema = schema\n      end\n\n      # @api private\n      attr_reader :schema_proc\n\n      # @!attribute [r] relation_name\n      #   @return [Name] Qualified relation name\n      def relation_name\n        raise MissingSchemaError, self unless defined?(@relation_name)\n\n        @relation_name\n      end\n\n      # Define a relation view with a specific schema\n      #\n      # This method should only be used in cases where a given adapter doesn't\n      # support automatic schema projection at run-time.\n      #\n      # **It's not needed in rom-sql**\n      #\n      # @overload view(name, schema, &block)\n      #   @example View with the canonical schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      #   @example View with a projected schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema.project(:id, :name)) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      # @overload view(name, &block)\n      #   @example View with the canonical schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do |name|\n      #         where(name: name)\n      #       end\n      #     end\n      #\n      #   @example View with projected schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do\n      #         schema { project(:id, :name) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      #   @example View with a schema extended with foreign attributes\n      #     class Users < ROM::Relation[:sql]\n      #       view(:index) do\n      #         schema { append(relations[:tasks][:title]) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      # @return [Symbol] view method name\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n      def view(*args, &block)\n        if args.size == 1 && block.arity.positive?\n          raise ArgumentError, 'schema attribute names must be provided as the second argument'\n        end\n\n        name, new_schema_fn, relation_block =\n          if args.size == 1\n            ViewDSL.new(*args, schema, &block).call\n          else\n            [*args, block]\n          end\n\n        schemas[name] =\n          if args.size == 2\n            -> _ { schema.project(*args[1]) }\n          else\n            new_schema_fn\n          end\n\n        if relation_block.arity.positive?\n          auto_curry_guard do\n            define_method(name, &relation_block)\n\n            auto_curry(name) do\n              schemas[name].(self)\n            end\n          end\n        else\n          define_method(name) do\n            schemas[name].(instance_exec(&relation_block))\n          end\n        end\n\n        name\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n      # Dynamically define a method that will forward to the dataset and wrap\n      # response in the relation itself\n      #\n      # @example\n      #   class SomeAdapterRelation < ROM::Relation\n      #     forward :super_query\n      #   end\n      #\n      # @api public\n      def forward(*methods)\n        methods.each do |method|\n          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n            def #{method}(...)                        # def super_query(...)\n              new(dataset.__send__(:#{method}, ...))  #   new(dataset.__send__(:super_query, ...))\n            end                                       # end\n          RUBY\n        end\n      end\n\n      # Include a registered plugin in this relation class\n      #\n      # @param [Symbol] plugin\n      # @param [Hash] options\n      # @option options [Symbol] :adapter (:default) first adapter to check for plugin\n      #\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:relation].fetch(plugin, adapter).apply_to(self, **options)\n      end\n\n      # Build default mapper registry\n      #\n      # @return [MapperRegistry]\n      #\n      # @api private\n      def mapper_registry(opts = EMPTY_HASH)\n        adapter_ns = ROM.adapters[adapter]\n\n        compiler =\n          if adapter_ns&.const_defined?(:MapperCompiler)\n            adapter_ns.const_get(:MapperCompiler)\n          else\n            MapperCompiler\n          end\n\n        MapperRegistry.new({}, compiler: compiler.new(**opts), **opts)\n      end\n\n      # @api private\n      def curried = Curried\n\n      # @api private\n      def view_methods\n        ancestor_methods = ancestors.reject { |klass| klass == self }\n          .map(&:instance_methods).flatten(1)\n\n        instance_methods - ancestor_methods + auto_curried_methods.to_a\n      end\n\n      # @api private\n      def schemas\n        @schemas ||= {}\n      end\n\n      # Return default relation name used in schemas\n      #\n      # @return [Name]\n      #\n      # @api private\n      def default_name\n        Name[Inflector.underscore(name).tr('/', '_').to_sym]\n      end\n\n      # @api private\n      def default_schema(klass = self)\n        klass.schema ||\n          if klass.schema_proc\n            klass.set_schema!(klass.schema_proc.call)\n          else\n            klass.schema_class.define(klass.default_name)\n          end\n      end\n\n      # @api private\n      def name = super || superclass.name\n\n      private\n\n      def invalid_relation_name?(relation)\n        INVALID_RELATIONS_NAMES.include?(relation.to_sym)\n      end\n    end\n    # rubocop:enable Metrics/ModuleLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "view", "signature": "def view(*args, &block)", "start_line": 194, "end_line": 228}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 466}
{"function_name": "mapper_registry", "file_path": "rom/core/lib/rom/relation/class_interface.rb", "focal_code": "def mapper_registry(opts = EMPTY_HASH)\n        adapter_ns = ROM.adapters[adapter]\n\n        compiler =\n          if adapter_ns&.const_defined?(:MapperCompiler)\n            adapter_ns.const_get(:MapperCompiler)\n          else\n            MapperCompiler\n          end\n\n        MapperRegistry.new({}, compiler: compiler.new(**opts), **opts)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'set'\n\nrequire 'rom/support/inflector'\n\nrequire 'rom/constants'\nrequire 'rom/relation/name'\nrequire 'rom/relation/view_dsl'\nrequire 'rom/schema'\nrequire 'rom/support/notifications'\n\nmodule ROM\n  class Relation\n    # Global class-level API for relation classes\n    #\n    # @api public\n    # rubocop:disable Metrics/ModuleLength\n    module ClassInterface\n      extend Notifications::Listener\n\n      subscribe('configuration.relations.object.registered') do |event|\n        relation = event[:relation]\n        registry = event[:registry]\n\n        schemas = relation.schemas.reduce({}) do |h, (a, e)|\n          h.update(a => e.is_a?(Proc) ? relation.class.instance_exec(registry, &e) : e)\n        end\n\n        relation.schemas.update(schemas)\n        relation\n      end\n\n      DEFAULT_DATASET_PROC = -> * { self }.freeze\n      INVALID_RELATIONS_NAMES = [\n        :relations\n      ].freeze\n\n      # Return adapter-specific relation subclass\n      #\n      # @example\n      #   ROM::Relation[:memory]\n      #   # => ROM::Memory::Relation\n      #\n      # @return [Class]\n      #\n      # @api public\n      def [](adapter)\n        ROM.adapters.fetch(adapter).const_get(:Relation)\n      rescue KeyError\n        raise AdapterNotPresentError.new(adapter, :relation)\n      end\n\n      # Set or get custom dataset block\n      #\n      # This block will be evaluated when a relation is instantiated and registered\n      # in a relation registry.\n      #\n      # @example\n      #   class Users < ROM::Relation[:memory]\n      #     dataset { sort_by(:id) }\n      #   end\n      #\n      # @api public\n      def dataset(&block)\n        if defined?(@dataset)\n          @dataset\n        else\n          @dataset = block || DEFAULT_DATASET_PROC\n        end\n      end\n\n      # Specify canonical schema for a relation\n      #\n      # With a schema defined commands will set up a type-safe input handler\n      # automatically\n      #\n      # @example\n      #   class Users < ROM::Relation[:sql]\n      #     schema do\n      #       attribute :id, Types::Serial\n      #       attribute :name, Types::String\n      #     end\n      #   end\n      #\n      #   # access schema from a finalized relation\n      #   users.schema\n      #\n      # @return [Schema]\n      #\n      # @param [Symbol] dataset An optional dataset name\n      # @param [Boolean] infer Whether to do an automatic schema inferring\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def schema(dataset = nil, as: nil, infer: false, &)\n        if defined?(@schema) && !block_given? && !infer\n          @schema\n        elsif block_given? || infer\n          raise MissingSchemaClassError, self unless schema_class\n\n          ds_name = dataset || schema_opts.fetch(:dataset, default_name.dataset)\n          relation = as || schema_opts.fetch(:relation, ds_name)\n\n          raise InvalidRelationName, relation if invalid_relation_name?(relation)\n\n          @relation_name = Name[relation, ds_name]\n\n          @schema_proc = proc do |*args, &inner_block|\n            schema_dsl.new(\n              relation_name,\n              schema_class: schema_class,\n              attr_class: schema_attr_class,\n              inferrer: schema_inferrer.with(enabled: infer),\n              &\n            ).call(*args, &inner_block)\n          end\n        end\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Assign a schema to a relation class\n      #\n      # @param [Schema] schema\n      #\n      # @return [Schema]\n      #\n      # @api private\n      def set_schema!(schema)\n        @schema = schema\n      end\n\n      # @api private\n      attr_reader :schema_proc\n\n      # @!attribute [r] relation_name\n      #   @return [Name] Qualified relation name\n      def relation_name\n        raise MissingSchemaError, self unless defined?(@relation_name)\n\n        @relation_name\n      end\n\n      # Define a relation view with a specific schema\n      #\n      # This method should only be used in cases where a given adapter doesn't\n      # support automatic schema projection at run-time.\n      #\n      # **It's not needed in rom-sql**\n      #\n      # @overload view(name, schema, &block)\n      #   @example View with the canonical schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      #   @example View with a projected schema\n      #     class Users < ROM::Relation[:sql]\n      #       view(:listing, schema.project(:id, :name)) do\n      #         order(:name)\n      #       end\n      #     end\n      #\n      # @overload view(name, &block)\n      #   @example View with the canonical schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do |name|\n      #         where(name: name)\n      #       end\n      #     end\n      #\n      #   @example View with projected schema and arguments\n      #     class Users < ROM::Relation[:sql]\n      #       view(:by_name) do\n      #         schema { project(:id, :name) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      #   @example View with a schema extended with foreign attributes\n      #     class Users < ROM::Relation[:sql]\n      #       view(:index) do\n      #         schema { append(relations[:tasks][:title]) }\n      #         relation { |name| where(name: name) }\n      #       end\n      #     end\n      #\n      # @return [Symbol] view method name\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n      def view(*args, &block)\n        if args.size == 1 && block.arity.positive?\n          raise ArgumentError, 'schema attribute names must be provided as the second argument'\n        end\n\n        name, new_schema_fn, relation_block =\n          if args.size == 1\n            ViewDSL.new(*args, schema, &block).call\n          else\n            [*args, block]\n          end\n\n        schemas[name] =\n          if args.size == 2\n            -> _ { schema.project(*args[1]) }\n          else\n            new_schema_fn\n          end\n\n        if relation_block.arity.positive?\n          auto_curry_guard do\n            define_method(name, &relation_block)\n\n            auto_curry(name) do\n              schemas[name].(self)\n            end\n          end\n        else\n          define_method(name) do\n            schemas[name].(instance_exec(&relation_block))\n          end\n        end\n\n        name\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n\n      # Dynamically define a method that will forward to the dataset and wrap\n      # response in the relation itself\n      #\n      # @example\n      #   class SomeAdapterRelation < ROM::Relation\n      #     forward :super_query\n      #   end\n      #\n      # @api public\n      def forward(*methods)\n        methods.each do |method|\n          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)\n            def #{method}(...)                        # def super_query(...)\n              new(dataset.__send__(:#{method}, ...))  #   new(dataset.__send__(:super_query, ...))\n            end                                       # end\n          RUBY\n        end\n      end\n\n      # Include a registered plugin in this relation class\n      #\n      # @param [Symbol] plugin\n      # @param [Hash] options\n      # @option options [Symbol] :adapter (:default) first adapter to check for plugin\n      #\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:relation].fetch(plugin, adapter).apply_to(self, **options)\n      end\n\n      # Build default mapper registry\n      #\n      # @return [MapperRegistry]\n      #\n      # @api private\n      def mapper_registry(opts = EMPTY_HASH)\n        adapter_ns = ROM.adapters[adapter]\n\n        compiler =\n          if adapter_ns&.const_defined?(:MapperCompiler)\n            adapter_ns.const_get(:MapperCompiler)\n          else\n            MapperCompiler\n          end\n\n        MapperRegistry.new({}, compiler: compiler.new(**opts), **opts)\n      end\n\n      # @api private\n      def curried = Curried\n\n      # @api private\n      def view_methods\n        ancestor_methods = ancestors.reject { |klass| klass == self }\n          .map(&:instance_methods).flatten(1)\n\n        instance_methods - ancestor_methods + auto_curried_methods.to_a\n      end\n\n      # @api private\n      def schemas\n        @schemas ||= {}\n      end\n\n      # Return default relation name used in schemas\n      #\n      # @return [Name]\n      #\n      # @api private\n      def default_name\n        Name[Inflector.underscore(name).tr('/', '_').to_sym]\n      end\n\n      # @api private\n      def default_schema(klass = self)\n        klass.schema ||\n          if klass.schema_proc\n            klass.set_schema!(klass.schema_proc.call)\n          else\n            klass.schema_class.define(klass.default_name)\n          end\n      end\n\n      # @api private\n      def name = super || superclass.name\n\n      private\n\n      def invalid_relation_name?(relation)\n        INVALID_RELATIONS_NAMES.include?(relation.to_sym)\n      end\n    end\n    # rubocop:enable Metrics/ModuleLength\n  end\nend\n", "language": "ruby", "function_component": {"name": "mapper_registry", "signature": "def mapper_registry(opts = EMPTY_HASH)", "start_line": 266, "end_line": 277}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 467}
{"function_name": "one", "file_path": "rom/core/lib/rom/relation/loaded.rb", "focal_code": "def one\n        if collection.count > 1\n          raise(\n            TupleCountMismatchError,\n            'The relation consists of more than one tuple'\n          )\n        else\n          collection.first\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Relation\n    # Materializes a relation and exposes interface to access the data.\n    #\n    # This relation type is returned when a lazy relation is called\n    #\n    # @api public\n    class Loaded\n      include ::Enumerable\n      include ::Dry::Equalizer(:source, :collection)\n\n      # Coerce loaded relation to an array\n      #\n      # @return [Array]\n      #\n      # @api public\n      alias_method :to_ary, :to_a\n\n      # Source relation\n      #\n      # @return [Relation]\n      #\n      # @api private\n      attr_reader :source\n\n      # Materialized relation\n      #\n      # @return [Object]\n      #\n      # @api private\n      attr_reader :collection\n\n      # @api private\n      def initialize(source, collection = source.to_a)\n        @source = source\n        @collection = collection\n      end\n\n      # Yield relation tuples\n      #\n      # @yield [Hash]\n      #\n      # @api public\n      def each(&)\n        return to_enum unless block_given?\n\n        collection.each(&)\n      end\n\n      # Returns a single tuple from the relation if there is one.\n      #\n      # @raise [ROM::TupleCountMismatchError] if the relation contains more than\n      #   one tuple\n      #\n      # @api public\n      def one\n        if collection.count > 1\n          raise(\n            TupleCountMismatchError,\n            'The relation consists of more than one tuple'\n          )\n        else\n          collection.first\n        end\n      end\n\n      # Like [one], but additionally raises an error if the relation is empty.\n      #\n      # @raise [ROM::TupleCountMismatchError] if the relation does not contain\n      #   exactly one tuple\n      #\n      # @api public\n      def one!\n        one || raise(\n          TupleCountMismatchError,\n          'The relation does not contain any tuples'\n        )\n      end\n\n      # Return a list of values under provided key\n      #\n      # @example\n      #   all_users = rom.relations[:users].call\n      #   all_users.pluck(:name)\n      #   # [\"Jane\", \"Joe\"]\n      #\n      # @param [Symbol] key The key name\n      #\n      # @return [Array]\n      #\n      # @raise KeyError when provided key doesn't exist in any of the tuples\n      #\n      # @api public\n      def pluck(key) = map { |tuple| tuple.fetch(key) }\n\n      # Pluck primary key values\n      #\n      # This method *may not work* with adapters that don't provide relations\n      # that have primary key configured\n      #\n      # @example\n      #   users = rom.relations[:users].call\n      #   users.primary_keys\n      #   # [1, 2, 3]\n      #\n      # @return [Array]\n      #\n      # @api public\n      def primary_keys = pluck(source.primary_key)\n\n      # Return if loaded relation is empty\n      #\n      # @return [TrueClass,FalseClass]\n      #\n      # @api public\n      def empty? = collection.empty?\n\n      # Return a loaded relation with a new collection\n      #\n      # @api public\n      def new(collection) = self.class.new(source, collection)\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "one", "signature": "def one if collection.count > 1", "start_line": 58, "end_line": 67}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 468}
{"function_name": "new", "file_path": "rom/core/lib/rom/relation/combined.rb", "focal_code": "def self.new(relation, nodes)\n        struct_ns = relation.options[:struct_namespace]\n        new_nodes = nodes.uniq(&:name).map { |node| node.struct_namespace(struct_ns) }\n\n        root =\n          if relation.is_a?(self)\n            new_nodes.concat(relation.nodes)\n            relation.root\n          else\n            relation\n          end\n\n        super(root, new_nodes)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/relation/graph'\nrequire 'rom/relation/commands'\n\nmodule ROM\n  class Relation\n    # Represents a relation graphs which combines root relation\n    # with other relation nodes\n    #\n    # @api public\n    class Combined < Graph\n      include Commands\n\n      # Create a new relation combined with others\n      #\n      # @param [Relation] relation\n      # @param [Array<Relation>] nodes\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def self.new(relation, nodes)\n        struct_ns = relation.options[:struct_namespace]\n        new_nodes = nodes.uniq(&:name).map { |node| node.struct_namespace(struct_ns) }\n\n        root =\n          if relation.is_a?(self)\n            new_nodes.concat(relation.nodes)\n            relation.root\n          else\n            relation\n          end\n\n        super(root, new_nodes)\n      end\n\n      # Combine this graph with more nodes\n      #\n      # @param [Array<Relation>] others A list of relations\n      #\n      # @return [Graph]\n      #\n      # @api public\n      def combine_with(*others)\n        self.class.new(root, nodes + others)\n      end\n\n      # Combine with other relations\n      #\n      # @see Relation#combine\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def combine(*args)\n        self.class.new(root, nodes + root.combine(*args).nodes)\n      end\n\n      # Materialize combined relation\n      #\n      # @return [Loaded]\n      #\n      # @api public\n      def call(*args)\n        left = root.with(auto_map: false, auto_struct: false).call(*args)\n\n        right =\n          if left.empty?\n            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }\n          else\n            nodes.map { |node| node.call(left) }\n          end\n\n        if auto_map?\n          Loaded.new(self, mapper.([left, right]))\n        else\n          Loaded.new(self, [left, right])\n        end\n      end\n\n      # Return a new combined relation with adjusted node returned from a block\n      #\n      # @example with a node identifier\n      #   combine(:tasks).node(:tasks) { |tasks| tasks.prioritized }\n      #\n      # @example with a nested path\n      #   combine(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }\n      #\n      # @param [Symbol] name The node relation name\n      #\n      # @yieldparam [Relation] relation The relation node\n      # @yieldreturn [Relation] The new relation node\n      #\n      # @return [Relation]\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def node(name, &)\n        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)\n          raise ArgumentError, \"#{name.inspect} is not a valid aggregate node name\"\n        end\n\n        new_nodes = nodes.map { |node|\n          case name\n          when Symbol\n            name == node.name.key ? yield(node) : node\n          when Hash\n            other, *rest = name.flatten(1)\n            if other == node.name.key\n              nodes.detect { |n| n.name.key == other }.node(*rest, &)\n            else\n              node\n            end\n          else\n            node\n          end\n        }\n\n        with_nodes(new_nodes)\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Return a `:create` command that can insert data from a nested hash.\n      #\n      # This is limited to `:create` commands only, because automatic restriction\n      # for `:update` commands would be quite complex. It's possible that in the\n      # future support for `:update` commands will be added though.\n      #\n      # Another limitation is that it can only work when you're composing\n      # parent and its child(ren), which follows canonical hierarchy from your\n      # database, so that parents are created first, then their PKs are set\n      # as FKs in child tuples. It should be possible to make it work with\n      # both directions (parent => child or child => parent), and it would\n      # require converting input tuples based on how they depend on each other,\n      # which we could do in the future.\n      #\n      # Expanding functionality of this method is planned for rom 5.0.\n      #\n      # @see Relation#command\n      #\n      # @raise NotImplementedError when type is not `:create`\n      #\n      # @api public\n      def command(type, **)\n        if type == :create\n          super\n        else\n          raise NotImplementedError,\n                \"#{self.class}#command doesn't work with #{type.inspect} command type yet\"\n        end\n      end\n\n      private\n\n      # @api private\n      def decorate?(other)\n        super || other.is_a?(self.class) || other.is_a?(Wrap)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "new", "signature": "def self.new(relation, nodes)", "start_line": 23, "end_line": 36}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 469}
{"function_name": "call", "file_path": "rom/core/lib/rom/relation/combined.rb", "focal_code": "def call(*args)\n        left = root.with(auto_map: false, auto_struct: false).call(*args)\n\n        right =\n          if left.empty?\n            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }\n          else\n            nodes.map { |node| node.call(left) }\n          end\n\n        if auto_map?\n          Loaded.new(self, mapper.([left, right]))\n        else\n          Loaded.new(self, [left, right])\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/relation/graph'\nrequire 'rom/relation/commands'\n\nmodule ROM\n  class Relation\n    # Represents a relation graphs which combines root relation\n    # with other relation nodes\n    #\n    # @api public\n    class Combined < Graph\n      include Commands\n\n      # Create a new relation combined with others\n      #\n      # @param [Relation] relation\n      # @param [Array<Relation>] nodes\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def self.new(relation, nodes)\n        struct_ns = relation.options[:struct_namespace]\n        new_nodes = nodes.uniq(&:name).map { |node| node.struct_namespace(struct_ns) }\n\n        root =\n          if relation.is_a?(self)\n            new_nodes.concat(relation.nodes)\n            relation.root\n          else\n            relation\n          end\n\n        super(root, new_nodes)\n      end\n\n      # Combine this graph with more nodes\n      #\n      # @param [Array<Relation>] others A list of relations\n      #\n      # @return [Graph]\n      #\n      # @api public\n      def combine_with(*others)\n        self.class.new(root, nodes + others)\n      end\n\n      # Combine with other relations\n      #\n      # @see Relation#combine\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def combine(*args)\n        self.class.new(root, nodes + root.combine(*args).nodes)\n      end\n\n      # Materialize combined relation\n      #\n      # @return [Loaded]\n      #\n      # @api public\n      def call(*args)\n        left = root.with(auto_map: false, auto_struct: false).call(*args)\n\n        right =\n          if left.empty?\n            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }\n          else\n            nodes.map { |node| node.call(left) }\n          end\n\n        if auto_map?\n          Loaded.new(self, mapper.([left, right]))\n        else\n          Loaded.new(self, [left, right])\n        end\n      end\n\n      # Return a new combined relation with adjusted node returned from a block\n      #\n      # @example with a node identifier\n      #   combine(:tasks).node(:tasks) { |tasks| tasks.prioritized }\n      #\n      # @example with a nested path\n      #   combine(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }\n      #\n      # @param [Symbol] name The node relation name\n      #\n      # @yieldparam [Relation] relation The relation node\n      # @yieldreturn [Relation] The new relation node\n      #\n      # @return [Relation]\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def node(name, &)\n        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)\n          raise ArgumentError, \"#{name.inspect} is not a valid aggregate node name\"\n        end\n\n        new_nodes = nodes.map { |node|\n          case name\n          when Symbol\n            name == node.name.key ? yield(node) : node\n          when Hash\n            other, *rest = name.flatten(1)\n            if other == node.name.key\n              nodes.detect { |n| n.name.key == other }.node(*rest, &)\n            else\n              node\n            end\n          else\n            node\n          end\n        }\n\n        with_nodes(new_nodes)\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Return a `:create` command that can insert data from a nested hash.\n      #\n      # This is limited to `:create` commands only, because automatic restriction\n      # for `:update` commands would be quite complex. It's possible that in the\n      # future support for `:update` commands will be added though.\n      #\n      # Another limitation is that it can only work when you're composing\n      # parent and its child(ren), which follows canonical hierarchy from your\n      # database, so that parents are created first, then their PKs are set\n      # as FKs in child tuples. It should be possible to make it work with\n      # both directions (parent => child or child => parent), and it would\n      # require converting input tuples based on how they depend on each other,\n      # which we could do in the future.\n      #\n      # Expanding functionality of this method is planned for rom 5.0.\n      #\n      # @see Relation#command\n      #\n      # @raise NotImplementedError when type is not `:create`\n      #\n      # @api public\n      def command(type, **)\n        if type == :create\n          super\n        else\n          raise NotImplementedError,\n                \"#{self.class}#command doesn't work with #{type.inspect} command type yet\"\n        end\n      end\n\n      private\n\n      # @api private\n      def decorate?(other)\n        super || other.is_a?(self.class) || other.is_a?(Wrap)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 65, "end_line": 80}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 470}
{"function_name": "node", "file_path": "rom/core/lib/rom/relation/combined.rb", "focal_code": "def node(name, &)\n        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)\n          raise ArgumentError, \"#{name.inspect} is not a valid aggregate node name\"\n        end\n\n        new_nodes = nodes.map { |node|\n          case name\n          when Symbol\n            name == node.name.key ? yield(node) : node\n          when Hash\n            other, *rest = name.flatten(1)\n            if other == node.name.key\n              nodes.detect { |n| n.name.key == other }.node(*rest, &)\n            else\n              node\n            end\n          else\n            node\n          end\n        }\n\n        with_nodes(new_nodes)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/relation/graph'\nrequire 'rom/relation/commands'\n\nmodule ROM\n  class Relation\n    # Represents a relation graphs which combines root relation\n    # with other relation nodes\n    #\n    # @api public\n    class Combined < Graph\n      include Commands\n\n      # Create a new relation combined with others\n      #\n      # @param [Relation] relation\n      # @param [Array<Relation>] nodes\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def self.new(relation, nodes)\n        struct_ns = relation.options[:struct_namespace]\n        new_nodes = nodes.uniq(&:name).map { |node| node.struct_namespace(struct_ns) }\n\n        root =\n          if relation.is_a?(self)\n            new_nodes.concat(relation.nodes)\n            relation.root\n          else\n            relation\n          end\n\n        super(root, new_nodes)\n      end\n\n      # Combine this graph with more nodes\n      #\n      # @param [Array<Relation>] others A list of relations\n      #\n      # @return [Graph]\n      #\n      # @api public\n      def combine_with(*others)\n        self.class.new(root, nodes + others)\n      end\n\n      # Combine with other relations\n      #\n      # @see Relation#combine\n      #\n      # @return [Combined]\n      #\n      # @api public\n      def combine(*args)\n        self.class.new(root, nodes + root.combine(*args).nodes)\n      end\n\n      # Materialize combined relation\n      #\n      # @return [Loaded]\n      #\n      # @api public\n      def call(*args)\n        left = root.with(auto_map: false, auto_struct: false).call(*args)\n\n        right =\n          if left.empty?\n            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }\n          else\n            nodes.map { |node| node.call(left) }\n          end\n\n        if auto_map?\n          Loaded.new(self, mapper.([left, right]))\n        else\n          Loaded.new(self, [left, right])\n        end\n      end\n\n      # Return a new combined relation with adjusted node returned from a block\n      #\n      # @example with a node identifier\n      #   combine(:tasks).node(:tasks) { |tasks| tasks.prioritized }\n      #\n      # @example with a nested path\n      #   combine(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }\n      #\n      # @param [Symbol] name The node relation name\n      #\n      # @yieldparam [Relation] relation The relation node\n      # @yieldreturn [Relation] The new relation node\n      #\n      # @return [Relation]\n      #\n      # @api public\n      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n      def node(name, &)\n        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)\n          raise ArgumentError, \"#{name.inspect} is not a valid aggregate node name\"\n        end\n\n        new_nodes = nodes.map { |node|\n          case name\n          when Symbol\n            name == node.name.key ? yield(node) : node\n          when Hash\n            other, *rest = name.flatten(1)\n            if other == node.name.key\n              nodes.detect { |n| n.name.key == other }.node(*rest, &)\n            else\n              node\n            end\n          else\n            node\n          end\n        }\n\n        with_nodes(new_nodes)\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n      # Return a `:create` command that can insert data from a nested hash.\n      #\n      # This is limited to `:create` commands only, because automatic restriction\n      # for `:update` commands would be quite complex. It's possible that in the\n      # future support for `:update` commands will be added though.\n      #\n      # Another limitation is that it can only work when you're composing\n      # parent and its child(ren), which follows canonical hierarchy from your\n      # database, so that parents are created first, then their PKs are set\n      # as FKs in child tuples. It should be possible to make it work with\n      # both directions (parent => child or child => parent), and it would\n      # require converting input tuples based on how they depend on each other,\n      # which we could do in the future.\n      #\n      # Expanding functionality of this method is planned for rom 5.0.\n      #\n      # @see Relation#command\n      #\n      # @raise NotImplementedError when type is not `:create`\n      #\n      # @api public\n      def command(type, **)\n        if type == :create\n          super\n        else\n          raise NotImplementedError,\n                \"#{self.class}#command doesn't work with #{type.inspect} command type yet\"\n        end\n      end\n\n      private\n\n      # @api private\n      def decorate?(other)\n        super || other.is_a?(self.class) || other.is_a?(Wrap)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "node", "signature": "def node(name, &)", "start_line": 99, "end_line": 121}, "metadata": {"module": "ROM", "class_name": "Relation", "class_signature": "class Relation"}, "task_id": 471}
{"function_name": "call", "file_path": "rom/core/lib/rom/setup/auto_registration_strategies/custom_namespace.rb", "focal_code": "def call\n        parts = path_arr.map { |part| Inflector.camelize(part) }\n        potential = parts.map.with_index do |_, i|\n          parts[(i - parts.size)..parts.size]\n        end\n        attempted = []\n\n        potential.map do |path|\n          const_fragment = path.join('::')\n\n          constant = \"#{namespace}::#{const_fragment}\"\n\n          return constant if ns_const.const_defined?(const_fragment)\n\n          attempted << constant\n        end\n\n        # If we have reached this point, its means constant is not defined and\n        # NameError will be thrown if we attempt to camelize something like:\n        # `\"#{namespace}::#{Inflector.camelize(filename)}\"`\n        # so we can assume naming convention was not respected in required\n        # file.\n\n        raise NameError, name_error_message(attempted)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'pathname'\n\nrequire 'rom/support/inflector'\nrequire 'rom/types'\nrequire 'rom/setup/auto_registration_strategies/base'\n\nmodule ROM\n  module AutoRegistrationStrategies\n    # Custom namespace strategy loads components and assumes they are defined\n    # within the provided namespace\n    #\n    # @api private\n    class CustomNamespace < Base\n      # @!attribute [r] directory\n      #   @return [Pathname] The path to dir with components\n      option :directory, type: PathnameType\n\n      # @!attribute [r] namespace\n      #   @return [String] Name of a namespace\n      option :namespace, type: Types::Strict::String\n\n      # Loads components\n      #\n      # @api private\n      def call\n        parts = path_arr.map { |part| Inflector.camelize(part) }\n        potential = parts.map.with_index do |_, i|\n          parts[(i - parts.size)..parts.size]\n        end\n        attempted = []\n\n        potential.map do |path|\n          const_fragment = path.join('::')\n\n          constant = \"#{namespace}::#{const_fragment}\"\n\n          return constant if ns_const.const_defined?(const_fragment)\n\n          attempted << constant\n        end\n\n        # If we have reached this point, its means constant is not defined and\n        # NameError will be thrown if we attempt to camelize something like:\n        # `\"#{namespace}::#{Inflector.camelize(filename)}\"`\n        # so we can assume naming convention was not respected in required\n        # file.\n\n        raise NameError, name_error_message(attempted)\n      end\n\n      private\n\n      # @api private\n      def name_error_message(attempted)\n        'required file does not define expected constant name; either ' \\\n          'register your constant explicitly of try following the path' \\\n          \"naming convention like:\\n\\n\\t- #{attempted.join(\"\\n\\t- \")}\\n\"\n      end\n\n      # @api private\n      def filename = Pathname(file).basename('.rb')\n\n      # @api private\n      def ns_const\n        @namespace_constant ||= Inflector.constantize(namespace)\n      end\n\n      # @api private\n      def path_arr = file_path << filename\n\n      # @api private\n      def file_path\n        File.dirname(file).split('/') - directory.to_s.split('/')\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call parts = path_arr.map { |part| Inflector.camelize(part) }", "start_line": 27, "end_line": 51}, "metadata": {"module": "ROM", "class_name": "CustomNamespace", "class_signature": "class CustomNamespace < < Base"}, "task_id": 472}
{"function_name": "run!", "file_path": "rom/core/lib/rom/setup/finalize/finalize_relations.rb", "focal_code": "def run!\n        relation_registry = RelationRegistry.new do |registry, relations|\n          registry_readers = RegistryReaders.new(relation_names)\n          @relation_classes.each do |klass|\n            unless klass.adapter\n              raise MissingAdapterIdentifierError,\n                    \"Relation class +#{klass}+ is missing the adapter identifier\"\n            end\n\n            key = klass.relation_name.to_sym\n\n            if registry.key?(key)\n              raise RelationAlreadyDefinedError,\n                    \"Relation with name #{key.inspect} registered more than once\"\n            end\n\n            klass.use(:registry_reader, readers: registry_readers)\n\n            notifications.trigger(\n              'configuration.relations.class.ready',\n              relation: klass,\n              adapter: klass.adapter\n            )\n\n            relations[key] = build_relation(klass, registry)\n          end\n\n          registry.each_value do |relation|\n            notifications.trigger(\n              'configuration.relations.object.registered',\n              relation: relation, registry: registry\n            )\n          end\n        end\n\n        notifications.trigger(\n          'configuration.relations.registry.created', registry: relation_registry\n        )\n\n        relation_registry\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/constants'\nrequire 'rom/relation_registry'\nrequire 'rom/mapper_registry'\n\nmodule ROM\n  class Finalize\n    class FinalizeRelations\n      attr_reader :notifications\n\n      class RegistryReaders < ::Module\n        def initialize(relations)\n          super()\n\n          relations.each do |name|\n            define_method(name) { __registry__[name] }\n          end\n        end\n      end\n\n      # Build relation registry of specified descendant classes\n      #\n      # This is used by the setup\n      #\n      # @param [Hash] gateways\n      # @param [Array] relation_classes a list of relation descendants\n      #\n      # @api private\n      def initialize(gateways, relation_classes, notifications:, mappers: nil, plugins: EMPTY_ARRAY)\n        @gateways = gateways\n        @relation_classes = relation_classes\n        @mappers = mappers\n        @plugins = plugins\n        @notifications = notifications\n      end\n\n      # @return [Hash]\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength\n      def run!\n        relation_registry = RelationRegistry.new do |registry, relations|\n          registry_readers = RegistryReaders.new(relation_names)\n          @relation_classes.each do |klass|\n            unless klass.adapter\n              raise MissingAdapterIdentifierError,\n                    \"Relation class +#{klass}+ is missing the adapter identifier\"\n            end\n\n            key = klass.relation_name.to_sym\n\n            if registry.key?(key)\n              raise RelationAlreadyDefinedError,\n                    \"Relation with name #{key.inspect} registered more than once\"\n            end\n\n            klass.use(:registry_reader, readers: registry_readers)\n\n            notifications.trigger(\n              'configuration.relations.class.ready',\n              relation: klass,\n              adapter: klass.adapter\n            )\n\n            relations[key] = build_relation(klass, registry)\n          end\n\n          registry.each_value do |relation|\n            notifications.trigger(\n              'configuration.relations.object.registered',\n              relation: relation, registry: registry\n            )\n          end\n        end\n\n        notifications.trigger(\n          'configuration.relations.registry.created', registry: relation_registry\n        )\n\n        relation_registry\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength\n\n      # @return [ROM::Relation]\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize\n      def build_relation(klass, registry)\n        # TODO: raise a meaningful error here and add spec covering the case\n        #       where klass' gateway points to non-existant repo\n        gateway = @gateways.fetch(klass.gateway)\n\n        plugins = schema_plugins\n\n        schema = klass.schema_proc.call do\n          plugins.each { |plugin| app_plugin(plugin) }\n        end\n\n        klass.set_schema!(schema) if klass.schema.nil?\n\n        notifications.trigger(\n          'configuration.relations.schema.allocated',\n          schema: schema, gateway: gateway, registry: registry\n        )\n\n        relation_plugins.each do |plugin|\n          plugin.apply_to(klass)\n        end\n\n        notifications.trigger(\n          'configuration.relations.schema.set',\n          schema: schema, relation: klass, registry: registry, adapter: klass.adapter\n        )\n\n        rel_key = schema.name.to_sym\n        dataset = gateway.dataset(schema.name.dataset).instance_exec(klass, &klass.dataset)\n\n        notifications.trigger(\n          'configuration.relations.dataset.allocated',\n          dataset: dataset, relation: klass, adapter: klass.adapter\n        )\n\n        options = {\n          __registry__: registry,\n          mappers: mapper_registry(rel_key, klass),\n          schema: schema,\n          **plugin_options\n        }\n\n        klass.new(dataset, **options)\n      end\n      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize\n\n      # @api private\n      def mapper_registry(rel_key, rel_class)\n        registry = rel_class.mapper_registry(cache: @mappers.cache)\n\n        if @mappers.key?(rel_key)\n          registry.merge(@mappers[rel_key])\n        else\n          registry\n        end\n      end\n\n      # @api private\n      def plugin_options\n        relation_plugins.map(&:config).map(&:to_hash).reduce(:merge) || EMPTY_HASH\n      end\n\n      # @api private\n      def relation_plugins\n        @plugins.select { |p| p.type == :relation }\n      end\n\n      # @api private\n      def schema_plugins\n        @plugins.select { |p| p.type == :schema }\n      end\n\n      # @api private\n      def relation_names\n        @relation_classes.map(&:relation_name).map(&:relation).uniq\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run!", "signature": "def run! relation_registry = RelationRegistry.new do |registry, relations|", "start_line": 43, "end_line": 83}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 473}
{"function_name": "build_relation", "file_path": "rom/core/lib/rom/setup/finalize/finalize_relations.rb", "focal_code": "def build_relation(klass, registry)\n        # TODO: raise a meaningful error here and add spec covering the case\n        #       where klass' gateway points to non-existant repo\n        gateway = @gateways.fetch(klass.gateway)\n\n        plugins = schema_plugins\n\n        schema = klass.schema_proc.call do\n          plugins.each { |plugin| app_plugin(plugin) }\n        end\n\n        klass.set_schema!(schema) if klass.schema.nil?\n\n        notifications.trigger(\n          'configuration.relations.schema.allocated',\n          schema: schema, gateway: gateway, registry: registry\n        )\n\n        relation_plugins.each do |plugin|\n          plugin.apply_to(klass)\n        end\n\n        notifications.trigger(\n          'configuration.relations.schema.set',\n          schema: schema, relation: klass, registry: registry, adapter: klass.adapter\n        )\n\n        rel_key = schema.name.to_sym\n        dataset = gateway.dataset(schema.name.dataset).instance_exec(klass, &klass.dataset)\n\n        notifications.trigger(\n          'configuration.relations.dataset.allocated',\n          dataset: dataset, relation: klass, adapter: klass.adapter\n        )\n\n        options = {\n          __registry__: registry,\n          mappers: mapper_registry(rel_key, klass),\n          schema: schema,\n          **plugin_options\n        }\n\n        klass.new(dataset, **options)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/constants'\nrequire 'rom/relation_registry'\nrequire 'rom/mapper_registry'\n\nmodule ROM\n  class Finalize\n    class FinalizeRelations\n      attr_reader :notifications\n\n      class RegistryReaders < ::Module\n        def initialize(relations)\n          super()\n\n          relations.each do |name|\n            define_method(name) { __registry__[name] }\n          end\n        end\n      end\n\n      # Build relation registry of specified descendant classes\n      #\n      # This is used by the setup\n      #\n      # @param [Hash] gateways\n      # @param [Array] relation_classes a list of relation descendants\n      #\n      # @api private\n      def initialize(gateways, relation_classes, notifications:, mappers: nil, plugins: EMPTY_ARRAY)\n        @gateways = gateways\n        @relation_classes = relation_classes\n        @mappers = mappers\n        @plugins = plugins\n        @notifications = notifications\n      end\n\n      # @return [Hash]\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength\n      def run!\n        relation_registry = RelationRegistry.new do |registry, relations|\n          registry_readers = RegistryReaders.new(relation_names)\n          @relation_classes.each do |klass|\n            unless klass.adapter\n              raise MissingAdapterIdentifierError,\n                    \"Relation class +#{klass}+ is missing the adapter identifier\"\n            end\n\n            key = klass.relation_name.to_sym\n\n            if registry.key?(key)\n              raise RelationAlreadyDefinedError,\n                    \"Relation with name #{key.inspect} registered more than once\"\n            end\n\n            klass.use(:registry_reader, readers: registry_readers)\n\n            notifications.trigger(\n              'configuration.relations.class.ready',\n              relation: klass,\n              adapter: klass.adapter\n            )\n\n            relations[key] = build_relation(klass, registry)\n          end\n\n          registry.each_value do |relation|\n            notifications.trigger(\n              'configuration.relations.object.registered',\n              relation: relation, registry: registry\n            )\n          end\n        end\n\n        notifications.trigger(\n          'configuration.relations.registry.created', registry: relation_registry\n        )\n\n        relation_registry\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength\n\n      # @return [ROM::Relation]\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize\n      def build_relation(klass, registry)\n        # TODO: raise a meaningful error here and add spec covering the case\n        #       where klass' gateway points to non-existant repo\n        gateway = @gateways.fetch(klass.gateway)\n\n        plugins = schema_plugins\n\n        schema = klass.schema_proc.call do\n          plugins.each { |plugin| app_plugin(plugin) }\n        end\n\n        klass.set_schema!(schema) if klass.schema.nil?\n\n        notifications.trigger(\n          'configuration.relations.schema.allocated',\n          schema: schema, gateway: gateway, registry: registry\n        )\n\n        relation_plugins.each do |plugin|\n          plugin.apply_to(klass)\n        end\n\n        notifications.trigger(\n          'configuration.relations.schema.set',\n          schema: schema, relation: klass, registry: registry, adapter: klass.adapter\n        )\n\n        rel_key = schema.name.to_sym\n        dataset = gateway.dataset(schema.name.dataset).instance_exec(klass, &klass.dataset)\n\n        notifications.trigger(\n          'configuration.relations.dataset.allocated',\n          dataset: dataset, relation: klass, adapter: klass.adapter\n        )\n\n        options = {\n          __registry__: registry,\n          mappers: mapper_registry(rel_key, klass),\n          schema: schema,\n          **plugin_options\n        }\n\n        klass.new(dataset, **options)\n      end\n      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize\n\n      # @api private\n      def mapper_registry(rel_key, rel_class)\n        registry = rel_class.mapper_registry(cache: @mappers.cache)\n\n        if @mappers.key?(rel_key)\n          registry.merge(@mappers[rel_key])\n        else\n          registry\n        end\n      end\n\n      # @api private\n      def plugin_options\n        relation_plugins.map(&:config).map(&:to_hash).reduce(:merge) || EMPTY_HASH\n      end\n\n      # @api private\n      def relation_plugins\n        @plugins.select { |p| p.type == :relation }\n      end\n\n      # @api private\n      def schema_plugins\n        @plugins.select { |p| p.type == :schema }\n      end\n\n      # @api private\n      def relation_names\n        @relation_classes.map(&:relation_name).map(&:relation).uniq\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_relation", "signature": "def build_relation(klass, registry)", "start_line": 91, "end_line": 134}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 474}
{"function_name": "run!", "file_path": "rom/core/lib/rom/setup/finalize/finalize_commands.rb", "focal_code": "def run!\n        commands = @command_classes.map do |klass|\n          relation = @relations[klass.relation]\n          gateway = @gateways[relation.gateway]\n\n          notifications.trigger(\n            'configuration.commands.class.before_build',\n            command: klass, gateway: gateway, dataset: relation.dataset, adapter: relation.adapter\n          )\n\n          klass.extend_for_relation(relation) if klass.restrictable\n\n          klass.build(relation)\n        end\n\n        registry = Registry.new\n        compiler = CommandCompiler.new(@gateways, @relations, registry, notifications)\n\n        @relations.each do |(name, relation)|\n          rel_commands = commands.select { |c| c.relation.name == relation.name }\n\n          rel_commands.each do |command|\n            identifier = command.class.register_as || command.class.default_name\n            relation.commands.elements[identifier] = command\n          end\n\n          relation.commands.set_compiler(compiler)\n          relation.commands.set_mappers(relation.mappers)\n\n          registry.elements[name] = relation.commands\n        end\n\n        registry\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/registry'\nrequire 'rom/command_compiler'\nrequire 'rom/command_registry'\n\nmodule ROM\n  class Finalize\n    class FinalizeCommands\n      attr_reader :notifications\n\n      # Build command registry hash for provided relations\n      #\n      # @param [RelationRegistry] relations registry\n      # @param [Hash] gateways\n      # @param [Array] command_classes a list of command subclasses\n      #\n      # @api private\n      def initialize(relations, gateways, command_classes, notifications)\n        @relations = relations\n        @gateways = gateways\n        @command_classes = command_classes\n        @notifications = notifications\n      end\n\n      # @return [Hash]\n      #\n      # @api private\n      #\n      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength\n      def run!\n        commands = @command_classes.map do |klass|\n          relation = @relations[klass.relation]\n          gateway = @gateways[relation.gateway]\n\n          notifications.trigger(\n            'configuration.commands.class.before_build',\n            command: klass, gateway: gateway, dataset: relation.dataset, adapter: relation.adapter\n          )\n\n          klass.extend_for_relation(relation) if klass.restrictable\n\n          klass.build(relation)\n        end\n\n        registry = Registry.new\n        compiler = CommandCompiler.new(@gateways, @relations, registry, notifications)\n\n        @relations.each do |(name, relation)|\n          rel_commands = commands.select { |c| c.relation.name == relation.name }\n\n          rel_commands.each do |command|\n            identifier = command.class.register_as || command.class.default_name\n            relation.commands.elements[identifier] = command\n          end\n\n          relation.commands.set_compiler(compiler)\n          relation.commands.set_mappers(relation.mappers)\n\n          registry.elements[name] = relation.commands\n        end\n\n        registry\n      end\n      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run!", "signature": "def run! commands = @command_classes.map do |klass|", "start_line": 31, "end_line": 64}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 475}
{"function_name": "run!", "file_path": "rom/core/lib/rom/setup/finalize/finalize_mappers.rb", "focal_code": "def run!\n        cache = Cache.new\n\n        mappers = registry_hash.to_h do |relation_name, relation_mappers|\n          relation_mappers.update(build_mappers(relation_name))\n\n          if mapper_objects.key?(relation_name)\n            relation_mappers.update(mapper_objects[relation_name])\n          end\n\n          [relation_name, MapperRegistry.new(relation_mappers, cache: cache)]\n        end\n\n        Registry.new(mappers, cache: cache)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/registry'\n\nmodule ROM\n  class Finalize\n    class FinalizeMappers\n      attr_reader :mapper_classes\n      attr_reader :mapper_objects\n      attr_reader :registry_hash\n\n      # @api private\n      def initialize(mapper_classes, mapper_objects)\n        @mapper_classes = mapper_classes\n        @mapper_objects = mapper_objects\n\n        check_duplicate_registered_mappers\n\n        @registry_hash = [@mapper_classes.map(&:base_relation) + @mapper_objects.keys]\n          .flatten\n          .uniq\n          .to_h { [_1, {}] }\n      end\n\n      # @api private\n      def run!\n        cache = Cache.new\n\n        mappers = registry_hash.to_h do |relation_name, relation_mappers|\n          relation_mappers.update(build_mappers(relation_name))\n\n          if mapper_objects.key?(relation_name)\n            relation_mappers.update(mapper_objects[relation_name])\n          end\n\n          [relation_name, MapperRegistry.new(relation_mappers, cache: cache)]\n        end\n\n        Registry.new(mappers, cache: cache)\n      end\n\n      private\n\n      def check_duplicate_registered_mappers\n        duplicates = mapper_classes.map { [_1.relation, _1.register_as] }.tally.select { _2 > 1 }\n\n        case duplicates.first\n        in [rel, as], _\n          raise MapperAlreadyDefinedError,\n                \"Mapper with `register_as #{as.inspect}` registered more \" \\\n                \"than once for relation #{rel.inspect}\"\n        else\n          nil\n        end\n      end\n\n      def build_mappers(relation_name)\n        mapper_classes\n          .select { |klass| klass.base_relation == relation_name }\n          .to_h { |k| [k.register_as || k.relation, k.build] }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run!", "signature": "def run! cache = Cache.new", "start_line": 26, "end_line": 40}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 476}
{"function_name": "check_duplicate_registered_mappers", "file_path": "rom/core/lib/rom/setup/finalize/finalize_mappers.rb", "focal_code": "def check_duplicate_registered_mappers\n        duplicates = mapper_classes.map { [_1.relation, _1.register_as] }.tally.select { _2 > 1 }\n\n        case duplicates.first\n        in [rel, as], _\n          raise MapperAlreadyDefinedError,\n                \"Mapper with `register_as #{as.inspect}` registered more \" \\\n                \"than once for relation #{rel.inspect}\"\n        else\n          nil\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/registry'\n\nmodule ROM\n  class Finalize\n    class FinalizeMappers\n      attr_reader :mapper_classes\n      attr_reader :mapper_objects\n      attr_reader :registry_hash\n\n      # @api private\n      def initialize(mapper_classes, mapper_objects)\n        @mapper_classes = mapper_classes\n        @mapper_objects = mapper_objects\n\n        check_duplicate_registered_mappers\n\n        @registry_hash = [@mapper_classes.map(&:base_relation) + @mapper_objects.keys]\n          .flatten\n          .uniq\n          .to_h { [_1, {}] }\n      end\n\n      # @api private\n      def run!\n        cache = Cache.new\n\n        mappers = registry_hash.to_h do |relation_name, relation_mappers|\n          relation_mappers.update(build_mappers(relation_name))\n\n          if mapper_objects.key?(relation_name)\n            relation_mappers.update(mapper_objects[relation_name])\n          end\n\n          [relation_name, MapperRegistry.new(relation_mappers, cache: cache)]\n        end\n\n        Registry.new(mappers, cache: cache)\n      end\n\n      private\n\n      def check_duplicate_registered_mappers\n        duplicates = mapper_classes.map { [_1.relation, _1.register_as] }.tally.select { _2 > 1 }\n\n        case duplicates.first\n        in [rel, as], _\n          raise MapperAlreadyDefinedError,\n                \"Mapper with `register_as #{as.inspect}` registered more \" \\\n                \"than once for relation #{rel.inspect}\"\n        else\n          nil\n        end\n      end\n\n      def build_mappers(relation_name)\n        mapper_classes\n          .select { |klass| klass.base_relation == relation_name }\n          .to_h { |k| [k.register_as || k.relation, k.build] }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "check_duplicate_registered_mappers", "signature": "def check_duplicate_registered_mappers duplicates = mapper_classes.map { [_1.relation, _1.register_as] }.tally.select { _2 > 1 }", "start_line": 44, "end_line": 55}, "metadata": {"module": "ROM", "class_name": "Finalize", "class_signature": "class Finalize"}, "task_id": 477}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/lazy/delete.rb", "focal_code": "def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            raise NotImplementedError\n          else\n            input = evaluator.call(first)\n\n            if input.is_a?(Array)\n              input.map do |item|\n                command_proc[command, *(size > 1 ? [last, item] : [input])].call\n              end\n            else\n              command_proc[command, input].call\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  module Commands\n    class Lazy\n      # Lazy command wrapper for delete commands\n      #\n      # @api public\n      class Delete < Lazy\n        # Execute a lazy delete command\n        #\n        # @see Commands::Delete#call\n        #\n        # @return [Hash, Array<Hash>]\n        #\n        # @api public\n        def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            raise NotImplementedError\n          else\n            input = evaluator.call(first)\n\n            if input.is_a?(Array)\n              input.map do |item|\n                command_proc[command, *(size > 1 ? [last, item] : [input])].call\n              end\n            else\n              command_proc[command, input].call\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 17, "end_line": 35}, "metadata": {"module": "ROM", "class_name": "Lazy", "class_signature": "class Lazy"}, "task_id": 478}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/lazy/create.rb", "focal_code": "def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            last.map.with_index do |parent, index|\n              children = evaluator.call(first, index)\n              command_proc[command, parent, children].call(children, parent)\n            end.reduce(:concat)\n          else\n            input = evaluator.call(first)\n            command.call(input, *args[1..size - 1])\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  module Commands\n    class Lazy\n      # Lazy command wrapper for create commands\n      #\n      # @api public\n      class Create < Lazy\n        # Execute a command\n        #\n        # @see Command::Create#call\n        #\n        # @return [Hash,Array<Hash>]\n        #\n        # @api public\n        # rubocop:disable Metrics/AbcSize\n        def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            last.map.with_index do |parent, index|\n              children = evaluator.call(first, index)\n              command_proc[command, parent, children].call(children, parent)\n            end.reduce(:concat)\n          else\n            input = evaluator.call(first)\n            command.call(input, *args[1..size - 1])\n          end\n        end\n        # rubocop:enable Metrics/AbcSize\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 18, "end_line": 32}, "metadata": {"module": "ROM", "class_name": "Lazy", "class_signature": "class Lazy"}, "task_id": 479}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/lazy/update.rb", "focal_code": "def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            last.map.with_index do |parent, index|\n              children = evaluator.call(first, index)\n\n              children.map do |child|\n                command_proc[command, parent, child].call(child, parent)\n              end\n            end.reduce(:concat)\n          else\n            input = evaluator.call(first)\n\n            if input.is_a?(Array)\n              input.map.with_index do |item, _index|\n                command_proc[command, last, item].call(item, *args[1..size - 1])\n              end\n            else\n              command_proc[command, *(size > 1 ? [last, input] : [input])]\n                .call(input, *args[1..size - 1])\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  module Commands\n    class Lazy\n      # Lazy command wrapper for update commands\n      #\n      # @api public\n      class Update < Lazy\n        # Execute a lazy update command\n        #\n        # @see Commands::Update#call\n        #\n        # @return [Hash, Array<Hash>]\n        #\n        # @api public\n        # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n        def call(*args)\n          first = args.first\n          last = args.last\n          size = args.size\n\n          if size > 1 && last.is_a?(Array)\n            last.map.with_index do |parent, index|\n              children = evaluator.call(first, index)\n\n              children.map do |child|\n                command_proc[command, parent, child].call(child, parent)\n              end\n            end.reduce(:concat)\n          else\n            input = evaluator.call(first)\n\n            if input.is_a?(Array)\n              input.map.with_index do |item, _index|\n                command_proc[command, last, item].call(item, *args[1..size - 1])\n              end\n            else\n              command_proc[command, *(size > 1 ? [last, input] : [input])]\n                .call(input, *args[1..size - 1])\n            end\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(*args)", "start_line": 18, "end_line": 43}, "metadata": {"module": "ROM", "class_name": "Lazy", "class_signature": "class Lazy"}, "task_id": 480}
{"function_name": "build_command", "file_path": "rom/core/lib/rom/commands/graph/class_interface.rb", "focal_code": "def build_command(registry, spec, other, path)\n          cmd_opts, nodes = other\n\n          key, relation =\n            if spec.is_a?(Hash)\n              spec.to_a.first\n            else\n              [spec, spec]\n            end\n\n          name, opts =\n            if cmd_opts.is_a?(Hash)\n              cmd_opts.to_a.first\n            else\n              [cmd_opts]\n            end\n\n          command = registry[relation][name]\n          tuple_path = [*path] << key\n          input_proc = InputEvaluator.build(tuple_path, nodes)\n\n          command = command.curry(input_proc, opts)\n\n          if nodes\n            if nodes.all? { |node| node.is_a?(Array) }\n              command.combine(*nodes.map { |node| build(registry, node, tuple_path) })\n            else\n              command.combine(build(registry, nodes, tuple_path))\n            end\n          else\n            command\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/commands/graph/input_evaluator'\n\nmodule ROM\n  module Commands\n    class Graph\n      # Class methods for command Graph\n      #\n      # @api private\n      module ClassInterface\n        # Build a command graph recursively\n        #\n        # This is used by `Container#command` when array with options is passed in\n        #\n        # @param [Registry] registry The command registry from container\n        # @param [Array] options The options array\n        # @param [Array] path The path for input evaluator proc\n        #\n        # @return [Graph]\n        #\n        # @api private\n        def build(registry, options, path = EMPTY_ARRAY)\n          options.reduce { |spec, other| build_command(registry, spec, other, path) }\n        end\n\n        # @api private\n        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n        def build_command(registry, spec, other, path)\n          cmd_opts, nodes = other\n\n          key, relation =\n            if spec.is_a?(Hash)\n              spec.to_a.first\n            else\n              [spec, spec]\n            end\n\n          name, opts =\n            if cmd_opts.is_a?(Hash)\n              cmd_opts.to_a.first\n            else\n              [cmd_opts]\n            end\n\n          command = registry[relation][name]\n          tuple_path = [*path] << key\n          input_proc = InputEvaluator.build(tuple_path, nodes)\n\n          command = command.curry(input_proc, opts)\n\n          if nodes\n            if nodes.all? { |node| node.is_a?(Array) }\n              command.combine(*nodes.map { |node| build(registry, node, tuple_path) })\n            else\n              command.combine(build(registry, nodes, tuple_path))\n            end\n          else\n            command\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_command", "signature": "def build_command(registry, spec, other, path)", "start_line": 29, "end_line": 61}, "metadata": {"module": "ROM", "class_name": "Graph", "class_signature": "class Graph"}, "task_id": 481}
{"function_name": "call", "file_path": "rom/core/lib/rom/commands/graph/input_evaluator.rb", "focal_code": "def call(input, index = nil)\n          value =\n            begin\n              if index\n                tuple_path[0..tuple_path.size - 2]\n                  .reduce(input) { |a, e| a.fetch(e) }\n                  .at(index)[tuple_path.last]\n              else\n                tuple_path.reduce(input) { |a, e| a.fetch(e) }\n              end\n            rescue KeyError => e\n              raise KeyMissing, e.message\n            end\n\n          if excluded_keys\n            value.is_a?(Array) ? value.map(&exclude_proc) : exclude_proc[value]\n          else\n            value\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  module Commands\n    class Graph\n      # Evaluator for lazy commands which extracts values for commands from nested hashes\n      #\n      # @api private\n      class InputEvaluator\n        include Dry::Equalizer(:tuple_path, :excluded_keys)\n\n        # @!attribute [r] tuple_path\n        #   @return [Array<Symbol>] A list of keys pointing to a value inside a hash\n        attr_reader :tuple_path\n\n        # @!attribute [r] excluded_keys\n        #   @return [Array<Symbol>] A list of keys that should be excluded\n        attr_reader :excluded_keys\n\n        # @!attribute [r] exclude_proc\n        #   @return [Array<Symbol>] A function that should determine which keys should be excluded\n        attr_reader :exclude_proc\n\n        # Build an input evaluator\n        #\n        # @param [Array<Symbol>] tuple_path The tuple path\n        # @param [Array] nodes\n        #\n        # @return [InputEvaluator]\n        #\n        # @api private\n        def self.build(tuple_path, nodes)\n          new(tuple_path, extract_excluded_keys(nodes))\n        end\n\n        # @api private\n        def self.extract_excluded_keys(nodes)\n          return unless nodes\n\n          nodes\n            .map { |item| item.is_a?(Array) && item.size > 1 ? item.first : item }\n            .compact\n            .map { |item| item.is_a?(Hash) ? item.keys.first : item }\n            .reject { |item| item.is_a?(Array) }\n        end\n\n        # Return default exclude_proc\n        #\n        # @api private\n        def self.exclude_proc(excluded_keys)\n          -> input { input.except(*excluded_keys) }\n        end\n\n        # Initialize a new input evaluator\n        #\n        # @return [InputEvaluator]\n        #\n        # @api private\n        def initialize(tuple_path, excluded_keys)\n          @tuple_path = tuple_path\n          @excluded_keys = excluded_keys\n          @exclude_proc = self.class.exclude_proc(excluded_keys)\n        end\n\n        # Evaluate input hash\n        #\n        # @param [Hash] input The input hash\n        # @param [Integer] index Optional index\n        #\n        # @return [Hash]\n        # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n        def call(input, index = nil)\n          value =\n            begin\n              if index\n                tuple_path[0..tuple_path.size - 2]\n                  .reduce(input) { |a, e| a.fetch(e) }\n                  .at(index)[tuple_path.last]\n              else\n                tuple_path.reduce(input) { |a, e| a.fetch(e) }\n              end\n            rescue KeyError => e\n              raise KeyMissing, e.message\n            end\n\n          if excluded_keys\n            value.is_a?(Array) ? value.map(&exclude_proc) : exclude_proc[value]\n          else\n            value\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(input, index = nil)", "start_line": 72, "end_line": 91}, "metadata": {"module": "ROM", "class_name": "Graph", "class_signature": "class Graph"}, "task_id": 482}
{"function_name": "build_timestamps", "file_path": "rom/core/lib/rom/plugins/command/timestamps.rb", "focal_code": "def build_timestamps\n            time        = Time.now.utc\n            date        = Date.today\n            timestamps  = {}\n\n            timestamp_columns.each do |column|\n              timestamps[column.to_sym] = time\n            end\n\n            datestamp_columns.each do |column|\n              timestamps[column.to_sym] = date\n            end\n\n            timestamps\n          end", "file_content": "# frozen_string_literal: true\n\nrequire 'set'\n\nmodule ROM\n  module Plugins\n    module Command\n      # A plugin for automatically adding timestamp values\n      # when executing a command\n      #\n      # Set up attributes to timestamp when the command is called\n      #\n      # @example\n      #   class CreateTask < ROM::Commands::Create[:sql]\n      #     result :one\n      #     use :timestamps, timestamps: %i(created_at, updated_at), datestamps: %i(:written)\n      #   end\n      #\n      #   create_user = rom.command(:user).create.curry(name: 'Jane')\n      #\n      #   result = create_user.call\n      #   result[:created_at]  #=> Time.now.utc\n      #\n      # @api public\n      class Timestamps < ::Module\n        attr_reader :timestamps\n\n        attr_reader :datestamps\n\n        def initialize(timestamps: [], datestamps: [])\n          super()\n          @timestamps = store_attributes(timestamps)\n          @datestamps = store_attributes(datestamps)\n        end\n\n        # @api private\n        def store_attributes(attr)\n          attr.is_a?(Array) ? attr : [attr]\n        end\n\n        # @api private\n        def included(klass)\n          initialize_timestamp_attributes(klass)\n          klass.include(InstanceMethods)\n          klass.extend(ClassInterface)\n          super\n        end\n\n        def initialize_timestamp_attributes(klass)\n          klass.defines :timestamp_columns, :datestamp_columns\n          klass.timestamp_columns Set.new\n          klass.datestamp_columns Set.new\n          klass.before :set_timestamps\n          klass.timestamp_columns klass.timestamp_columns.merge(timestamps) if timestamps.any?\n          klass.datestamp_columns klass.datestamp_columns.merge(datestamps) if datestamps.any?\n        end\n\n        module InstanceMethods\n          # @api private\n          def timestamp_columns\n            self.class.timestamp_columns\n          end\n\n          # @api private\n          def datestamp_columns\n            self.class.datestamp_columns\n          end\n\n          # Set the timestamp attributes on the given tuples\n          #\n          # @param [Array<Hash>, Hash] tuples the input tuple(s)\n          #\n          # @return [Array<Hash>, Hash]\n          #\n          # @api private\n          def set_timestamps(tuples, *)\n            timestamps = build_timestamps\n\n            map_input_tuples(tuples) { |t| timestamps.merge(t) }\n          end\n\n          private\n\n          # @api private\n          def build_timestamps\n            time        = Time.now.utc\n            date        = Date.today\n            timestamps  = {}\n\n            timestamp_columns.each do |column|\n              timestamps[column.to_sym] = time\n            end\n\n            datestamp_columns.each do |column|\n              timestamps[column.to_sym] = date\n            end\n\n            timestamps\n          end\n        end\n\n        module ClassInterface\n          # @api private\n          # Set up attributes to timestamp when the command is called\n          #\n          # @example\n          #   class CreateTask < ROM::Commands::Create[:sql]\n          #     result :one\n          #     use :timestamps\n          #     timestamps :created_at, :updated_at\n          #   end\n          #\n          #   create_user = rom.command(:user).create.curry(name: 'Jane')\n          #\n          #   result = create_user.call\n          #   result[:created_at]  #=> Time.now.utc\n          #\n          # @param [Array<Symbol>] names A list of attribute names\n          #\n          # @api public\n          def timestamps(*names)\n            timestamp_columns timestamp_columns.merge(names)\n          end\n          alias_method :timestamp, :timestamps\n\n          # Set up attributes to datestamp when the command is called\n          #\n          # @example\n          #   class CreateTask < ROM::Commands::Create[:sql]\n          #     result :one\n          #     use :timestamps\n          #     datestamps :created_on, :updated_on\n          #   end\n          #\n          #   create_user = rom.command(:user).create.curry(name: 'Jane')\n          #\n          #   result = create_user.call\n          #   result[:created_at]  #=> Date.today\n          #\n          # @param [Array<Symbol>] names A list of attribute names\n          #\n          # @api public\n          def datestamps(*names)\n            datestamp_columns datestamp_columns.merge(names)\n          end\n          alias_method :datestamp, :datestamps\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_timestamps", "signature": "def build_timestamps time        = Time.now.utc", "start_line": 85, "end_line": 99}, "metadata": {"module": "ROM", "class_name": "Timestamps", "class_signature": "class Timestamps < < ::Module"}, "task_id": 483}
{"function_name": "build", "file_path": "rom/core/lib/rom/plugins/command/schema.rb", "focal_code": "def build(relation, **options)\n            if relation.schema? && !options.key?(:input)\n              relation_input = relation.input_schema\n              command_input = input\n\n              composed_input =\n                if command_input.equal?(ROM::Command.input)\n                  relation_input\n                else\n                  -> tuple { relation_input[command_input[tuple]] }\n                end\n\n              super(relation, **options, input: composed_input)\n            else\n              super\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  module Plugins\n    module Command\n      # Command plugin which sets input processing function via relation schema\n      #\n      # @api private\n      module Schema\n        def self.included(klass)\n          super\n          klass.extend(ClassInterface)\n        end\n\n        # @api private\n        module ClassInterface\n          # Build a command and set it input to relation's input_schema\n          #\n          # @see Command.build\n          #\n          # @return [Command]\n          #\n          # @api public\n          def build(relation, **options)\n            if relation.schema? && !options.key?(:input)\n              relation_input = relation.input_schema\n              command_input = input\n\n              composed_input =\n                if command_input.equal?(ROM::Command.input)\n                  relation_input\n                else\n                  -> tuple { relation_input[command_input[tuple]] }\n                end\n\n              super(relation, **options, input: composed_input)\n            else\n              super\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build", "signature": "def build(relation, **options)", "start_line": 24, "end_line": 40}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 484}
{"function_name": "compose", "file_path": "rom/changeset/lib/rom/changeset/pipe.rb", "focal_code": "def compose(other, for_diff: other.is_a?(self.class) ? other.use_for_diff : false)\n        new_proc = processor >> other\n\n        if for_diff\n          diff_proc = diff_processor >> (\n            other.is_a?(self.class) ? other.diff_processor : other\n          )\n\n          new(new_proc, use_for_diff: true, diff_processor: diff_proc)\n        else\n          new(new_proc)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'transproc/transformer'\n\nrequire 'rom/changeset/pipe_registry'\n\nmodule ROM\n  class Changeset\n    # Composable data transformation pipe used by default in changesets\n    #\n    # @api private\n    class Pipe < Transproc::Transformer[PipeRegistry]\n      extend Initializer\n\n      define!(&:identity)\n\n      param :processor, optional: true\n\n      option :use_for_diff, optional: true, default: -> { true }\n      option :diff_processor, default: -> { self[processor] }\n\n      def self.new(*args, **opts)\n        if args.empty?\n          initialize(**opts)\n        else\n          super\n        end\n      end\n\n      def self.initialize(**opts)\n        transformer = allocate\n        transformer.__send__(:initialize, dsl.(transformer), **opts)\n        transformer\n      end\n\n      def self.[](name_or_proc)\n        container[name_or_proc]\n      end\n\n      def [](*args)\n        self.class[*args]\n      end\n\n      def bind(context)\n        if processor.is_a?(Proc)\n          bound_processor = self[-> *args { context.instance_exec(*args, &processor) }]\n          bound_diff_processor = self[-> *args { context.instance_exec(*args, &diff_processor) }]\n\n          new(bound_processor, diff_processor: bound_diff_processor)\n        else\n          self\n        end\n      end\n\n      def compose(other, for_diff: other.is_a?(self.class) ? other.use_for_diff : false)\n        new_proc = processor >> other\n\n        if for_diff\n          diff_proc = diff_processor >> (\n            other.is_a?(self.class) ? other.diff_processor : other\n          )\n\n          new(new_proc, use_for_diff: true, diff_processor: diff_proc)\n        else\n          new(new_proc)\n        end\n      end\n      alias_method :>>, :compose\n\n      def call(data)\n        processor.call(data)\n      end\n\n      def for_diff(data)\n        use_for_diff ? diff_processor.call(data) : data\n      end\n\n      def new(processor, **opts)\n        self.class.new(processor, **options, **opts)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "compose", "signature": "def compose(other, for_diff: other.is_a?(self.class) ? other.use_for_diff : false)", "start_line": 55, "end_line": 67}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 485}
{"function_name": "extend", "file_path": "rom/changeset/lib/rom/changeset/stateful.rb", "focal_code": "def extend(*steps, **options, &)\n        if block_given?\n          if steps.empty?\n            with(pipe: pipe.compose(Pipe.new(proc(&)).bind(self), **options))\n          else\n            extend(*steps, **options).extend(**options, &)\n          end\n        else\n          with(pipe: steps.reduce(pipe.with(**options)) { |a, e| a.compose(pipe[e], **options) })\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/changeset/pipe'\n\nmodule ROM\n  class Changeset\n    # Stateful changesets carry data and can transform it into\n    # a different structure compatible with a persistence backend\n    #\n    # @abstract\n    class Stateful < Changeset\n      # Default no-op pipe\n      EMPTY_PIPE = Pipe.new(use_for_diff: false).freeze\n\n      # @!attribute [r] __data__\n      #   @return [Hash] The relation data\n      #   @api private\n      option :__data__, optional: true\n\n      # @!attribute [r] pipe\n      #   @return [Changeset::Pipe] data transformation pipe\n      #   @api private\n      option :pipe, reader: false, optional: true\n\n      # Define a changeset mapping\n      #\n      # Subsequent mapping definitions will be composed together\n      # and applied in the order they way defined\n      #\n      # @example Transformation DSL\n      #   class NewUser < ROM::Changeset::Create\n      #     map do\n      #       unwrap :address, prefix: true\n      #     end\n      #   end\n      #\n      # @example Using custom block\n      #   class NewUser < ROM::Changeset::Create\n      #     map do |tuple|\n      #       tuple.merge(created_at: Time.now)\n      #     end\n      #   end\n      #\n      # @example Multiple mappings (executed in the order of definition)\n      #   class NewUser < ROM::Changeset::Create\n      #     map do\n      #       unwrap :address, prefix: true\n      #     end\n      #\n      #     map do |tuple|\n      #       tuple.merge(created_at: Time.now)\n      #     end\n      #   end\n      #\n      # @return [Array<Pipe>, Transproc::Function>]\n      #\n      # @see https://github.com/solnic/transproc Transproc\n      #\n      # @api public\n      def self.map(**options, &block)\n        if block.parameters.empty?\n          pipes << Class.new(Pipe).define!(&block).new(**options)\n        else\n          pipes << Pipe.new(block, **options)\n        end\n      end\n\n      # Define a changeset mapping excluded from diffs\n      #\n      # @see Changeset::Stateful.map\n      # @see Changeset::Stateful#extend\n      #\n      # @return [Array<Pipe>, Transproc::Function>]\n      #\n      # @api public\n      def self.extend(*, &)\n        if block_given?\n          map(use_for_diff: false, &)\n        else\n          super\n        end\n      end\n\n      # Build default pipe object\n      #\n      # This can be overridden in a custom changeset subclass\n      #\n      # @return [Pipe]\n      def self.default_pipe(context)\n        pipes.empty? ? EMPTY_PIPE : pipes.map { |p| p.bind(context) }.reduce(:>>)\n      end\n\n      # @api private\n      def self.inherited(klass)\n        return if klass == ROM::Changeset\n\n        super\n        klass.instance_variable_set(:@__pipes__, pipes.dup)\n      end\n\n      # @api private\n      def self.pipes\n        @__pipes__\n      end\n      @__pipes__ = EMPTY_ARRAY\n\n      # Pipe changeset's data using custom steps define on the pipe\n      #\n      # @overload map(*steps)\n      #   Apply mapping using built-in transformations\n      #\n      #   @example\n      #     changeset.map(:add_timestamps)\n      #\n      #   @param [Array<Symbol>] steps A list of mapping steps\n      #\n      # @overload map(&block)\n      #   Apply mapping using a custom block\n      #\n      #   @example\n      #     changeset.map { |tuple| tuple.merge(created_at: Time.now) }\n      #\n      # @overload map(*steps, &block)\n      #   Apply mapping using built-in transformations and a custom block\n      #\n      #   @example\n      #     changeset.map(:add_timestamps) { |tuple| tuple.merge(status: 'published') }\n      #\n      #   @param [Array<Symbol>] steps A list of mapping steps\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def map(*steps, &)\n        extend(*steps, for_diff: true, &)\n      end\n\n      # Pipe changeset's data using custom steps define on the pipe.\n      # You should use #map instead except updating timestamp fields.\n      # Calling changeset.extend builds a pipe that excludes certain\n      # steps for generating the diff. Currently the only place where\n      # it is used is update changesets with the `:touch` step, i.e.\n      # `changeset.extend(:touch).diff` will exclude `:updated_at`\n      # from the diff.\n      #\n      # @see Changeset::Stateful#map\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def extend(*steps, **options, &)\n        if block_given?\n          if steps.empty?\n            with(pipe: pipe.compose(Pipe.new(proc(&)).bind(self), **options))\n          else\n            extend(*steps, **options).extend(**options, &)\n          end\n        else\n          with(pipe: steps.reduce(pipe.with(**options)) { |a, e| a.compose(pipe[e], **options) })\n        end\n      end\n\n      # Return changeset with data\n      #\n      # @param [Hash] data\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def data(data)\n        with(__data__: data)\n      end\n\n      # Coerce changeset to a hash\n      #\n      # This will send the data through the pipe\n      #\n      # @return [Hash]\n      #\n      # @api public\n      def to_h\n        pipe.call(__data__)\n      end\n      alias_method :to_hash, :to_h\n\n      # Coerce changeset to an array\n      #\n      # This will send the data through the pipe\n      #\n      # @return [Array]\n      #\n      # @api public\n      def to_a\n        result == :one ? [to_h] : __data__.map { |element| pipe.call(element) }\n      end\n      alias_method :to_ary, :to_a\n\n      # Commit stateful changeset\n      #\n      # @see Changeset#commit\n      #\n      # @api public\n      def commit\n        command.call(self)\n      end\n\n      # Associate a changeset with another changeset or hash-like object\n      #\n      # @example with another changeset\n      #   new_user = users.changeset(name: 'Jane')\n      #   new_task = users.changeset(:tasks, title: 'A task')\n      #\n      #   new_task.associate(new_user, :users)\n      #\n      # @example with a hash-like object\n      #   user = users.users.by_pk(1).one\n      #   new_task = users.changeset(:tasks, title: 'A task')\n      #\n      #   new_task.associate(user, :users)\n      #\n      # @param [#to_hash, Changeset] other Other changeset or hash-like object\n      # @param [Symbol] name The association identifier from schema\n      #\n      # @api public\n      def associate(other, name = Associated.infer_assoc_name(other))\n        Associated.new(self, associations: { name => other })\n      end\n\n      # Return command result type\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      def result\n        __data__.is_a?(Array) ? :many : :one\n      end\n\n      # Return string representation of the changeset\n      #\n      # @return [String]\n      #\n      # @api public\n      def inspect\n        %(#<#{self.class} relation=#{relation.name.inspect} data=#{__data__}>)\n      end\n\n      # @api private\n      def command_compiler_options\n        super.merge(result: result)\n      end\n\n      # Data transformation pipe\n      #\n      # @return [Changeset::Pipe]\n      #\n      # @api private\n      def pipe\n        @pipe ||= self.class.default_pipe(self)\n      end\n\n      private\n\n      # @api private\n      def respond_to_missing?(meth, include_private = false)\n        super || __data__.respond_to?(meth)\n      end\n\n      # @api private\n      def method_missing(meth, ...)\n        if __data__.respond_to?(meth)\n          response = __data__.__send__(meth, ...)\n\n          if response.is_a?(__data__.class)\n            with(__data__: response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "extend", "signature": "def extend(*steps, **options, &)", "start_line": 151, "end_line": 161}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 486}
{"function_name": "method_missing", "file_path": "rom/changeset/lib/rom/changeset/stateful.rb", "focal_code": "def method_missing(meth, ...)\n        if __data__.respond_to?(meth)\n          response = __data__.__send__(meth, ...)\n\n          if response.is_a?(__data__.class)\n            with(__data__: response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/changeset/pipe'\n\nmodule ROM\n  class Changeset\n    # Stateful changesets carry data and can transform it into\n    # a different structure compatible with a persistence backend\n    #\n    # @abstract\n    class Stateful < Changeset\n      # Default no-op pipe\n      EMPTY_PIPE = Pipe.new(use_for_diff: false).freeze\n\n      # @!attribute [r] __data__\n      #   @return [Hash] The relation data\n      #   @api private\n      option :__data__, optional: true\n\n      # @!attribute [r] pipe\n      #   @return [Changeset::Pipe] data transformation pipe\n      #   @api private\n      option :pipe, reader: false, optional: true\n\n      # Define a changeset mapping\n      #\n      # Subsequent mapping definitions will be composed together\n      # and applied in the order they way defined\n      #\n      # @example Transformation DSL\n      #   class NewUser < ROM::Changeset::Create\n      #     map do\n      #       unwrap :address, prefix: true\n      #     end\n      #   end\n      #\n      # @example Using custom block\n      #   class NewUser < ROM::Changeset::Create\n      #     map do |tuple|\n      #       tuple.merge(created_at: Time.now)\n      #     end\n      #   end\n      #\n      # @example Multiple mappings (executed in the order of definition)\n      #   class NewUser < ROM::Changeset::Create\n      #     map do\n      #       unwrap :address, prefix: true\n      #     end\n      #\n      #     map do |tuple|\n      #       tuple.merge(created_at: Time.now)\n      #     end\n      #   end\n      #\n      # @return [Array<Pipe>, Transproc::Function>]\n      #\n      # @see https://github.com/solnic/transproc Transproc\n      #\n      # @api public\n      def self.map(**options, &block)\n        if block.parameters.empty?\n          pipes << Class.new(Pipe).define!(&block).new(**options)\n        else\n          pipes << Pipe.new(block, **options)\n        end\n      end\n\n      # Define a changeset mapping excluded from diffs\n      #\n      # @see Changeset::Stateful.map\n      # @see Changeset::Stateful#extend\n      #\n      # @return [Array<Pipe>, Transproc::Function>]\n      #\n      # @api public\n      def self.extend(*, &)\n        if block_given?\n          map(use_for_diff: false, &)\n        else\n          super\n        end\n      end\n\n      # Build default pipe object\n      #\n      # This can be overridden in a custom changeset subclass\n      #\n      # @return [Pipe]\n      def self.default_pipe(context)\n        pipes.empty? ? EMPTY_PIPE : pipes.map { |p| p.bind(context) }.reduce(:>>)\n      end\n\n      # @api private\n      def self.inherited(klass)\n        return if klass == ROM::Changeset\n\n        super\n        klass.instance_variable_set(:@__pipes__, pipes.dup)\n      end\n\n      # @api private\n      def self.pipes\n        @__pipes__\n      end\n      @__pipes__ = EMPTY_ARRAY\n\n      # Pipe changeset's data using custom steps define on the pipe\n      #\n      # @overload map(*steps)\n      #   Apply mapping using built-in transformations\n      #\n      #   @example\n      #     changeset.map(:add_timestamps)\n      #\n      #   @param [Array<Symbol>] steps A list of mapping steps\n      #\n      # @overload map(&block)\n      #   Apply mapping using a custom block\n      #\n      #   @example\n      #     changeset.map { |tuple| tuple.merge(created_at: Time.now) }\n      #\n      # @overload map(*steps, &block)\n      #   Apply mapping using built-in transformations and a custom block\n      #\n      #   @example\n      #     changeset.map(:add_timestamps) { |tuple| tuple.merge(status: 'published') }\n      #\n      #   @param [Array<Symbol>] steps A list of mapping steps\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def map(*steps, &)\n        extend(*steps, for_diff: true, &)\n      end\n\n      # Pipe changeset's data using custom steps define on the pipe.\n      # You should use #map instead except updating timestamp fields.\n      # Calling changeset.extend builds a pipe that excludes certain\n      # steps for generating the diff. Currently the only place where\n      # it is used is update changesets with the `:touch` step, i.e.\n      # `changeset.extend(:touch).diff` will exclude `:updated_at`\n      # from the diff.\n      #\n      # @see Changeset::Stateful#map\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def extend(*steps, **options, &)\n        if block_given?\n          if steps.empty?\n            with(pipe: pipe.compose(Pipe.new(proc(&)).bind(self), **options))\n          else\n            extend(*steps, **options).extend(**options, &)\n          end\n        else\n          with(pipe: steps.reduce(pipe.with(**options)) { |a, e| a.compose(pipe[e], **options) })\n        end\n      end\n\n      # Return changeset with data\n      #\n      # @param [Hash] data\n      #\n      # @return [Changeset]\n      #\n      # @api public\n      def data(data)\n        with(__data__: data)\n      end\n\n      # Coerce changeset to a hash\n      #\n      # This will send the data through the pipe\n      #\n      # @return [Hash]\n      #\n      # @api public\n      def to_h\n        pipe.call(__data__)\n      end\n      alias_method :to_hash, :to_h\n\n      # Coerce changeset to an array\n      #\n      # This will send the data through the pipe\n      #\n      # @return [Array]\n      #\n      # @api public\n      def to_a\n        result == :one ? [to_h] : __data__.map { |element| pipe.call(element) }\n      end\n      alias_method :to_ary, :to_a\n\n      # Commit stateful changeset\n      #\n      # @see Changeset#commit\n      #\n      # @api public\n      def commit\n        command.call(self)\n      end\n\n      # Associate a changeset with another changeset or hash-like object\n      #\n      # @example with another changeset\n      #   new_user = users.changeset(name: 'Jane')\n      #   new_task = users.changeset(:tasks, title: 'A task')\n      #\n      #   new_task.associate(new_user, :users)\n      #\n      # @example with a hash-like object\n      #   user = users.users.by_pk(1).one\n      #   new_task = users.changeset(:tasks, title: 'A task')\n      #\n      #   new_task.associate(user, :users)\n      #\n      # @param [#to_hash, Changeset] other Other changeset or hash-like object\n      # @param [Symbol] name The association identifier from schema\n      #\n      # @api public\n      def associate(other, name = Associated.infer_assoc_name(other))\n        Associated.new(self, associations: { name => other })\n      end\n\n      # Return command result type\n      #\n      # @return [Symbol]\n      #\n      # @api private\n      def result\n        __data__.is_a?(Array) ? :many : :one\n      end\n\n      # Return string representation of the changeset\n      #\n      # @return [String]\n      #\n      # @api public\n      def inspect\n        %(#<#{self.class} relation=#{relation.name.inspect} data=#{__data__}>)\n      end\n\n      # @api private\n      def command_compiler_options\n        super.merge(result: result)\n      end\n\n      # Data transformation pipe\n      #\n      # @return [Changeset::Pipe]\n      #\n      # @api private\n      def pipe\n        @pipe ||= self.class.default_pipe(self)\n      end\n\n      private\n\n      # @api private\n      def respond_to_missing?(meth, include_private = false)\n        super || __data__.respond_to?(meth)\n      end\n\n      # @api private\n      def method_missing(meth, ...)\n        if __data__.respond_to?(meth)\n          response = __data__.__send__(meth, ...)\n\n          if response.is_a?(__data__.class)\n            with(__data__: response)\n          else\n            response\n          end\n        else\n          super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(meth, ...)", "start_line": 269, "end_line": 281}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 487}
{"function_name": "diff", "file_path": "rom/changeset/lib/rom/changeset/update.rb", "focal_code": "def diff\n        @diff ||=\n          begin\n            source = Hash(original)\n            data = pipe.for_diff(__data__)\n            data_tuple = data.to_a\n            data_keys = data.keys & source.keys\n\n            new_tuple = data_tuple.to_a.select { |k, _| data_keys.include?(k) }\n            ori_tuple = source.to_a.select { |k, _| data_keys.include?(k) }\n\n            (new_tuple - (new_tuple & ori_tuple)).to_h\n          end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  class Changeset\n    # Changeset specialization for update commands\n    #\n    # Update changesets will only execute their commands when\n    # the data is different from the original tuple. Original tuple\n    # is fetched from changeset's relation using `one` method.\n    #\n    # @example\n    #   users.by_pk(1).changeset(:update, name: \"Jane Doe\").commit\n    #\n    # @see Changeset::Stateful\n    #\n    # @api public\n    class Update < Stateful\n      command_type :update\n\n      # Commit update changeset if there's a diff\n      #\n      # This returns original tuple if there's no diff\n      #\n      # @return [Hash]\n      #\n      # @see Changeset#commit\n      #\n      # @api public\n      def commit\n        diff? ? super : original\n      end\n\n      # Return original tuple that this changeset may update\n      #\n      # @return [Hash]\n      #\n      # @api public\n      def original\n        @original ||= relation.one\n      end\n\n      # Return true if there's a diff between original and changeset data\n      #\n      # @return [TrueClass, FalseClass]\n      #\n      # @api public\n      def diff?\n        !diff.empty?\n      end\n\n      # Return if there's no diff between the original and changeset data\n      #\n      # @return [TrueClass, FalseClass]\n      #\n      # @api public\n      def clean?\n        diff.empty?\n      end\n\n      # Calculate the diff between the original and changeset data\n      #\n      # @return [Hash]\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/AbcSize\n      def diff\n        @diff ||=\n          begin\n            source = Hash(original)\n            data = pipe.for_diff(__data__)\n            data_tuple = data.to_a\n            data_keys = data.keys & source.keys\n\n            new_tuple = data_tuple.to_a.select { |k, _| data_keys.include?(k) }\n            ori_tuple = source.to_a.select { |k, _| data_keys.include?(k) }\n\n            (new_tuple - (new_tuple & ori_tuple)).to_h\n          end\n      end\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "diff", "signature": "def diff @diff ||=", "start_line": 67, "end_line": 80}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 488}
{"function_name": "infer_assoc_name", "file_path": "rom/changeset/lib/rom/changeset/associated.rb", "focal_code": "def self.infer_assoc_name(other)\n        schema = other.class.schema\n        attrs = schema.is_a?(Hash) ? schema.values : schema\n        pk = attrs.detect { |attr| attr.meta[:primary_key] }\n\n        if pk\n          pk.meta[:source]\n        else\n          raise ArgumentError, \"can't infer association name for #{other}\"\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/initializer'\n\nmodule ROM\n  class Changeset\n    # Associated changesets automatically set up FKs\n    #\n    # @api public\n    class Associated\n      extend Initializer\n\n      # @!attribute [r] left\n      #   @return [Changeset::Create] Child changeset\n      param :left\n\n      # @!attribute [r] associations\n      #   @return [Array] List of association identifiers from relation schema\n      option :associations\n\n      # Infer association name from an object with a schema\n      #\n      # This expects other to be an object with a schema that includes a primary key\n      # attribute with :source meta information. This makes it work with both structs\n      # and relations\n      #\n      # @see Stateful#associate\n      #\n      # @api private\n      def self.infer_assoc_name(other)\n        schema = other.class.schema\n        attrs = schema.is_a?(Hash) ? schema.values : schema\n        pk = attrs.detect { |attr| attr.meta[:primary_key] }\n\n        if pk\n          pk.meta[:source]\n        else\n          raise ArgumentError, \"can't infer association name for #{other}\"\n        end\n      end\n\n      # Commit changeset's composite command\n      #\n      # @example\n      #   task_changeset = tasks.\n      #     changeset(title: 'Task One').\n      #     associate(user, :user).\n      #     commit\n      #   # {:id => 1, :user_id => 1, title: 'Task One'}\n      #\n      # @return [Array<Hash>, Hash]\n      #\n      # @api public\n      def commit\n        command.call\n      end\n\n      # Associate with other changesets\n      #\n      # @see Changeset#associate\n      #\n      # @return [Associated]\n      #\n      # @api public\n      def associate(other, name = Associated.infer_assoc_name(other))\n        self.class.new(left, associations: associations.merge(name => other))\n      end\n\n      # Create a composed command\n      #\n      # @example using existing parent data\n      #   user_changeset = users.changeset(name: 'Jane')\n      #   task_changeset = tasks.changeset(title: 'Task One')\n      #\n      #   user = users.create(user_changeset)\n      #   task = tasks.create(task_changeset.associate(user, :user))\n      #\n      # @example saving both parent and child in one go\n      #   user_changeset = users.changeset(name: 'Jane')\n      #   task_changeset = tasks.changeset(title: 'Task One')\n      #\n      #   task = tasks.create(task_changeset.associate(user, :user))\n      #\n      # This works *only* with parent => child(ren) changeset hierarchy\n      #\n      # @return [ROM::Command::Composite]\n      #\n      # @api public\n      def command\n        associations.reduce(left.command.curry(left)) do |a, (assoc, other)|\n          case other\n          when Changeset\n            a >> other.command.with_association(assoc).curry(other)\n          when Associated\n            a >> other.command.with_association(assoc)\n          when Array\n            raise NotImplementedError, 'Changeset::Associate does not support arrays yet'\n          else\n            a.with_association(assoc, parent: other)\n          end\n        end\n      end\n\n      # @api private\n      def relation\n        left.relation\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "infer_assoc_name", "signature": "def self.infer_assoc_name(other)", "start_line": 30, "end_line": 40}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 489}
{"function_name": "command", "file_path": "rom/changeset/lib/rom/changeset/associated.rb", "focal_code": "def command\n        associations.reduce(left.command.curry(left)) do |a, (assoc, other)|\n          case other\n          when Changeset\n            a >> other.command.with_association(assoc).curry(other)\n          when Associated\n            a >> other.command.with_association(assoc)\n          when Array\n            raise NotImplementedError, 'Changeset::Associate does not support arrays yet'\n          else\n            a.with_association(assoc, parent: other)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/initializer'\n\nmodule ROM\n  class Changeset\n    # Associated changesets automatically set up FKs\n    #\n    # @api public\n    class Associated\n      extend Initializer\n\n      # @!attribute [r] left\n      #   @return [Changeset::Create] Child changeset\n      param :left\n\n      # @!attribute [r] associations\n      #   @return [Array] List of association identifiers from relation schema\n      option :associations\n\n      # Infer association name from an object with a schema\n      #\n      # This expects other to be an object with a schema that includes a primary key\n      # attribute with :source meta information. This makes it work with both structs\n      # and relations\n      #\n      # @see Stateful#associate\n      #\n      # @api private\n      def self.infer_assoc_name(other)\n        schema = other.class.schema\n        attrs = schema.is_a?(Hash) ? schema.values : schema\n        pk = attrs.detect { |attr| attr.meta[:primary_key] }\n\n        if pk\n          pk.meta[:source]\n        else\n          raise ArgumentError, \"can't infer association name for #{other}\"\n        end\n      end\n\n      # Commit changeset's composite command\n      #\n      # @example\n      #   task_changeset = tasks.\n      #     changeset(title: 'Task One').\n      #     associate(user, :user).\n      #     commit\n      #   # {:id => 1, :user_id => 1, title: 'Task One'}\n      #\n      # @return [Array<Hash>, Hash]\n      #\n      # @api public\n      def commit\n        command.call\n      end\n\n      # Associate with other changesets\n      #\n      # @see Changeset#associate\n      #\n      # @return [Associated]\n      #\n      # @api public\n      def associate(other, name = Associated.infer_assoc_name(other))\n        self.class.new(left, associations: associations.merge(name => other))\n      end\n\n      # Create a composed command\n      #\n      # @example using existing parent data\n      #   user_changeset = users.changeset(name: 'Jane')\n      #   task_changeset = tasks.changeset(title: 'Task One')\n      #\n      #   user = users.create(user_changeset)\n      #   task = tasks.create(task_changeset.associate(user, :user))\n      #\n      # @example saving both parent and child in one go\n      #   user_changeset = users.changeset(name: 'Jane')\n      #   task_changeset = tasks.changeset(title: 'Task One')\n      #\n      #   task = tasks.create(task_changeset.associate(user, :user))\n      #\n      # This works *only* with parent => child(ren) changeset hierarchy\n      #\n      # @return [ROM::Command::Composite]\n      #\n      # @api public\n      def command\n        associations.reduce(left.command.curry(left)) do |a, (assoc, other)|\n          case other\n          when Changeset\n            a >> other.command.with_association(assoc).curry(other)\n          when Associated\n            a >> other.command.with_association(assoc)\n          when Array\n            raise NotImplementedError, 'Changeset::Associate does not support arrays yet'\n          else\n            a.with_association(assoc, parent: other)\n          end\n        end\n      end\n\n      # @api private\n      def relation\n        left.relation\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "command", "signature": "def command associations.reduce(left.command.curry(left)) do |a, (assoc, other)|", "start_line": 89, "end_line": 102}, "metadata": {"module": "ROM", "class_name": "Changeset", "class_signature": "class Changeset"}, "task_id": 490}
{"function_name": "changeset", "file_path": "rom/changeset/lib/rom/plugins/relation/changeset.rb", "focal_code": "def changeset(type, data = EMPTY_HASH)\n            klass = type.is_a?(Symbol) ? TYPES.fetch(type) : type\n\n            unless klass < ROM::Changeset\n              raise ArgumentError, \"+#{type.name}+ must be a Changeset descendant\"\n            end\n\n            if klass < ROM::Changeset::Stateful\n              klass.new(self, __data__: data)\n            else\n              klass.new(self)\n            end\n          rescue KeyError\n            raise ArgumentError,\n                  \"+#{type.inspect}+ is not a valid changeset type. \" \\\n                  \"Must be one of: #{TYPES.keys.inspect}\"\n          end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/support/notifications'\n\nrequire 'rom/changeset/create'\nrequire 'rom/changeset/update'\nrequire 'rom/changeset/delete'\n\nrequire 'rom/changeset/extensions/relation'\n\nmodule ROM\n  module Plugins\n    module Relation\n      # Relation plugin which adds `Relation#changeset` method\n      #\n      # @api public\n      module Changeset\n        TYPES = {\n          create: ROM::Changeset::Create,\n          update: ROM::Changeset::Update,\n          delete: ROM::Changeset::Delete\n        }.freeze\n\n        extend Notifications::Listener\n\n        subscribe('configuration.relations.class.ready') do |event|\n          event[:relation].include(InstanceMethods)\n        end\n\n        # Relation instance methods provided by the Changeset plugin\n        #\n        # @api public\n        module InstanceMethods\n          # Create a changeset for a relation\n          #\n          # @overload changeset(type, data)\n          #   Create a changeset of one of predefined types\n          #\n          #   @example creating a record\n          #     users.\n          #       changeset(:create, name: 'Jane').\n          #       commit\n          #     # => #<ROM::Struct::User id=1 name=\"Jane\">\n          #\n          #   @example updating a record\n          #     users.\n          #       by_pk(1).\n          #       changeset(:update, name: 'Jack').\n          #       commit\n          #     # => #<ROM::Struct::User id=1 name=\"Jane\">\n          #\n          #   @example providing data as a separate step\n          #     changeset = users.changeset(:create)\n          #     jack = changeset.data(name: 'Jack').commit\n          #     jane = changeset.data(name: 'Jane').commit\n          #\n          #   @example using a command graph\n          #     users.\n          #       changeset(\n          #         :create,\n          #         name: \"Jane\",\n          #         posts: [{ title: \"Something about aliens\" }]\n          #       )\n          #\n          #   @param [Symbol] type The changeset type\n          #   @param [Hash] data\n          #   @return [Changeset]\n          #\n          # @overload changeset(changeset_class, data)\n          #   @example using a custom changeset class\n          #     class NewUser < ROM::Changeset::Create\n          #       map do |tuple|\n          #         { **tuple, name: tuple.values_at(:first_name, :last_name).join(' ') }\n          #       end\n          #     end\n          #\n          #     users.changeset(NewUser, first_name: 'John', last_name: 'Doe').commit\n          #\n          #   @param [Class] changeset_class A custom changeset class\n          #   @return [Changeset]\n          #\n          # @api public\n          def changeset(type, data = EMPTY_HASH)\n            klass = type.is_a?(Symbol) ? TYPES.fetch(type) : type\n\n            unless klass < ROM::Changeset\n              raise ArgumentError, \"+#{type.name}+ must be a Changeset descendant\"\n            end\n\n            if klass < ROM::Changeset::Stateful\n              klass.new(self, __data__: data)\n            else\n              klass.new(self)\n            end\n          rescue KeyError\n            raise ArgumentError,\n                  \"+#{type.inspect}+ is not a valid changeset type. \" \\\n                  \"Must be one of: #{TYPES.keys.inspect}\"\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "changeset", "signature": "def changeset(type, data = EMPTY_HASH)", "start_line": 83, "end_line": 99}, "metadata": {"module": "ROM", "class_name": "", "class_signature": ""}, "task_id": 491}
{"function_name": "[]", "file_path": "rom/repository/lib/rom/repository/class_interface.rb", "focal_code": "def [](name)\n        fetch_or_store(name) do\n          base =\n            if self < Repository::Root # rubocop:disable Style/MinMaxComparison\n              self\n            else\n              Repository::Root\n            end\n\n          klass = ::Class.new(base)\n          klass.root(name)\n          klass\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/repository/relation_reader'\n\nmodule ROM\n  class Repository\n    # Class-level APIs for repositories\n    #\n    # @api public\n    module ClassInterface\n      # Create a root-repository class and set its root relation\n      #\n      # @example\n      #   # where :users is the relation name in your rom container\n      #   class UserRepo < ROM::Repository[:users]\n      #   end\n      #\n      # @param name [Symbol] The relation `register_as` value\n      #\n      # @return [Class] descendant of ROM::Repository::Root\n      #\n      # @api public\n      def [](name)\n        fetch_or_store(name) do\n          base =\n            if self < Repository::Root # rubocop:disable Style/MinMaxComparison\n              self\n            else\n              Repository::Root\n            end\n\n          klass = ::Class.new(base)\n          klass.root(name)\n          klass\n        end\n      end\n\n      # Initialize a new repository object, establishing configured relation proxies from\n      # the passed container\n      #\n      # @overload new(container, **options)\n      #   Initialize with container as leading parameter\n      #\n      #   @param [ROM::Container] container Finalized rom container\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @overload new(**options)\n      #   Inititalize with container as option\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [ROM::Container] :container Finalized rom container\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @api public\n      def new(container = nil, root: Undefined, **options)\n        container ||= options.fetch(:container)\n\n        unless relation_reader.added_to?(self)\n          include relation_reader.new(\n            relations: container.relations.elements.keys,\n            cache: container.cache,\n            root: root\n          )\n        end\n\n        super(**options, container: container)\n      end\n\n      # Inherits configured relations and commands\n      #\n      # @api private\n      def inherited(klass)\n        super\n\n        return if self === Repository # rubocop:disable Style/CaseEquality\n\n        klass.extend(::Dry::Core::Cache)\n        klass.commands(*commands)\n      end\n\n      # Defines command methods on a root repository\n      #\n      # @example\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, update: :by_pk, delete: :by_pk\n      #   end\n      #\n      #   # with custom command plugin\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, use: :my_command_plugin\n      #   end\n      #\n      #   # with custom mapper\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, mapper: :my_custom_mapper\n      #   end\n      #\n      # @param [Array<Symbol>] names A list of command names\n      # @option :mapper [Symbol] An optional mapper identifier\n      # @option :use [Symbol] An optional command plugin identifier\n      #\n      # @return [Array<Symbol>] A list of defined command names\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/MethodLength\n      def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)\n        if names.any? || opts.any?\n          @commands = names + opts.to_a\n\n          @commands.each do |spec|\n            type, *view = Array(spec).flatten\n\n            if view.empty?\n              define_command_method(\n                type,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            else\n              define_restricted_command_method(\n                type,\n                view,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            end\n          end\n        else\n          @commands ||= []\n        end\n      end\n      # rubocop:enable Metrics/MethodLength\n\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:repository].fetch(plugin).apply_to(self, **options)\n      end\n\n      private\n\n      # @api private\n      def define_command_method(type, **opts)\n        define_method(type) do |*input|\n          if input.size == 1 && input[0].respond_to?(:commit)\n            input[0].commit\n          else\n            root.command(type, **opts).call(*input)\n          end\n        end\n      end\n\n      # @api private\n      def define_restricted_command_method(type, views, **opts)\n        views.each do |view_name|\n          meth_name = views.size > 1 ? :\"#{type}_#{view_name}\" : type\n\n          define_method(meth_name) do |*args|\n            arity = root.__send__(view_name).arity\n\n            view_args = args[0..arity - 1]\n            input = args[arity..args.size - 1]\n\n            changeset = input.first\n\n            if changeset.respond_to?(:commit)\n              changeset.commit\n            else\n              root.command(type, **opts).public_send(view_name, *view_args).call(*input)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "[]", "signature": "def [](name)", "start_line": 23, "end_line": 36}, "metadata": {"module": "ROM", "class_name": "Repository", "class_signature": "class Repository"}, "task_id": 492}
{"function_name": "new", "file_path": "rom/repository/lib/rom/repository/class_interface.rb", "focal_code": "def new(container = nil, root: Undefined, **options)\n        container ||= options.fetch(:container)\n\n        unless relation_reader.added_to?(self)\n          include relation_reader.new(\n            relations: container.relations.elements.keys,\n            cache: container.cache,\n            root: root\n          )\n        end\n\n        super(**options, container: container)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/repository/relation_reader'\n\nmodule ROM\n  class Repository\n    # Class-level APIs for repositories\n    #\n    # @api public\n    module ClassInterface\n      # Create a root-repository class and set its root relation\n      #\n      # @example\n      #   # where :users is the relation name in your rom container\n      #   class UserRepo < ROM::Repository[:users]\n      #   end\n      #\n      # @param name [Symbol] The relation `register_as` value\n      #\n      # @return [Class] descendant of ROM::Repository::Root\n      #\n      # @api public\n      def [](name)\n        fetch_or_store(name) do\n          base =\n            if self < Repository::Root # rubocop:disable Style/MinMaxComparison\n              self\n            else\n              Repository::Root\n            end\n\n          klass = ::Class.new(base)\n          klass.root(name)\n          klass\n        end\n      end\n\n      # Initialize a new repository object, establishing configured relation proxies from\n      # the passed container\n      #\n      # @overload new(container, **options)\n      #   Initialize with container as leading parameter\n      #\n      #   @param [ROM::Container] container Finalized rom container\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @overload new(**options)\n      #   Inititalize with container as option\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [ROM::Container] :container Finalized rom container\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @api public\n      def new(container = nil, root: Undefined, **options)\n        container ||= options.fetch(:container)\n\n        unless relation_reader.added_to?(self)\n          include relation_reader.new(\n            relations: container.relations.elements.keys,\n            cache: container.cache,\n            root: root\n          )\n        end\n\n        super(**options, container: container)\n      end\n\n      # Inherits configured relations and commands\n      #\n      # @api private\n      def inherited(klass)\n        super\n\n        return if self === Repository # rubocop:disable Style/CaseEquality\n\n        klass.extend(::Dry::Core::Cache)\n        klass.commands(*commands)\n      end\n\n      # Defines command methods on a root repository\n      #\n      # @example\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, update: :by_pk, delete: :by_pk\n      #   end\n      #\n      #   # with custom command plugin\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, use: :my_command_plugin\n      #   end\n      #\n      #   # with custom mapper\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, mapper: :my_custom_mapper\n      #   end\n      #\n      # @param [Array<Symbol>] names A list of command names\n      # @option :mapper [Symbol] An optional mapper identifier\n      # @option :use [Symbol] An optional command plugin identifier\n      #\n      # @return [Array<Symbol>] A list of defined command names\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/MethodLength\n      def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)\n        if names.any? || opts.any?\n          @commands = names + opts.to_a\n\n          @commands.each do |spec|\n            type, *view = Array(spec).flatten\n\n            if view.empty?\n              define_command_method(\n                type,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            else\n              define_restricted_command_method(\n                type,\n                view,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            end\n          end\n        else\n          @commands ||= []\n        end\n      end\n      # rubocop:enable Metrics/MethodLength\n\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:repository].fetch(plugin).apply_to(self, **options)\n      end\n\n      private\n\n      # @api private\n      def define_command_method(type, **opts)\n        define_method(type) do |*input|\n          if input.size == 1 && input[0].respond_to?(:commit)\n            input[0].commit\n          else\n            root.command(type, **opts).call(*input)\n          end\n        end\n      end\n\n      # @api private\n      def define_restricted_command_method(type, views, **opts)\n        views.each do |view_name|\n          meth_name = views.size > 1 ? :\"#{type}_#{view_name}\" : type\n\n          define_method(meth_name) do |*args|\n            arity = root.__send__(view_name).arity\n\n            view_args = args[0..arity - 1]\n            input = args[arity..args.size - 1]\n\n            changeset = input.first\n\n            if changeset.respond_to?(:commit)\n              changeset.commit\n            else\n              root.command(type, **opts).public_send(view_name, *view_args).call(*input)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "new", "signature": "def new(container = nil, root: Undefined, **options)", "start_line": 59, "end_line": 71}, "metadata": {"module": "ROM", "class_name": "Repository", "class_signature": "class Repository"}, "task_id": 493}
{"function_name": "commands", "file_path": "rom/repository/lib/rom/repository/class_interface.rb", "focal_code": "def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)\n        if names.any? || opts.any?\n          @commands = names + opts.to_a\n\n          @commands.each do |spec|\n            type, *view = Array(spec).flatten\n\n            if view.empty?\n              define_command_method(\n                type,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            else\n              define_restricted_command_method(\n                type,\n                view,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            end\n          end\n        else\n          @commands ||= []\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/repository/relation_reader'\n\nmodule ROM\n  class Repository\n    # Class-level APIs for repositories\n    #\n    # @api public\n    module ClassInterface\n      # Create a root-repository class and set its root relation\n      #\n      # @example\n      #   # where :users is the relation name in your rom container\n      #   class UserRepo < ROM::Repository[:users]\n      #   end\n      #\n      # @param name [Symbol] The relation `register_as` value\n      #\n      # @return [Class] descendant of ROM::Repository::Root\n      #\n      # @api public\n      def [](name)\n        fetch_or_store(name) do\n          base =\n            if self < Repository::Root # rubocop:disable Style/MinMaxComparison\n              self\n            else\n              Repository::Root\n            end\n\n          klass = ::Class.new(base)\n          klass.root(name)\n          klass\n        end\n      end\n\n      # Initialize a new repository object, establishing configured relation proxies from\n      # the passed container\n      #\n      # @overload new(container, **options)\n      #   Initialize with container as leading parameter\n      #\n      #   @param [ROM::Container] container Finalized rom container\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @overload new(**options)\n      #   Inititalize with container as option\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [ROM::Container] :container Finalized rom container\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @api public\n      def new(container = nil, root: Undefined, **options)\n        container ||= options.fetch(:container)\n\n        unless relation_reader.added_to?(self)\n          include relation_reader.new(\n            relations: container.relations.elements.keys,\n            cache: container.cache,\n            root: root\n          )\n        end\n\n        super(**options, container: container)\n      end\n\n      # Inherits configured relations and commands\n      #\n      # @api private\n      def inherited(klass)\n        super\n\n        return if self === Repository # rubocop:disable Style/CaseEquality\n\n        klass.extend(::Dry::Core::Cache)\n        klass.commands(*commands)\n      end\n\n      # Defines command methods on a root repository\n      #\n      # @example\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, update: :by_pk, delete: :by_pk\n      #   end\n      #\n      #   # with custom command plugin\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, use: :my_command_plugin\n      #   end\n      #\n      #   # with custom mapper\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, mapper: :my_custom_mapper\n      #   end\n      #\n      # @param [Array<Symbol>] names A list of command names\n      # @option :mapper [Symbol] An optional mapper identifier\n      # @option :use [Symbol] An optional command plugin identifier\n      #\n      # @return [Array<Symbol>] A list of defined command names\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/MethodLength\n      def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)\n        if names.any? || opts.any?\n          @commands = names + opts.to_a\n\n          @commands.each do |spec|\n            type, *view = Array(spec).flatten\n\n            if view.empty?\n              define_command_method(\n                type,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            else\n              define_restricted_command_method(\n                type,\n                view,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            end\n          end\n        else\n          @commands ||= []\n        end\n      end\n      # rubocop:enable Metrics/MethodLength\n\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:repository].fetch(plugin).apply_to(self, **options)\n      end\n\n      private\n\n      # @api private\n      def define_command_method(type, **opts)\n        define_method(type) do |*input|\n          if input.size == 1 && input[0].respond_to?(:commit)\n            input[0].commit\n          else\n            root.command(type, **opts).call(*input)\n          end\n        end\n      end\n\n      # @api private\n      def define_restricted_command_method(type, views, **opts)\n        views.each do |view_name|\n          meth_name = views.size > 1 ? :\"#{type}_#{view_name}\" : type\n\n          define_method(meth_name) do |*args|\n            arity = root.__send__(view_name).arity\n\n            view_args = args[0..arity - 1]\n            input = args[arity..args.size - 1]\n\n            changeset = input.first\n\n            if changeset.respond_to?(:commit)\n              changeset.commit\n            else\n              root.command(type, **opts).public_send(view_name, *view_args).call(*input)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "commands", "signature": "def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)", "start_line": 111, "end_line": 138}, "metadata": {"module": "ROM", "class_name": "Repository", "class_signature": "class Repository"}, "task_id": 494}
{"function_name": "define_restricted_command_method", "file_path": "rom/repository/lib/rom/repository/class_interface.rb", "focal_code": "def define_restricted_command_method(type, views, **opts)\n        views.each do |view_name|\n          meth_name = views.size > 1 ? :\"#{type}_#{view_name}\" : type\n\n          define_method(meth_name) do |*args|\n            arity = root.__send__(view_name).arity\n\n            view_args = args[0..arity - 1]\n            input = args[arity..args.size - 1]\n\n            changeset = input.first\n\n            if changeset.respond_to?(:commit)\n              changeset.commit\n            else\n              root.command(type, **opts).public_send(view_name, *view_args).call(*input)\n            end\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire 'rom/repository/relation_reader'\n\nmodule ROM\n  class Repository\n    # Class-level APIs for repositories\n    #\n    # @api public\n    module ClassInterface\n      # Create a root-repository class and set its root relation\n      #\n      # @example\n      #   # where :users is the relation name in your rom container\n      #   class UserRepo < ROM::Repository[:users]\n      #   end\n      #\n      # @param name [Symbol] The relation `register_as` value\n      #\n      # @return [Class] descendant of ROM::Repository::Root\n      #\n      # @api public\n      def [](name)\n        fetch_or_store(name) do\n          base =\n            if self < Repository::Root # rubocop:disable Style/MinMaxComparison\n              self\n            else\n              Repository::Root\n            end\n\n          klass = ::Class.new(base)\n          klass.root(name)\n          klass\n        end\n      end\n\n      # Initialize a new repository object, establishing configured relation proxies from\n      # the passed container\n      #\n      # @overload new(container, **options)\n      #   Initialize with container as leading parameter\n      #\n      #   @param [ROM::Container] container Finalized rom container\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @overload new(**options)\n      #   Inititalize with container as option\n      #\n      #   @param [Hash] options Repository options\n      #   @option options [ROM::Container] :container Finalized rom container\n      #   @option options [Module] :struct_namespace Custom struct namespace\n      #   @option options [Boolean] :auto_struct Enable/Disable auto-struct mapping\n      #\n      # @api public\n      def new(container = nil, root: Undefined, **options)\n        container ||= options.fetch(:container)\n\n        unless relation_reader.added_to?(self)\n          include relation_reader.new(\n            relations: container.relations.elements.keys,\n            cache: container.cache,\n            root: root\n          )\n        end\n\n        super(**options, container: container)\n      end\n\n      # Inherits configured relations and commands\n      #\n      # @api private\n      def inherited(klass)\n        super\n\n        return if self === Repository # rubocop:disable Style/CaseEquality\n\n        klass.extend(::Dry::Core::Cache)\n        klass.commands(*commands)\n      end\n\n      # Defines command methods on a root repository\n      #\n      # @example\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, update: :by_pk, delete: :by_pk\n      #   end\n      #\n      #   # with custom command plugin\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, use: :my_command_plugin\n      #   end\n      #\n      #   # with custom mapper\n      #   class UserRepo < ROM::Repository[:users]\n      #     commands :create, mapper: :my_custom_mapper\n      #   end\n      #\n      # @param [Array<Symbol>] names A list of command names\n      # @option :mapper [Symbol] An optional mapper identifier\n      # @option :use [Symbol] An optional command plugin identifier\n      #\n      # @return [Array<Symbol>] A list of defined command names\n      #\n      # @api public\n      #\n      # rubocop:disable Metrics/MethodLength\n      def commands(*names, mapper: nil, use: nil, plugins_options: EMPTY_HASH, **opts)\n        if names.any? || opts.any?\n          @commands = names + opts.to_a\n\n          @commands.each do |spec|\n            type, *view = Array(spec).flatten\n\n            if view.empty?\n              define_command_method(\n                type,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            else\n              define_restricted_command_method(\n                type,\n                view,\n                mapper: mapper,\n                use: use,\n                plugins_options: plugins_options\n              )\n            end\n          end\n        else\n          @commands ||= []\n        end\n      end\n      # rubocop:enable Metrics/MethodLength\n\n      # @api public\n      def use(plugin, **options)\n        ROM.plugin_registry[:repository].fetch(plugin).apply_to(self, **options)\n      end\n\n      private\n\n      # @api private\n      def define_command_method(type, **opts)\n        define_method(type) do |*input|\n          if input.size == 1 && input[0].respond_to?(:commit)\n            input[0].commit\n          else\n            root.command(type, **opts).call(*input)\n          end\n        end\n      end\n\n      # @api private\n      def define_restricted_command_method(type, views, **opts)\n        views.each do |view_name|\n          meth_name = views.size > 1 ? :\"#{type}_#{view_name}\" : type\n\n          define_method(meth_name) do |*args|\n            arity = root.__send__(view_name).arity\n\n            view_args = args[0..arity - 1]\n            input = args[arity..args.size - 1]\n\n            changeset = input.first\n\n            if changeset.respond_to?(:commit)\n              changeset.commit\n            else\n              root.command(type, **opts).public_send(view_name, *view_args).call(*input)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_restricted_command_method", "signature": "def define_restricted_command_method(type, views, **opts)", "start_line": 160, "end_line": 179}, "metadata": {"module": "ROM", "class_name": "Repository", "class_signature": "class Repository"}, "task_id": 495}
{"function_name": "commit!", "file_path": "rom/repository/lib/rom/repository/session.rb", "focal_code": "def commit!\n      queue.each(&:commit)\n\n      @status = :success\n\n      self\n    rescue StandardError => e\n      @status = :failure\n      raise e\n    ensure\n      initialize_queue!\n    end", "file_content": "# frozen_string_literal: true\n\nmodule ROM\n  # TODO: finish this in 1.1.0\n  #\n  # @api private\n  class Session\n    include Dry::Equalizer(:queue, :status)\n\n    attr_reader :repo\n\n    attr_reader :queue\n\n    attr_reader :status\n\n    def initialize(repo)\n      @repo = repo\n      @status = :pending\n      initialize_queue!\n    end\n\n    def add(changeset)\n      queue << changeset\n      self\n    end\n\n    def commit!\n      queue.each(&:commit)\n\n      @status = :success\n\n      self\n    rescue StandardError => e\n      @status = :failure\n      raise e\n    ensure\n      initialize_queue!\n    end\n\n    def pending?\n      status.equal?(:pending)\n    end\n\n    def success?\n      status.equal?(:success)\n    end\n\n    def failure?\n      status.equal?(:failure)\n    end\n\n    private\n\n    def initialize_queue!\n      @queue = []\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "commit!", "signature": "def commit! queue.each(&:commit)", "start_line": 27, "end_line": 38}, "metadata": {"module": "ROM", "class_name": "Session", "class_signature": "class Session"}, "task_id": 496}
{"function_name": "initialize", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(new_settings, **options, &block)", "start_line": 42, "end_line": 66}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 497}
{"function_name": "mount_in", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "mount_in", "signature": "def mount_in(router)", "start_line": 89, "end_line": 106}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 498}
{"function_name": "run_validators", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run_validators", "signature": "def run_validators(request:)", "start_line": 187, "end_line": 208}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 499}
{"function_name": "to_routes", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "to_routes", "signature": "def to_routes route_options = options[:route_options]", "start_line": 238, "end_line": 259}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 500}
{"function_name": "prepare_default_route_attributes", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_default_route_attributes", "signature": "def prepare_default_route_attributes(route_options)", "start_line": 261, "end_line": 271}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 501}
{"function_name": "build_stack", "file_path": "grape/lib/grape/endpoint.rb", "focal_code": "def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # An Endpoint is the proxy scope in which all routing\n  # blocks are executed. In other words, any methods\n  # on the instance level of this class may be called\n  # from inside a `get`, `post`, etc.\n  class Endpoint\n    extend Forwardable\n    include Grape::DSL::Settings\n    include Grape::DSL::Headers\n    include Grape::DSL::InsideRoute\n\n    attr_reader :env, :request, :source, :options, :endpoints\n\n    def_delegators :request, :params, :headers, :cookies\n    def_delegator :cookies, :response_cookies\n\n    class << self\n      def block_to_unbound_method(block)\n        return unless block\n\n        define_method :temp_unbound_method, block\n        method = instance_method(:temp_unbound_method)\n        remove_method :temp_unbound_method\n        method\n      end\n    end\n\n    # Create a new endpoint.\n    # @param new_settings [InheritableSetting] settings to determine the params,\n    #   validations, and other properties from.\n    # @param options [Hash] attributes of this endpoint\n    # @option options path [String or Array] the path to this endpoint, within\n    #   the current scope.\n    # @option options method [String or Array] which HTTP method(s) can be used\n    #   to reach this endpoint.\n    # @option options route_options [Hash]\n    # @note This happens at the time of API definition, so in this context the\n    # endpoint does not know if it will be mounted under a different endpoint.\n    # @yield a block defining what your API should do when this endpoint is hit\n    def initialize(new_settings, **options, &block)\n      self.inheritable_setting = new_settings.point_in_time_copy\n\n      # now +namespace_stackable(:declared_params)+ contains all params defined for\n      # this endpoint and its parents, but later it will be cleaned up,\n      # see +reset_validations!+ in lib/grape/dsl/validations.rb\n      inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten\n      inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations].dup\n\n      inheritable_setting.namespace_stackable[:representations] ||= []\n      inheritable_setting.namespace_inheritable[:default_error_status] ||= 500\n\n      @options = options\n\n      @options[:path] = Array(@options[:path])\n      @options[:path] << '/' if @options[:path].empty?\n      @options[:method] = Array(@options[:method])\n\n      @status = nil\n      @stream = nil\n      @body = nil\n      @source = self.class.block_to_unbound_method(block)\n      @before_filter_passed = false\n      @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)\n    end\n\n    # Update our settings from a given set of stackable parameters. Used when\n    # the endpoint's API is mounted under another one.\n    def inherit_settings(namespace_stackable)\n      parent_validations = namespace_stackable[:validations]\n      inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?\n      parent_declared_params = namespace_stackable[:declared_params]\n      inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?\n\n      endpoints&.each { |e| e.inherit_settings(namespace_stackable) }\n    end\n\n    def routes\n      @routes ||= endpoints&.flat_map(&:routes) || to_routes\n    end\n\n    def reset_routes!\n      endpoints&.each(&:reset_routes!)\n      @namespace = nil\n      @routes = nil\n    end\n\n    def mount_in(router)\n      if endpoints\n        compile!\n        return endpoints.each { |e| e.mount_in(router) }\n      end\n\n      reset_routes!\n      compile!\n      routes.each do |route|\n        router.append(route.apply(self))\n        next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET\n\n        route.dup.then do |head_route|\n          head_route.convert_to_head_request!\n          router.append(head_route.apply(self))\n        end\n      end\n    end\n\n    def namespace\n      @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])\n    end\n\n    def call(env)\n      dup.call!(env)\n    end\n\n    def call!(env)\n      env[Grape::Env::API_ENDPOINT] = self\n      @env = env\n      # this adds the helpers only to the instance\n      singleton_class.include(@helpers) if @helpers\n      @app.call(env)\n    end\n\n    def ==(other)\n      other.is_a?(self.class) &&\n        options == other.options &&\n        inheritable_setting.to_hash == other.inheritable_setting.to_hash\n    end\n    alias eql? ==\n\n    # The purpose of this override is solely for stripping internals when an error occurs while calling\n    # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398\n    # Otherwise, it calls super.\n    def inspect\n      return super unless env\n\n      \"#{self.class} in '#{route.origin}' endpoint\"\n    end\n\n    protected\n\n    def run\n      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do\n        @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])\n        begin\n          run_filters befores, :before\n          @before_filter_passed = true\n\n          if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)\n            header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')\n            raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?\n\n            header 'Allow', header['Allow']\n            response_object = ''\n            status 204\n          else\n            run_filters before_validations, :before_validation\n            run_validators(request:)\n            run_filters after_validations, :after_validation\n            response_object = execute\n          end\n\n          run_filters afters, :after\n          build_response_cookies\n\n          # status verifies body presence when DELETE\n          @body ||= response_object\n\n          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object\n          response_object = stream || [body]\n\n          [status, header, response_object]\n        ensure\n          run_filters finallies, :finally\n        end\n      end\n    end\n\n    def execute\n      return unless source\n\n      ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do\n        source.bind_call(self)\n      end\n    end\n\n    def run_validators(request:)\n      validators = inheritable_setting.route[:saved_validations]\n      return if validators.empty?\n\n      validation_errors = []\n\n      Grape::Validations::ParamScopeTracker.track do\n        ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do\n          validators.each do |validator|\n            validator.validate(request)\n          rescue Grape::Exceptions::Validation => e\n            validation_errors << e\n            break if validator.fail_fast?\n          rescue Grape::Exceptions::ValidationArrayErrors => e\n            validation_errors.concat e.errors\n            break if validator.fail_fast?\n          end\n        end\n      end\n\n      raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?\n    end\n\n    def run_filters(filters, type = :other)\n      return if filters.blank?\n\n      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do\n        filters.each { |filter| instance_eval(&filter) }\n      end\n    end\n\n    %i[befores before_validations after_validations afters finallies].each do |method|\n      define_method method do\n        inheritable_setting.namespace_stackable[method]\n      end\n    end\n\n    def options?\n      options[:options_route_enabled] &&\n        env[Rack::REQUEST_METHOD] == Rack::OPTIONS\n    end\n\n    private\n\n    attr_reader :before_filter_passed\n\n    def compile!\n      @app = options[:app] || build_stack\n      @helpers = build_helpers\n    end\n\n    def to_routes\n      route_options = options[:route_options]\n      default_route_options = prepare_default_route_attributes(route_options)\n      complete_route_options = route_options.merge(default_route_options)\n      path_settings = prepare_default_path_settings\n\n      options[:method].flat_map do |method|\n        options[:path].map do |path|\n          prepared_path = Path.new(path, default_route_options[:namespace], path_settings)\n          pattern = Grape::Router::Pattern.new(\n            origin: prepared_path.origin,\n            suffix: prepared_path.suffix,\n            anchor: default_route_options[:anchor],\n            params: route_options[:params],\n            format: options[:format],\n            version: default_route_options[:version],\n            requirements: default_route_options[:requirements]\n          )\n          Grape::Router::Route.new(self, method, pattern, complete_route_options)\n        end\n      end\n    end\n\n    def prepare_default_route_attributes(route_options)\n      {\n        namespace:,\n        version: prepare_version(inheritable_setting.namespace_inheritable[:version]),\n        requirements: prepare_routes_requirements(route_options[:requirements]),\n        prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n        anchor: route_options.fetch(:anchor, true),\n        settings: inheritable_setting.route.except(:declared_params, :saved_validations),\n        forward_match: options[:forward_match]\n      }\n    end\n\n    def prepare_default_path_settings\n      namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash\n      namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash\n      namespace_stackable_hash.merge!(namespace_inheritable_hash)\n    end\n\n    def prepare_routes_requirements(route_options_requirements)\n      namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)\n      namespace_requirements << route_options_requirements if route_options_requirements.present?\n      namespace_requirements.reduce({}, :merge)\n    end\n\n    def prepare_version(namespace_inheritable_version)\n      return if namespace_inheritable_version.blank?\n\n      namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version\n    end\n\n    def build_stack\n      stack = Grape::Middleware::Stack.new\n\n      content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n      format = inheritable_setting.namespace_inheritable[:format]\n\n      stack.use Rack::Head\n      stack.use Rack::Lint if lint?\n      stack.use Grape::Middleware::Error,\n                format:,\n                content_types:,\n                default_status: inheritable_setting.namespace_inheritable[:default_error_status],\n                rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],\n                rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],\n                default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],\n                error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),\n                rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),\n                rescue_handlers:,\n                base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),\n                all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],\n                grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]\n\n      stack.concat inheritable_setting.namespace_stackable[:middleware]\n\n      if inheritable_setting.namespace_inheritable[:version].present?\n        stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),\n                  versions: inheritable_setting.namespace_inheritable[:version].flatten,\n                  version_options: inheritable_setting.namespace_inheritable[:version_options],\n                  prefix: inheritable_setting.namespace_inheritable[:root_prefix],\n                  mount_path: inheritable_setting.namespace_stackable[:mount_path].first\n      end\n\n      stack.use Grape::Middleware::Formatter,\n                format:,\n                default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,\n                content_types:,\n                formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),\n                parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)\n\n      builder = stack.build\n      builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }\n      builder.to_app\n    end\n\n    def build_helpers\n      helpers = inheritable_setting.namespace_stackable[:helpers]\n      return if helpers.empty?\n\n      Module.new { helpers.each { |mod_to_include| include mod_to_include } }\n    end\n\n    def build_response_cookies\n      response_cookies do |name, value|\n        cookie_value = value.is_a?(Hash) ? value : { value: }\n        Rack::Utils.set_cookie_header! header, name, cookie_value\n      end\n    end\n\n    def lint?\n      inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint\n    end\n\n    def rescue_handlers\n      rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]\n      return if rescue_handlers.blank?\n\n      rescue_handlers.each_with_object({}) do |rescue_handler, result|\n        result.merge!(rescue_handler) { |_k, s1, _s2| s1 }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_stack", "signature": "def build_stack stack = Grape::Middleware::Stack.new", "start_line": 291, "end_line": 333}, "metadata": {"module": "Grape", "class_name": "Endpoint", "class_signature": "class Endpoint"}, "task_id": 502}
{"function_name": "refresh_mount_step", "file_path": "grape/lib/grape/api.rb", "focal_code": "def refresh_mount_step\n        @setup.each do |setup_step|\n          next if setup_step[:method] != :mount\n\n          refresh_mount_step = setup_step.merge(method: :refresh_mounted_api)\n          @setup << refresh_mount_step\n          @instances.each do |instance|\n            replay_step_on(instance, **refresh_mount_step)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # The API class is the primary entry point for creating Grape APIs. Users\n  # should subclass this class in order to build an API.\n  class API\n    # Class methods that we want to call on the API rather than on the API object\n    NON_OVERRIDABLE = %i[base= base_instance? call change! configuration compile! inherit_settings recognize_path reset! routes top_level_setting= top_level_setting].freeze\n\n    Helpers = Grape::DSL::Helpers::BaseHelper\n\n    class Boolean\n      def self.build(val)\n        return nil if val != true && val != false\n\n        new\n      end\n    end\n\n    class << self\n      extend Forwardable\n\n      attr_accessor :base_instance, :instances\n\n      delegate_missing_to :base_instance\n\n      # This is the interface point between Rack and Grape; it accepts a request\n      # from Rack and ultimately returns an array of three values: the status,\n      # the headers, and the body. See [the rack specification]\n      # (https://github.com/rack/rack/blob/main/SPEC.rdoc) for more.\n      # NOTE: This will only be called on an API directly mounted on RACK\n      def_delegators :base_instance, :new, :configuration, :call, :change!, :compile!, :recognize_path, :routes\n\n      # Initialize the instance variables on the remountable class, and the base_instance\n      # an instance that will be used to create the set up but will not be mounted\n      def initial_setup(base_instance_parent)\n        @instances = []\n        @setup = []\n        @base_parent = base_instance_parent\n        @base_instance = mount_instance\n      end\n\n      # Redefines all methods so that are forwarded to add_setup and be recorded\n      def override_all_methods!\n        (base_instance.methods - Class.methods - NON_OVERRIDABLE).each do |method_override|\n          define_singleton_method(method_override) do |*args, **kwargs, &block|\n            add_setup(method: method_override, args:, kwargs:, block:)\n          end\n        end\n      end\n\n      # Configure an API from the outside. If a block is given, it'll pass a\n      # configuration hash to the block which you can use to configure your\n      # API. If no block is given, returns the configuration hash.\n      # The configuration set here is accessible from inside an API with\n      # `configuration` as normal.\n      def configure\n        config = @base_instance.configuration\n        if block_given?\n          yield config\n          self\n        else\n          config\n        end\n      end\n\n      # The remountable class can have a configuration hash to provide some dynamic class-level variables.\n      # For instance, a description could be done using: `desc configuration[:description]` if it may vary\n      # depending on where the endpoint is mounted. Use with care, if you find yourself using configuration\n      # too much, you may actually want to provide a new API rather than remount it.\n      def mount_instance(configuration: nil)\n        Class.new(@base_parent).tap do |instance|\n          instance.configuration = Grape::Util::EndpointConfiguration.new(configuration || {})\n          instance.base = self\n          replay_setup_on(instance)\n        end\n      end\n\n      private\n\n      # When inherited, will create a list of all instances (times the API was mounted)\n      # It will listen to the setup required to mount that endpoint, and replicate it on any new instance\n      def inherited(api)\n        super\n\n        api.initial_setup(self == Grape::API ? Grape::API::Instance : @base_instance)\n        api.override_all_methods!\n      end\n\n      # Replays the set up to produce an API as defined in this class, can be called\n      # on classes that inherit from Grape::API\n      def replay_setup_on(instance)\n        @setup.each do |setup_step|\n          replay_step_on(instance, **setup_step)\n        end\n      end\n\n      # Adds a new stage to the set up require to get a Grape::API up and running\n      def add_setup(**step)\n        @setup << step\n        last_response = nil\n        @instances.each do |instance|\n          last_response = replay_step_on(instance, **step)\n        end\n\n        refresh_mount_step if step[:method] != :mount\n        last_response\n      end\n\n      # Updating all previously mounted classes in the case that new methods have been executed.\n      def refresh_mount_step\n        @setup.each do |setup_step|\n          next if setup_step[:method] != :mount\n\n          refresh_mount_step = setup_step.merge(method: :refresh_mounted_api)\n          @setup << refresh_mount_step\n          @instances.each do |instance|\n            replay_step_on(instance, **refresh_mount_step)\n          end\n        end\n      end\n\n      def replay_step_on(instance, method:, args:, kwargs:, block:)\n        return if skip_immediate_run?(instance, args, kwargs)\n\n        eval_args = evaluate_arguments(instance.configuration, *args)\n        eval_kwargs = kwargs.deep_transform_values { |v| evaluate_arguments(instance.configuration, v).first }\n        response = instance.__send__(method, *eval_args, **eval_kwargs, &block)\n\n        return response if skip_immediate_run?(instance, [response], kwargs)\n\n        evaluate_arguments(instance.configuration, response).first\n      end\n\n      # Skips steps that contain arguments to be lazily executed (on re-mount time)\n      def skip_immediate_run?(instance, args, kwargs)\n        instance.base_instance? &&\n          (any_lazy?(args) || args.any? { |arg| arg.is_a?(Hash) && any_lazy?(arg.values) } || any_lazy?(kwargs.values))\n      end\n\n      def any_lazy?(args)\n        args.any?(Grape::Util::Lazy::Base)\n      end\n\n      def evaluate_arguments(configuration, *args)\n        args.map do |argument|\n          case argument\n          when Grape::Util::Lazy::Base\n            argument.evaluate_from(configuration)\n          when Hash\n            argument.transform_values { |value| evaluate_arguments(configuration, value).first }\n          when Array\n            evaluate_arguments(configuration, *argument)\n          else\n            argument\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "refresh_mount_step", "signature": "def refresh_mount_step @setup.each do |setup_step|", "start_line": 111, "end_line": 121}, "metadata": {"module": "Grape", "class_name": "API", "class_signature": "class API"}, "task_id": 503}
{"function_name": "evaluate_arguments", "file_path": "grape/lib/grape/api.rb", "focal_code": "def evaluate_arguments(configuration, *args)\n        args.map do |argument|\n          case argument\n          when Grape::Util::Lazy::Base\n            argument.evaluate_from(configuration)\n          when Hash\n            argument.transform_values { |value| evaluate_arguments(configuration, value).first }\n          when Array\n            evaluate_arguments(configuration, *argument)\n          else\n            argument\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  # The API class is the primary entry point for creating Grape APIs. Users\n  # should subclass this class in order to build an API.\n  class API\n    # Class methods that we want to call on the API rather than on the API object\n    NON_OVERRIDABLE = %i[base= base_instance? call change! configuration compile! inherit_settings recognize_path reset! routes top_level_setting= top_level_setting].freeze\n\n    Helpers = Grape::DSL::Helpers::BaseHelper\n\n    class Boolean\n      def self.build(val)\n        return nil if val != true && val != false\n\n        new\n      end\n    end\n\n    class << self\n      extend Forwardable\n\n      attr_accessor :base_instance, :instances\n\n      delegate_missing_to :base_instance\n\n      # This is the interface point between Rack and Grape; it accepts a request\n      # from Rack and ultimately returns an array of three values: the status,\n      # the headers, and the body. See [the rack specification]\n      # (https://github.com/rack/rack/blob/main/SPEC.rdoc) for more.\n      # NOTE: This will only be called on an API directly mounted on RACK\n      def_delegators :base_instance, :new, :configuration, :call, :change!, :compile!, :recognize_path, :routes\n\n      # Initialize the instance variables on the remountable class, and the base_instance\n      # an instance that will be used to create the set up but will not be mounted\n      def initial_setup(base_instance_parent)\n        @instances = []\n        @setup = []\n        @base_parent = base_instance_parent\n        @base_instance = mount_instance\n      end\n\n      # Redefines all methods so that are forwarded to add_setup and be recorded\n      def override_all_methods!\n        (base_instance.methods - Class.methods - NON_OVERRIDABLE).each do |method_override|\n          define_singleton_method(method_override) do |*args, **kwargs, &block|\n            add_setup(method: method_override, args:, kwargs:, block:)\n          end\n        end\n      end\n\n      # Configure an API from the outside. If a block is given, it'll pass a\n      # configuration hash to the block which you can use to configure your\n      # API. If no block is given, returns the configuration hash.\n      # The configuration set here is accessible from inside an API with\n      # `configuration` as normal.\n      def configure\n        config = @base_instance.configuration\n        if block_given?\n          yield config\n          self\n        else\n          config\n        end\n      end\n\n      # The remountable class can have a configuration hash to provide some dynamic class-level variables.\n      # For instance, a description could be done using: `desc configuration[:description]` if it may vary\n      # depending on where the endpoint is mounted. Use with care, if you find yourself using configuration\n      # too much, you may actually want to provide a new API rather than remount it.\n      def mount_instance(configuration: nil)\n        Class.new(@base_parent).tap do |instance|\n          instance.configuration = Grape::Util::EndpointConfiguration.new(configuration || {})\n          instance.base = self\n          replay_setup_on(instance)\n        end\n      end\n\n      private\n\n      # When inherited, will create a list of all instances (times the API was mounted)\n      # It will listen to the setup required to mount that endpoint, and replicate it on any new instance\n      def inherited(api)\n        super\n\n        api.initial_setup(self == Grape::API ? Grape::API::Instance : @base_instance)\n        api.override_all_methods!\n      end\n\n      # Replays the set up to produce an API as defined in this class, can be called\n      # on classes that inherit from Grape::API\n      def replay_setup_on(instance)\n        @setup.each do |setup_step|\n          replay_step_on(instance, **setup_step)\n        end\n      end\n\n      # Adds a new stage to the set up require to get a Grape::API up and running\n      def add_setup(**step)\n        @setup << step\n        last_response = nil\n        @instances.each do |instance|\n          last_response = replay_step_on(instance, **step)\n        end\n\n        refresh_mount_step if step[:method] != :mount\n        last_response\n      end\n\n      # Updating all previously mounted classes in the case that new methods have been executed.\n      def refresh_mount_step\n        @setup.each do |setup_step|\n          next if setup_step[:method] != :mount\n\n          refresh_mount_step = setup_step.merge(method: :refresh_mounted_api)\n          @setup << refresh_mount_step\n          @instances.each do |instance|\n            replay_step_on(instance, **refresh_mount_step)\n          end\n        end\n      end\n\n      def replay_step_on(instance, method:, args:, kwargs:, block:)\n        return if skip_immediate_run?(instance, args, kwargs)\n\n        eval_args = evaluate_arguments(instance.configuration, *args)\n        eval_kwargs = kwargs.deep_transform_values { |v| evaluate_arguments(instance.configuration, v).first }\n        response = instance.__send__(method, *eval_args, **eval_kwargs, &block)\n\n        return response if skip_immediate_run?(instance, [response], kwargs)\n\n        evaluate_arguments(instance.configuration, response).first\n      end\n\n      # Skips steps that contain arguments to be lazily executed (on re-mount time)\n      def skip_immediate_run?(instance, args, kwargs)\n        instance.base_instance? &&\n          (any_lazy?(args) || args.any? { |arg| arg.is_a?(Hash) && any_lazy?(arg.values) } || any_lazy?(kwargs.values))\n      end\n\n      def any_lazy?(args)\n        args.any?(Grape::Util::Lazy::Base)\n      end\n\n      def evaluate_arguments(configuration, *args)\n        args.map do |argument|\n          case argument\n          when Grape::Util::Lazy::Base\n            argument.evaluate_from(configuration)\n          when Hash\n            argument.transform_values { |value| evaluate_arguments(configuration, value).first }\n          when Array\n            evaluate_arguments(configuration, *argument)\n          else\n            argument\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "evaluate_arguments", "signature": "def evaluate_arguments(configuration, *args)", "start_line": 145, "end_line": 158}, "metadata": {"module": "Grape", "class_name": "API", "class_signature": "class API"}, "task_id": 504}
{"function_name": "normalize_path", "file_path": "grape/lib/grape/router.rb", "focal_code": "def self.normalize_path(path)\n      return '/' unless path\n      return path if path == '/'\n\n      # Fast path for the overwhelming majority of paths that don't need to be normalized\n      return path if path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//}))\n\n      # Slow path\n      encoding = path.encoding\n      path = \"/#{path}\"\n      path.squeeze!('/')\n\n      unless path == '/'\n        path.delete_suffix!('/')\n        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }\n      end\n\n      path.force_encoding(encoding)\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class Router\n    # Taken from Rails\n    #     normalize_path(\"/foo\")  # => \"/foo\"\n    #     normalize_path(\"/foo/\") # => \"/foo\"\n    #     normalize_path(\"foo\")   # => \"/foo\"\n    #     normalize_path(\"\")      # => \"/\"\n    #     normalize_path(\"/%ab\")  # => \"/%AB\"\n    # https://github.com/rails/rails/blob/00cc4ff0259c0185fe08baadaa40e63ea2534f6e/actionpack/lib/action_dispatch/journey/router/utils.rb#L19\n    def self.normalize_path(path)\n      return '/' unless path\n      return path if path == '/'\n\n      # Fast path for the overwhelming majority of paths that don't need to be normalized\n      return path if path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//}))\n\n      # Slow path\n      encoding = path.encoding\n      path = \"/#{path}\"\n      path.squeeze!('/')\n\n      unless path == '/'\n        path.delete_suffix!('/')\n        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }\n      end\n\n      path.force_encoding(encoding)\n    end\n\n    def initialize\n      @neutral_map = []\n      @neutral_regexes = []\n      @map = Hash.new { |hash, key| hash[key] = [] }\n      @optimized_map = Hash.new { |hash, key| hash[key] = // }\n    end\n\n    def compile!\n      return if @compiled\n\n      @union = Regexp.union(@neutral_regexes)\n      @neutral_regexes = nil\n      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|\n        next unless @map.key?(method)\n\n        routes = @map[method]\n        optimized_map = routes.map.with_index { |route, index| route.to_regexp(index) }\n        @optimized_map[method] = Regexp.union(optimized_map)\n      end\n      @compiled = true\n    end\n\n    def append(route)\n      @map[route.request_method] << route\n    end\n\n    def associate_routes(greedy_route)\n      @neutral_regexes << greedy_route.to_regexp(@neutral_map.length)\n      @neutral_map << greedy_route\n    end\n\n    def call(env)\n      with_optimization do\n        input = Router.normalize_path(env[Rack::PATH_INFO])\n        method = env[Rack::REQUEST_METHOD]\n        response, route = identity(input, method, env)\n        response || rotation(input, method, env, route)\n      end\n    end\n\n    def recognize_path(input)\n      any = with_optimization { greedy_match?(input) }\n      return if any == default_response\n\n      any.endpoint\n    end\n\n    DEFAULT_RESPONSE_HEADERS = Grape::Util::Header.new.merge('X-Cascade' => 'pass').freeze\n    DEFAULT_RESPONSE_BODY = ['404 Not Found'].freeze\n\n    private\n\n    def identity(input, method, env)\n      route = nil\n      response = transaction(input, method, env) do\n        route = match?(input, method)\n        process_route(route, input, env) if route\n      end\n      [response, route]\n    end\n\n    def rotation(input, method, env, exact_route)\n      response = nil\n      @map[method].each do |route|\n        next if exact_route == route\n        next unless route.match?(input)\n\n        response = process_route(route, input, env)\n        break unless cascade?(response)\n      end\n      response\n    end\n\n    def transaction(input, method, env)\n      response = yield\n      return response if halt?(response)\n\n      last_response_cascade = !response.nil?\n      last_neighbor_route = greedy_match?(input)\n\n      # If last_neighbor_route exists and request method is OPTIONS,\n      # return response by using #include_allow_header.\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && method == Rack::OPTIONS && last_neighbor_route\n\n      route = match?(input, '*')\n\n      return last_neighbor_route.call(env) if last_neighbor_route && last_response_cascade && route\n\n      if route\n        route_response = process_route(route, input, env)\n        return route_response if halt?(route_response)\n\n        last_response_cascade = !route_response.nil?\n      end\n\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && last_neighbor_route\n\n      nil\n    end\n\n    # Returns true if `response` should be returned as-is from the enclosing\n    # transaction. Closes the body as a side effect when the response is\n    # cascading so callers can safely try the next match.\n    def halt?(response)\n      return false unless response\n\n      cascade = cascade?(response)\n      response[2].close if cascade && response[2].respond_to?(:close)\n      !cascade\n    end\n\n    def process_route(route, input, env, include_allow_header: false)\n      args = env[Grape::Env::GRAPE_ROUTING_ARGS] || { route_info: route }\n      route_params = route.params(input)\n      env[Grape::Env::GRAPE_ROUTING_ARGS] = route_params.blank? ? args : args.merge(route_params)\n      env[Grape::Env::GRAPE_ALLOWED_METHODS] = route.allow_header if include_allow_header\n      route.call(env)\n    end\n\n    def with_optimization\n      compile!\n      yield || default_response\n    end\n\n    def default_response\n      [404, DEFAULT_RESPONSE_HEADERS.dup, DEFAULT_RESPONSE_BODY.dup]\n    end\n\n    def match?(input, method)\n      @optimized_map[method].match(input) { |m| @map[method].detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def greedy_match?(input)\n      @union.match(input) { |m| @neutral_map.detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def cascade?(response)\n      response && response[1]['X-Cascade'] == 'pass'\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "normalize_path", "signature": "def self.normalize_path(path)", "start_line": 12, "end_line": 30}, "metadata": {"module": "Grape", "class_name": "Router", "class_signature": "class Router"}, "task_id": 505}
{"function_name": "compile!", "file_path": "grape/lib/grape/router.rb", "focal_code": "def compile!\n      return if @compiled\n\n      @union = Regexp.union(@neutral_regexes)\n      @neutral_regexes = nil\n      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|\n        next unless @map.key?(method)\n\n        routes = @map[method]\n        optimized_map = routes.map.with_index { |route, index| route.to_regexp(index) }\n        @optimized_map[method] = Regexp.union(optimized_map)\n      end\n      @compiled = true\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class Router\n    # Taken from Rails\n    #     normalize_path(\"/foo\")  # => \"/foo\"\n    #     normalize_path(\"/foo/\") # => \"/foo\"\n    #     normalize_path(\"foo\")   # => \"/foo\"\n    #     normalize_path(\"\")      # => \"/\"\n    #     normalize_path(\"/%ab\")  # => \"/%AB\"\n    # https://github.com/rails/rails/blob/00cc4ff0259c0185fe08baadaa40e63ea2534f6e/actionpack/lib/action_dispatch/journey/router/utils.rb#L19\n    def self.normalize_path(path)\n      return '/' unless path\n      return path if path == '/'\n\n      # Fast path for the overwhelming majority of paths that don't need to be normalized\n      return path if path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//}))\n\n      # Slow path\n      encoding = path.encoding\n      path = \"/#{path}\"\n      path.squeeze!('/')\n\n      unless path == '/'\n        path.delete_suffix!('/')\n        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }\n      end\n\n      path.force_encoding(encoding)\n    end\n\n    def initialize\n      @neutral_map = []\n      @neutral_regexes = []\n      @map = Hash.new { |hash, key| hash[key] = [] }\n      @optimized_map = Hash.new { |hash, key| hash[key] = // }\n    end\n\n    def compile!\n      return if @compiled\n\n      @union = Regexp.union(@neutral_regexes)\n      @neutral_regexes = nil\n      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|\n        next unless @map.key?(method)\n\n        routes = @map[method]\n        optimized_map = routes.map.with_index { |route, index| route.to_regexp(index) }\n        @optimized_map[method] = Regexp.union(optimized_map)\n      end\n      @compiled = true\n    end\n\n    def append(route)\n      @map[route.request_method] << route\n    end\n\n    def associate_routes(greedy_route)\n      @neutral_regexes << greedy_route.to_regexp(@neutral_map.length)\n      @neutral_map << greedy_route\n    end\n\n    def call(env)\n      with_optimization do\n        input = Router.normalize_path(env[Rack::PATH_INFO])\n        method = env[Rack::REQUEST_METHOD]\n        response, route = identity(input, method, env)\n        response || rotation(input, method, env, route)\n      end\n    end\n\n    def recognize_path(input)\n      any = with_optimization { greedy_match?(input) }\n      return if any == default_response\n\n      any.endpoint\n    end\n\n    DEFAULT_RESPONSE_HEADERS = Grape::Util::Header.new.merge('X-Cascade' => 'pass').freeze\n    DEFAULT_RESPONSE_BODY = ['404 Not Found'].freeze\n\n    private\n\n    def identity(input, method, env)\n      route = nil\n      response = transaction(input, method, env) do\n        route = match?(input, method)\n        process_route(route, input, env) if route\n      end\n      [response, route]\n    end\n\n    def rotation(input, method, env, exact_route)\n      response = nil\n      @map[method].each do |route|\n        next if exact_route == route\n        next unless route.match?(input)\n\n        response = process_route(route, input, env)\n        break unless cascade?(response)\n      end\n      response\n    end\n\n    def transaction(input, method, env)\n      response = yield\n      return response if halt?(response)\n\n      last_response_cascade = !response.nil?\n      last_neighbor_route = greedy_match?(input)\n\n      # If last_neighbor_route exists and request method is OPTIONS,\n      # return response by using #include_allow_header.\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && method == Rack::OPTIONS && last_neighbor_route\n\n      route = match?(input, '*')\n\n      return last_neighbor_route.call(env) if last_neighbor_route && last_response_cascade && route\n\n      if route\n        route_response = process_route(route, input, env)\n        return route_response if halt?(route_response)\n\n        last_response_cascade = !route_response.nil?\n      end\n\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && last_neighbor_route\n\n      nil\n    end\n\n    # Returns true if `response` should be returned as-is from the enclosing\n    # transaction. Closes the body as a side effect when the response is\n    # cascading so callers can safely try the next match.\n    def halt?(response)\n      return false unless response\n\n      cascade = cascade?(response)\n      response[2].close if cascade && response[2].respond_to?(:close)\n      !cascade\n    end\n\n    def process_route(route, input, env, include_allow_header: false)\n      args = env[Grape::Env::GRAPE_ROUTING_ARGS] || { route_info: route }\n      route_params = route.params(input)\n      env[Grape::Env::GRAPE_ROUTING_ARGS] = route_params.blank? ? args : args.merge(route_params)\n      env[Grape::Env::GRAPE_ALLOWED_METHODS] = route.allow_header if include_allow_header\n      route.call(env)\n    end\n\n    def with_optimization\n      compile!\n      yield || default_response\n    end\n\n    def default_response\n      [404, DEFAULT_RESPONSE_HEADERS.dup, DEFAULT_RESPONSE_BODY.dup]\n    end\n\n    def match?(input, method)\n      @optimized_map[method].match(input) { |m| @map[method].detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def greedy_match?(input)\n      @union.match(input) { |m| @neutral_map.detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def cascade?(response)\n      response && response[1]['X-Cascade'] == 'pass'\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "compile!", "signature": "def compile! return if @compiled", "start_line": 39, "end_line": 52}, "metadata": {"module": "Grape", "class_name": "Router", "class_signature": "class Router"}, "task_id": 506}
{"function_name": "rotation", "file_path": "grape/lib/grape/router.rb", "focal_code": "def rotation(input, method, env, exact_route)\n      response = nil\n      @map[method].each do |route|\n        next if exact_route == route\n        next unless route.match?(input)\n\n        response = process_route(route, input, env)\n        break unless cascade?(response)\n      end\n      response\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class Router\n    # Taken from Rails\n    #     normalize_path(\"/foo\")  # => \"/foo\"\n    #     normalize_path(\"/foo/\") # => \"/foo\"\n    #     normalize_path(\"foo\")   # => \"/foo\"\n    #     normalize_path(\"\")      # => \"/\"\n    #     normalize_path(\"/%ab\")  # => \"/%AB\"\n    # https://github.com/rails/rails/blob/00cc4ff0259c0185fe08baadaa40e63ea2534f6e/actionpack/lib/action_dispatch/journey/router/utils.rb#L19\n    def self.normalize_path(path)\n      return '/' unless path\n      return path if path == '/'\n\n      # Fast path for the overwhelming majority of paths that don't need to be normalized\n      return path if path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//}))\n\n      # Slow path\n      encoding = path.encoding\n      path = \"/#{path}\"\n      path.squeeze!('/')\n\n      unless path == '/'\n        path.delete_suffix!('/')\n        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }\n      end\n\n      path.force_encoding(encoding)\n    end\n\n    def initialize\n      @neutral_map = []\n      @neutral_regexes = []\n      @map = Hash.new { |hash, key| hash[key] = [] }\n      @optimized_map = Hash.new { |hash, key| hash[key] = // }\n    end\n\n    def compile!\n      return if @compiled\n\n      @union = Regexp.union(@neutral_regexes)\n      @neutral_regexes = nil\n      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|\n        next unless @map.key?(method)\n\n        routes = @map[method]\n        optimized_map = routes.map.with_index { |route, index| route.to_regexp(index) }\n        @optimized_map[method] = Regexp.union(optimized_map)\n      end\n      @compiled = true\n    end\n\n    def append(route)\n      @map[route.request_method] << route\n    end\n\n    def associate_routes(greedy_route)\n      @neutral_regexes << greedy_route.to_regexp(@neutral_map.length)\n      @neutral_map << greedy_route\n    end\n\n    def call(env)\n      with_optimization do\n        input = Router.normalize_path(env[Rack::PATH_INFO])\n        method = env[Rack::REQUEST_METHOD]\n        response, route = identity(input, method, env)\n        response || rotation(input, method, env, route)\n      end\n    end\n\n    def recognize_path(input)\n      any = with_optimization { greedy_match?(input) }\n      return if any == default_response\n\n      any.endpoint\n    end\n\n    DEFAULT_RESPONSE_HEADERS = Grape::Util::Header.new.merge('X-Cascade' => 'pass').freeze\n    DEFAULT_RESPONSE_BODY = ['404 Not Found'].freeze\n\n    private\n\n    def identity(input, method, env)\n      route = nil\n      response = transaction(input, method, env) do\n        route = match?(input, method)\n        process_route(route, input, env) if route\n      end\n      [response, route]\n    end\n\n    def rotation(input, method, env, exact_route)\n      response = nil\n      @map[method].each do |route|\n        next if exact_route == route\n        next unless route.match?(input)\n\n        response = process_route(route, input, env)\n        break unless cascade?(response)\n      end\n      response\n    end\n\n    def transaction(input, method, env)\n      response = yield\n      return response if halt?(response)\n\n      last_response_cascade = !response.nil?\n      last_neighbor_route = greedy_match?(input)\n\n      # If last_neighbor_route exists and request method is OPTIONS,\n      # return response by using #include_allow_header.\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && method == Rack::OPTIONS && last_neighbor_route\n\n      route = match?(input, '*')\n\n      return last_neighbor_route.call(env) if last_neighbor_route && last_response_cascade && route\n\n      if route\n        route_response = process_route(route, input, env)\n        return route_response if halt?(route_response)\n\n        last_response_cascade = !route_response.nil?\n      end\n\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && last_neighbor_route\n\n      nil\n    end\n\n    # Returns true if `response` should be returned as-is from the enclosing\n    # transaction. Closes the body as a side effect when the response is\n    # cascading so callers can safely try the next match.\n    def halt?(response)\n      return false unless response\n\n      cascade = cascade?(response)\n      response[2].close if cascade && response[2].respond_to?(:close)\n      !cascade\n    end\n\n    def process_route(route, input, env, include_allow_header: false)\n      args = env[Grape::Env::GRAPE_ROUTING_ARGS] || { route_info: route }\n      route_params = route.params(input)\n      env[Grape::Env::GRAPE_ROUTING_ARGS] = route_params.blank? ? args : args.merge(route_params)\n      env[Grape::Env::GRAPE_ALLOWED_METHODS] = route.allow_header if include_allow_header\n      route.call(env)\n    end\n\n    def with_optimization\n      compile!\n      yield || default_response\n    end\n\n    def default_response\n      [404, DEFAULT_RESPONSE_HEADERS.dup, DEFAULT_RESPONSE_BODY.dup]\n    end\n\n    def match?(input, method)\n      @optimized_map[method].match(input) { |m| @map[method].detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def greedy_match?(input)\n      @union.match(input) { |m| @neutral_map.detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def cascade?(response)\n      response && response[1]['X-Cascade'] == 'pass'\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "rotation", "signature": "def rotation(input, method, env, exact_route)", "start_line": 93, "end_line": 103}, "metadata": {"module": "Grape", "class_name": "Router", "class_signature": "class Router"}, "task_id": 507}
{"function_name": "transaction", "file_path": "grape/lib/grape/router.rb", "focal_code": "def transaction(input, method, env)\n      response = yield\n      return response if halt?(response)\n\n      last_response_cascade = !response.nil?\n      last_neighbor_route = greedy_match?(input)\n\n      # If last_neighbor_route exists and request method is OPTIONS,\n      # return response by using #include_allow_header.\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && method == Rack::OPTIONS && last_neighbor_route\n\n      route = match?(input, '*')\n\n      return last_neighbor_route.call(env) if last_neighbor_route && last_response_cascade && route\n\n      if route\n        route_response = process_route(route, input, env)\n        return route_response if halt?(route_response)\n\n        last_response_cascade = !route_response.nil?\n      end\n\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && last_neighbor_route\n\n      nil\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class Router\n    # Taken from Rails\n    #     normalize_path(\"/foo\")  # => \"/foo\"\n    #     normalize_path(\"/foo/\") # => \"/foo\"\n    #     normalize_path(\"foo\")   # => \"/foo\"\n    #     normalize_path(\"\")      # => \"/\"\n    #     normalize_path(\"/%ab\")  # => \"/%AB\"\n    # https://github.com/rails/rails/blob/00cc4ff0259c0185fe08baadaa40e63ea2534f6e/actionpack/lib/action_dispatch/journey/router/utils.rb#L19\n    def self.normalize_path(path)\n      return '/' unless path\n      return path if path == '/'\n\n      # Fast path for the overwhelming majority of paths that don't need to be normalized\n      return path if path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//}))\n\n      # Slow path\n      encoding = path.encoding\n      path = \"/#{path}\"\n      path.squeeze!('/')\n\n      unless path == '/'\n        path.delete_suffix!('/')\n        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }\n      end\n\n      path.force_encoding(encoding)\n    end\n\n    def initialize\n      @neutral_map = []\n      @neutral_regexes = []\n      @map = Hash.new { |hash, key| hash[key] = [] }\n      @optimized_map = Hash.new { |hash, key| hash[key] = // }\n    end\n\n    def compile!\n      return if @compiled\n\n      @union = Regexp.union(@neutral_regexes)\n      @neutral_regexes = nil\n      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|\n        next unless @map.key?(method)\n\n        routes = @map[method]\n        optimized_map = routes.map.with_index { |route, index| route.to_regexp(index) }\n        @optimized_map[method] = Regexp.union(optimized_map)\n      end\n      @compiled = true\n    end\n\n    def append(route)\n      @map[route.request_method] << route\n    end\n\n    def associate_routes(greedy_route)\n      @neutral_regexes << greedy_route.to_regexp(@neutral_map.length)\n      @neutral_map << greedy_route\n    end\n\n    def call(env)\n      with_optimization do\n        input = Router.normalize_path(env[Rack::PATH_INFO])\n        method = env[Rack::REQUEST_METHOD]\n        response, route = identity(input, method, env)\n        response || rotation(input, method, env, route)\n      end\n    end\n\n    def recognize_path(input)\n      any = with_optimization { greedy_match?(input) }\n      return if any == default_response\n\n      any.endpoint\n    end\n\n    DEFAULT_RESPONSE_HEADERS = Grape::Util::Header.new.merge('X-Cascade' => 'pass').freeze\n    DEFAULT_RESPONSE_BODY = ['404 Not Found'].freeze\n\n    private\n\n    def identity(input, method, env)\n      route = nil\n      response = transaction(input, method, env) do\n        route = match?(input, method)\n        process_route(route, input, env) if route\n      end\n      [response, route]\n    end\n\n    def rotation(input, method, env, exact_route)\n      response = nil\n      @map[method].each do |route|\n        next if exact_route == route\n        next unless route.match?(input)\n\n        response = process_route(route, input, env)\n        break unless cascade?(response)\n      end\n      response\n    end\n\n    def transaction(input, method, env)\n      response = yield\n      return response if halt?(response)\n\n      last_response_cascade = !response.nil?\n      last_neighbor_route = greedy_match?(input)\n\n      # If last_neighbor_route exists and request method is OPTIONS,\n      # return response by using #include_allow_header.\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && method == Rack::OPTIONS && last_neighbor_route\n\n      route = match?(input, '*')\n\n      return last_neighbor_route.call(env) if last_neighbor_route && last_response_cascade && route\n\n      if route\n        route_response = process_route(route, input, env)\n        return route_response if halt?(route_response)\n\n        last_response_cascade = !route_response.nil?\n      end\n\n      return process_route(last_neighbor_route, input, env, include_allow_header: true) if !last_response_cascade && last_neighbor_route\n\n      nil\n    end\n\n    # Returns true if `response` should be returned as-is from the enclosing\n    # transaction. Closes the body as a side effect when the response is\n    # cascading so callers can safely try the next match.\n    def halt?(response)\n      return false unless response\n\n      cascade = cascade?(response)\n      response[2].close if cascade && response[2].respond_to?(:close)\n      !cascade\n    end\n\n    def process_route(route, input, env, include_allow_header: false)\n      args = env[Grape::Env::GRAPE_ROUTING_ARGS] || { route_info: route }\n      route_params = route.params(input)\n      env[Grape::Env::GRAPE_ROUTING_ARGS] = route_params.blank? ? args : args.merge(route_params)\n      env[Grape::Env::GRAPE_ALLOWED_METHODS] = route.allow_header if include_allow_header\n      route.call(env)\n    end\n\n    def with_optimization\n      compile!\n      yield || default_response\n    end\n\n    def default_response\n      [404, DEFAULT_RESPONSE_HEADERS.dup, DEFAULT_RESPONSE_BODY.dup]\n    end\n\n    def match?(input, method)\n      @optimized_map[method].match(input) { |m| @map[method].detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def greedy_match?(input)\n      @union.match(input) { |m| @neutral_map.detect { |route| m[route.regexp_capture_index] } }\n    end\n\n    def cascade?(response)\n      response && response[1]['X-Cascade'] == 'pass'\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "transaction", "signature": "def transaction(input, method, env)", "start_line": 105, "end_line": 130}, "metadata": {"module": "Grape", "class_name": "Router", "class_signature": "class Router"}, "task_id": 508}
{"function_name": "recursive_declared", "file_path": "grape/lib/grape/declared_params_handler.rb", "focal_code": "def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])\n      res = if passed_params.is_a?(Array)\n              passed_params.map do |passed_param|\n                recursive_declared(passed_param, declared_params:, params_nested_path:, renamed_params:, route_params:)\n              end\n            else\n              declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n            end\n\n      @contract_key_map&.each { |key_map| key_map.write(passed_params, res) }\n\n      res\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class DeclaredParamsHandler\n    def initialize(include_missing: true, evaluate_given: false, stringify: false, contract_key_map: nil)\n      @include_missing = include_missing\n      @evaluate_given = evaluate_given\n      @stringify = stringify\n      @contract_key_map = contract_key_map\n    end\n\n    def call(passed_params, declared_params, route_params, renamed_params)\n      recursive_declared(\n        passed_params,\n        declared_params:,\n        route_params:,\n        renamed_params:\n      )\n    end\n\n    private\n\n    def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])\n      res = if passed_params.is_a?(Array)\n              passed_params.map do |passed_param|\n                recursive_declared(passed_param, declared_params:, params_nested_path:, renamed_params:, route_params:)\n              end\n            else\n              declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n            end\n\n      @contract_key_map&.each { |key_map| key_map.write(passed_params, res) }\n\n      res\n    end\n\n    def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n      declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|\n        next if @evaluate_given && !declared_param_attr.scope.attr_meets_dependency?(passed_params)\n\n        declared_hash_attr(\n          passed_params,\n          declared_param: declared_param_attr.key,\n          params_nested_path:,\n          memo:,\n          renamed_params:,\n          route_params:\n        )\n      end\n    end\n\n    def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)\n      if declared_param.is_a?(Hash)\n        declared_param.each_pair do |declared_parent_param, declared_children_params|\n          next unless @include_missing || passed_params.key?(declared_parent_param)\n\n          memo_key = build_memo_key(params_nested_path, declared_parent_param, renamed_params)\n          passed_children_params = passed_params[declared_parent_param] || passed_params.class.new\n\n          params_nested_path_dup = params_nested_path.dup\n          params_nested_path_dup << declared_parent_param.to_s\n\n          memo[memo_key] = handle_passed_param(params_nested_path_dup, route_params:, has_passed_children: passed_children_params.any?) do\n            recursive_declared(\n              passed_children_params,\n              declared_params: declared_children_params,\n              params_nested_path: params_nested_path_dup,\n              renamed_params:,\n              route_params:\n            )\n          end\n        end\n      else\n        # If it is not a Hash then it does not have children.\n        # Find its value or set it to nil.\n        return unless @include_missing || (passed_params.respond_to?(:key?) && passed_params.key?(declared_param))\n\n        memo_key = build_memo_key(params_nested_path, declared_param, renamed_params)\n        passed_param = passed_params[declared_param]\n\n        params_nested_path_dup = params_nested_path.dup\n        params_nested_path_dup << declared_param.to_s\n\n        memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup, route_params:) do\n          passed_param\n        end\n      end\n    end\n\n    def build_memo_key(params_nested_path, declared_param, renamed_params)\n      rename_path = params_nested_path + [declared_param.to_s]\n      renamed_param_name = renamed_params[rename_path]\n\n      param = renamed_param_name || declared_param\n      @stringify ? param.to_s : param.to_sym\n    end\n\n    def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)\n      return yield if has_passed_children\n\n      key = params_nested_path[0]\n      key += \"[#{params_nested_path[1..].join('][')}]\" if params_nested_path.size > 1\n\n      type = route_params.dig(key, :type)\n      has_children = route_params.keys.any? { |k| k != key && k.start_with?(\"#{key}[\") }\n\n      if type == 'Hash' && !has_children\n        {}\n      elsif type == 'Array' || (type&.start_with?('[') && !type.include?(','))\n        []\n      elsif type == 'Set' || type&.start_with?('#<Set', 'Set')\n        Set.new\n      else\n        yield\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "recursive_declared", "signature": "def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])", "start_line": 23, "end_line": 35}, "metadata": {"module": "Grape", "class_name": "DeclaredParamsHandler", "class_signature": "class DeclaredParamsHandler"}, "task_id": 509}
{"function_name": "declared_hash", "file_path": "grape/lib/grape/declared_params_handler.rb", "focal_code": "def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n      declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|\n        next if @evaluate_given && !declared_param_attr.scope.attr_meets_dependency?(passed_params)\n\n        declared_hash_attr(\n          passed_params,\n          declared_param: declared_param_attr.key,\n          params_nested_path:,\n          memo:,\n          renamed_params:,\n          route_params:\n        )\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class DeclaredParamsHandler\n    def initialize(include_missing: true, evaluate_given: false, stringify: false, contract_key_map: nil)\n      @include_missing = include_missing\n      @evaluate_given = evaluate_given\n      @stringify = stringify\n      @contract_key_map = contract_key_map\n    end\n\n    def call(passed_params, declared_params, route_params, renamed_params)\n      recursive_declared(\n        passed_params,\n        declared_params:,\n        route_params:,\n        renamed_params:\n      )\n    end\n\n    private\n\n    def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])\n      res = if passed_params.is_a?(Array)\n              passed_params.map do |passed_param|\n                recursive_declared(passed_param, declared_params:, params_nested_path:, renamed_params:, route_params:)\n              end\n            else\n              declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n            end\n\n      @contract_key_map&.each { |key_map| key_map.write(passed_params, res) }\n\n      res\n    end\n\n    def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n      declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|\n        next if @evaluate_given && !declared_param_attr.scope.attr_meets_dependency?(passed_params)\n\n        declared_hash_attr(\n          passed_params,\n          declared_param: declared_param_attr.key,\n          params_nested_path:,\n          memo:,\n          renamed_params:,\n          route_params:\n        )\n      end\n    end\n\n    def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)\n      if declared_param.is_a?(Hash)\n        declared_param.each_pair do |declared_parent_param, declared_children_params|\n          next unless @include_missing || passed_params.key?(declared_parent_param)\n\n          memo_key = build_memo_key(params_nested_path, declared_parent_param, renamed_params)\n          passed_children_params = passed_params[declared_parent_param] || passed_params.class.new\n\n          params_nested_path_dup = params_nested_path.dup\n          params_nested_path_dup << declared_parent_param.to_s\n\n          memo[memo_key] = handle_passed_param(params_nested_path_dup, route_params:, has_passed_children: passed_children_params.any?) do\n            recursive_declared(\n              passed_children_params,\n              declared_params: declared_children_params,\n              params_nested_path: params_nested_path_dup,\n              renamed_params:,\n              route_params:\n            )\n          end\n        end\n      else\n        # If it is not a Hash then it does not have children.\n        # Find its value or set it to nil.\n        return unless @include_missing || (passed_params.respond_to?(:key?) && passed_params.key?(declared_param))\n\n        memo_key = build_memo_key(params_nested_path, declared_param, renamed_params)\n        passed_param = passed_params[declared_param]\n\n        params_nested_path_dup = params_nested_path.dup\n        params_nested_path_dup << declared_param.to_s\n\n        memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup, route_params:) do\n          passed_param\n        end\n      end\n    end\n\n    def build_memo_key(params_nested_path, declared_param, renamed_params)\n      rename_path = params_nested_path + [declared_param.to_s]\n      renamed_param_name = renamed_params[rename_path]\n\n      param = renamed_param_name || declared_param\n      @stringify ? param.to_s : param.to_sym\n    end\n\n    def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)\n      return yield if has_passed_children\n\n      key = params_nested_path[0]\n      key += \"[#{params_nested_path[1..].join('][')}]\" if params_nested_path.size > 1\n\n      type = route_params.dig(key, :type)\n      has_children = route_params.keys.any? { |k| k != key && k.start_with?(\"#{key}[\") }\n\n      if type == 'Hash' && !has_children\n        {}\n      elsif type == 'Array' || (type&.start_with?('[') && !type.include?(','))\n        []\n      elsif type == 'Set' || type&.start_with?('#<Set', 'Set')\n        Set.new\n      else\n        yield\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "declared_hash", "signature": "def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)", "start_line": 37, "end_line": 50}, "metadata": {"module": "Grape", "class_name": "DeclaredParamsHandler", "class_signature": "class DeclaredParamsHandler"}, "task_id": 510}
{"function_name": "declared_hash_attr", "file_path": "grape/lib/grape/declared_params_handler.rb", "focal_code": "def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)\n      if declared_param.is_a?(Hash)\n        declared_param.each_pair do |declared_parent_param, declared_children_params|\n          next unless @include_missing || passed_params.key?(declared_parent_param)\n\n          memo_key = build_memo_key(params_nested_path, declared_parent_param, renamed_params)\n          passed_children_params = passed_params[declared_parent_param] || passed_params.class.new\n\n          params_nested_path_dup = params_nested_path.dup\n          params_nested_path_dup << declared_parent_param.to_s\n\n          memo[memo_key] = handle_passed_param(params_nested_path_dup, route_params:, has_passed_children: passed_children_params.any?) do\n            recursive_declared(\n              passed_children_params,\n              declared_params: declared_children_params,\n              params_nested_path: params_nested_path_dup,\n              renamed_params:,\n              route_params:\n            )\n          end\n        end\n      else\n        # If it is not a Hash then it does not have children.\n        # Find its value or set it to nil.\n        return unless @include_missing || (passed_params.respond_to?(:key?) && passed_params.key?(declared_param))\n\n        memo_key = build_memo_key(params_nested_path, declared_param, renamed_params)\n        passed_param = passed_params[declared_param]\n\n        params_nested_path_dup = params_nested_path.dup\n        params_nested_path_dup << declared_param.to_s\n\n        memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup, route_params:) do\n          passed_param\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class DeclaredParamsHandler\n    def initialize(include_missing: true, evaluate_given: false, stringify: false, contract_key_map: nil)\n      @include_missing = include_missing\n      @evaluate_given = evaluate_given\n      @stringify = stringify\n      @contract_key_map = contract_key_map\n    end\n\n    def call(passed_params, declared_params, route_params, renamed_params)\n      recursive_declared(\n        passed_params,\n        declared_params:,\n        route_params:,\n        renamed_params:\n      )\n    end\n\n    private\n\n    def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])\n      res = if passed_params.is_a?(Array)\n              passed_params.map do |passed_param|\n                recursive_declared(passed_param, declared_params:, params_nested_path:, renamed_params:, route_params:)\n              end\n            else\n              declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n            end\n\n      @contract_key_map&.each { |key_map| key_map.write(passed_params, res) }\n\n      res\n    end\n\n    def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n      declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|\n        next if @evaluate_given && !declared_param_attr.scope.attr_meets_dependency?(passed_params)\n\n        declared_hash_attr(\n          passed_params,\n          declared_param: declared_param_attr.key,\n          params_nested_path:,\n          memo:,\n          renamed_params:,\n          route_params:\n        )\n      end\n    end\n\n    def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)\n      if declared_param.is_a?(Hash)\n        declared_param.each_pair do |declared_parent_param, declared_children_params|\n          next unless @include_missing || passed_params.key?(declared_parent_param)\n\n          memo_key = build_memo_key(params_nested_path, declared_parent_param, renamed_params)\n          passed_children_params = passed_params[declared_parent_param] || passed_params.class.new\n\n          params_nested_path_dup = params_nested_path.dup\n          params_nested_path_dup << declared_parent_param.to_s\n\n          memo[memo_key] = handle_passed_param(params_nested_path_dup, route_params:, has_passed_children: passed_children_params.any?) do\n            recursive_declared(\n              passed_children_params,\n              declared_params: declared_children_params,\n              params_nested_path: params_nested_path_dup,\n              renamed_params:,\n              route_params:\n            )\n          end\n        end\n      else\n        # If it is not a Hash then it does not have children.\n        # Find its value or set it to nil.\n        return unless @include_missing || (passed_params.respond_to?(:key?) && passed_params.key?(declared_param))\n\n        memo_key = build_memo_key(params_nested_path, declared_param, renamed_params)\n        passed_param = passed_params[declared_param]\n\n        params_nested_path_dup = params_nested_path.dup\n        params_nested_path_dup << declared_param.to_s\n\n        memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup, route_params:) do\n          passed_param\n        end\n      end\n    end\n\n    def build_memo_key(params_nested_path, declared_param, renamed_params)\n      rename_path = params_nested_path + [declared_param.to_s]\n      renamed_param_name = renamed_params[rename_path]\n\n      param = renamed_param_name || declared_param\n      @stringify ? param.to_s : param.to_sym\n    end\n\n    def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)\n      return yield if has_passed_children\n\n      key = params_nested_path[0]\n      key += \"[#{params_nested_path[1..].join('][')}]\" if params_nested_path.size > 1\n\n      type = route_params.dig(key, :type)\n      has_children = route_params.keys.any? { |k| k != key && k.start_with?(\"#{key}[\") }\n\n      if type == 'Hash' && !has_children\n        {}\n      elsif type == 'Array' || (type&.start_with?('[') && !type.include?(','))\n        []\n      elsif type == 'Set' || type&.start_with?('#<Set', 'Set')\n        Set.new\n      else\n        yield\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "declared_hash_attr", "signature": "def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)", "start_line": 52, "end_line": 88}, "metadata": {"module": "Grape", "class_name": "DeclaredParamsHandler", "class_signature": "class DeclaredParamsHandler"}, "task_id": 511}
{"function_name": "handle_passed_param", "file_path": "grape/lib/grape/declared_params_handler.rb", "focal_code": "def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)\n      return yield if has_passed_children\n\n      key = params_nested_path[0]\n      key += \"[#{params_nested_path[1..].join('][')}]\" if params_nested_path.size > 1\n\n      type = route_params.dig(key, :type)\n      has_children = route_params.keys.any? { |k| k != key && k.start_with?(\"#{key}[\") }\n\n      if type == 'Hash' && !has_children\n        {}\n      elsif type == 'Array' || (type&.start_with?('[') && !type.include?(','))\n        []\n      elsif type == 'Set' || type&.start_with?('#<Set', 'Set')\n        Set.new\n      else\n        yield\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class DeclaredParamsHandler\n    def initialize(include_missing: true, evaluate_given: false, stringify: false, contract_key_map: nil)\n      @include_missing = include_missing\n      @evaluate_given = evaluate_given\n      @stringify = stringify\n      @contract_key_map = contract_key_map\n    end\n\n    def call(passed_params, declared_params, route_params, renamed_params)\n      recursive_declared(\n        passed_params,\n        declared_params:,\n        route_params:,\n        renamed_params:\n      )\n    end\n\n    private\n\n    def recursive_declared(passed_params, declared_params:, route_params:, renamed_params:, params_nested_path: [])\n      res = if passed_params.is_a?(Array)\n              passed_params.map do |passed_param|\n                recursive_declared(passed_param, declared_params:, params_nested_path:, renamed_params:, route_params:)\n              end\n            else\n              declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n            end\n\n      @contract_key_map&.each { |key_map| key_map.write(passed_params, res) }\n\n      res\n    end\n\n    def declared_hash(passed_params, declared_params:, params_nested_path:, renamed_params:, route_params:)\n      declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|\n        next if @evaluate_given && !declared_param_attr.scope.attr_meets_dependency?(passed_params)\n\n        declared_hash_attr(\n          passed_params,\n          declared_param: declared_param_attr.key,\n          params_nested_path:,\n          memo:,\n          renamed_params:,\n          route_params:\n        )\n      end\n    end\n\n    def declared_hash_attr(passed_params, declared_param:, params_nested_path:, memo:, renamed_params:, route_params:)\n      if declared_param.is_a?(Hash)\n        declared_param.each_pair do |declared_parent_param, declared_children_params|\n          next unless @include_missing || passed_params.key?(declared_parent_param)\n\n          memo_key = build_memo_key(params_nested_path, declared_parent_param, renamed_params)\n          passed_children_params = passed_params[declared_parent_param] || passed_params.class.new\n\n          params_nested_path_dup = params_nested_path.dup\n          params_nested_path_dup << declared_parent_param.to_s\n\n          memo[memo_key] = handle_passed_param(params_nested_path_dup, route_params:, has_passed_children: passed_children_params.any?) do\n            recursive_declared(\n              passed_children_params,\n              declared_params: declared_children_params,\n              params_nested_path: params_nested_path_dup,\n              renamed_params:,\n              route_params:\n            )\n          end\n        end\n      else\n        # If it is not a Hash then it does not have children.\n        # Find its value or set it to nil.\n        return unless @include_missing || (passed_params.respond_to?(:key?) && passed_params.key?(declared_param))\n\n        memo_key = build_memo_key(params_nested_path, declared_param, renamed_params)\n        passed_param = passed_params[declared_param]\n\n        params_nested_path_dup = params_nested_path.dup\n        params_nested_path_dup << declared_param.to_s\n\n        memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup, route_params:) do\n          passed_param\n        end\n      end\n    end\n\n    def build_memo_key(params_nested_path, declared_param, renamed_params)\n      rename_path = params_nested_path + [declared_param.to_s]\n      renamed_param_name = renamed_params[rename_path]\n\n      param = renamed_param_name || declared_param\n      @stringify ? param.to_s : param.to_sym\n    end\n\n    def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)\n      return yield if has_passed_children\n\n      key = params_nested_path[0]\n      key += \"[#{params_nested_path[1..].join('][')}]\" if params_nested_path.size > 1\n\n      type = route_params.dig(key, :type)\n      has_children = route_params.keys.any? { |k| k != key && k.start_with?(\"#{key}[\") }\n\n      if type == 'Hash' && !has_children\n        {}\n      elsif type == 'Array' || (type&.start_with?('[') && !type.include?(','))\n        []\n      elsif type == 'Set' || type&.start_with?('#<Set', 'Set')\n        Set.new\n      else\n        yield\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "handle_passed_param", "signature": "def handle_passed_param(params_nested_path, route_params:, has_passed_children: false, &_block)", "start_line": 98, "end_line": 116}, "metadata": {"module": "Grape", "class_name": "DeclaredParamsHandler", "class_signature": "class DeclaredParamsHandler"}, "task_id": 512}
{"function_name": "collect_route_config_per_pattern", "file_path": "grape/lib/grape/api/instance.rb", "focal_code": "def collect_route_config_per_pattern(all_routes)\n        routes_by_regexp = all_routes.group_by(&:pattern_regexp)\n        namespace_inheritable = self.class.inheritable_setting.namespace_inheritable\n\n        # Build the configuration based on the first endpoint and the collection of methods supported.\n        routes_by_regexp.each_value do |routes|\n          next if routes.any? { |route| route.request_method == '*' }\n\n          last_route = routes.last # Most of the configuration is taken from the last endpoint\n          allowed_methods = routes.map(&:request_method)\n          allowed_methods |= [Rack::HEAD] if !namespace_inheritable[:do_not_route_head] && allowed_methods.include?(Rack::GET)\n\n          allow_header = namespace_inheritable[:do_not_route_options] ? allowed_methods : [Rack::OPTIONS] | allowed_methods\n          last_route.app.options[:options_route_enabled] = true unless namespace_inheritable[:do_not_route_options] || allowed_methods.include?(Rack::OPTIONS)\n\n          greedy_route = Grape::Router::GreedyRoute.new(last_route.pattern, endpoint: last_route.app, allow_header:)\n          @router.associate_routes(greedy_route)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class API\n    # The API Instance class, is the engine behind Grape::API. Each class that inherits\n    # from this will represent a different API instance\n    class Instance\n      extend Grape::DSL::Settings\n      extend Grape::DSL::Desc\n      extend Grape::DSL::Validations\n      extend Grape::DSL::Callbacks\n      extend Grape::DSL::Logger\n      extend Grape::DSL::Middleware\n      extend Grape::DSL::RequestResponse\n      extend Grape::DSL::Routing\n      extend Grape::DSL::Helpers\n      extend Grape::Middleware::Auth::DSL\n\n      Boolean = Grape::API::Boolean\n\n      class << self\n        extend Forwardable\n\n        attr_accessor :configuration\n\n        def_delegators :@base, :to_s\n\n        def base=(grape_api)\n          @base = grape_api\n          grape_api.instances << self\n        end\n\n        def base_instance?\n          self == @base.base_instance\n        end\n\n        # A class-level lock to ensure the API is not compiled by multiple\n        # threads simultaneously within the same process.\n        LOCK = Mutex.new\n\n        # Clears all defined routes, endpoints, etc., on this API.\n        def reset!\n          reset_endpoints!\n          reset_routes!\n          reset_validations!\n        end\n\n        # This is the interface point between Rack and Grape; it accepts a request\n        # from Rack and ultimately returns an array of three values: the status,\n        # the headers, and the body. See [the rack specification]\n        # (http://www.rubydoc.info/github/rack/rack/master/file/SPEC) for more.\n        def call(env)\n          compile!\n          @instance.call(env)\n        end\n\n        def compile!\n          return if @instance\n\n          LOCK.synchronize { @instance ||= new }\n        end\n\n        # see Grape::Router#recognize_path\n        def recognize_path(path)\n          compile!\n          @instance.router.recognize_path(path)\n        end\n\n        # Wipe the compiled API so we can recompile after changes were made.\n        def change!\n          @instance = nil\n        end\n\n        protected\n\n        def inherit_settings(other_settings)\n          top_level_setting.inherit_from other_settings.point_in_time_copy\n\n          # Propagate any inherited params down to our endpoints, and reset any\n          # compiled routes.\n          endpoints.each do |e|\n            e.inherit_settings(top_level_setting.namespace_stackable)\n            e.reset_routes!\n          end\n\n          reset_routes!\n        end\n\n        private\n\n        def inherited(subclass)\n          super\n          subclass.reset!\n          subclass.logger logger.clone\n        end\n      end\n\n      attr_reader :router\n\n      # Builds the routes from the defined endpoints, effectively compiling\n      # this API into a usable form.\n      def initialize\n        @router = Router.new\n        add_head_not_allowed_methods_and_options_methods\n        self.class.endpoints.each do |endpoint|\n          endpoint.mount_in(@router)\n        end\n\n        @router.compile!\n        @router.freeze\n      end\n\n      # Handle a request. See Rack documentation for what `env` is.\n      def call(env)\n        status, headers, response = @router.call(env)\n        unless cascade?\n          headers = Grape::Util::Header.new.merge(headers)\n          headers.delete('X-Cascade')\n        end\n\n        [status, headers, response]\n      end\n\n      # Some requests may return a HTTP 404 error if grape cannot find a matching\n      # route. In this case, Grape::Router adds a X-Cascade header to the response\n      # and sets it to 'pass', indicating to grape's parents they should keep\n      # looking for a matching route on other resources.\n      #\n      # In some applications (e.g. mounting grape on rails), one might need to trap\n      # errors from reaching upstream. This is effectivelly done by unsetting\n      # X-Cascade. Default :cascade is true.\n      def cascade?\n        namespace_inheritable = self.class.inheritable_setting.namespace_inheritable\n        return namespace_inheritable[:cascade] if namespace_inheritable.key?(:cascade)\n        return namespace_inheritable[:version_options][:cascade] if namespace_inheritable[:version_options]&.key?(:cascade)\n\n        true\n      end\n\n      reset!\n\n      private\n\n      # For every resource add a 'OPTIONS' route that returns an HTTP 204 response\n      # with a list of HTTP methods that can be called. Also add a route that\n      # will return an HTTP 405 response for any HTTP method that the resource\n      # cannot handle.\n      def add_head_not_allowed_methods_and_options_methods\n        # The paths we collected are prepared (cf. Path#prepare), so they\n        # contain already versioning information when using path versioning.\n        all_routes = self.class.endpoints.flat_map(&:routes)\n\n        # Disable versioning so adding a route won't prepend versioning\n        # informations again.\n        without_root_prefix_and_versioning { collect_route_config_per_pattern(all_routes) }\n      end\n\n      def collect_route_config_per_pattern(all_routes)\n        routes_by_regexp = all_routes.group_by(&:pattern_regexp)\n        namespace_inheritable = self.class.inheritable_setting.namespace_inheritable\n\n        # Build the configuration based on the first endpoint and the collection of methods supported.\n        routes_by_regexp.each_value do |routes|\n          next if routes.any? { |route| route.request_method == '*' }\n\n          last_route = routes.last # Most of the configuration is taken from the last endpoint\n          allowed_methods = routes.map(&:request_method)\n          allowed_methods |= [Rack::HEAD] if !namespace_inheritable[:do_not_route_head] && allowed_methods.include?(Rack::GET)\n\n          allow_header = namespace_inheritable[:do_not_route_options] ? allowed_methods : [Rack::OPTIONS] | allowed_methods\n          last_route.app.options[:options_route_enabled] = true unless namespace_inheritable[:do_not_route_options] || allowed_methods.include?(Rack::OPTIONS)\n\n          greedy_route = Grape::Router::GreedyRoute.new(last_route.pattern, endpoint: last_route.app, allow_header:)\n          @router.associate_routes(greedy_route)\n        end\n      end\n\n      ROOT_PREFIX_VERSIONING_KEY = %i[version version_options root_prefix].freeze\n      private_constant :ROOT_PREFIX_VERSIONING_KEY\n\n      # Allows definition of endpoints that ignore the versioning configuration\n      # used by the rest of your API.\n      def without_root_prefix_and_versioning\n        inheritable_setting = self.class.inheritable_setting\n        deleted_values = inheritable_setting.namespace_inheritable.delete(*ROOT_PREFIX_VERSIONING_KEY)\n        yield\n      ensure\n        ROOT_PREFIX_VERSIONING_KEY.each_with_index do |key, index|\n          inheritable_setting.namespace_inheritable[key] = deleted_values[index]\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "collect_route_config_per_pattern", "signature": "def collect_route_config_per_pattern(all_routes)", "start_line": 158, "end_line": 176}, "metadata": {"module": "Grape", "class_name": "API", "class_signature": "class API"}, "task_id": 513}
{"function_name": "wrap_message", "file_path": "grape/lib/grape/error_formatter/json.rb", "focal_code": "def wrap_message(message)\n          case message\n          when Hash\n            message\n          when Exceptions::ValidationErrors\n            message.as_json\n          else\n            { error: ensure_utf8(message) }\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module ErrorFormatter\n    class Json < Base\n      class << self\n        def format_structured_message(structured_message)\n          ::Grape::Json.dump(structured_message)\n        end\n\n        private\n\n        def wrap_message(message)\n          case message\n          when Hash\n            message\n          when Exceptions::ValidationErrors\n            message.as_json\n          else\n            { error: ensure_utf8(message) }\n          end\n        end\n\n        def ensure_utf8(message)\n          return message unless message.respond_to? :encode\n\n          message.encode('UTF-8', invalid: :replace, undef: :replace)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "wrap_message", "signature": "def wrap_message(message)", "start_line": 13, "end_line": 22}, "metadata": {"module": "Grape", "class_name": "Json", "class_signature": "class Json < < Base"}, "task_id": 514}
{"function_name": "call", "file_path": "grape/lib/grape/error_formatter/base.rb", "focal_code": "def call(message, backtrace, options = {}, env = nil, original_exception = nil)\n          merge_backtrace = backtrace.present? && options.dig(:rescue_options, :backtrace)\n          merge_original_exception = original_exception && options.dig(:rescue_options, :original_exception)\n\n          wrapped_message = wrap_message(present(message, env))\n          if wrapped_message.is_a?(Hash)\n            wrapped_message[:backtrace] = backtrace if merge_backtrace\n            wrapped_message[:original_exception] = original_exception.inspect if merge_original_exception\n          end\n\n          format_structured_message(wrapped_message)\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module ErrorFormatter\n    class Base\n      class << self\n        def call(message, backtrace, options = {}, env = nil, original_exception = nil)\n          merge_backtrace = backtrace.present? && options.dig(:rescue_options, :backtrace)\n          merge_original_exception = original_exception && options.dig(:rescue_options, :original_exception)\n\n          wrapped_message = wrap_message(present(message, env))\n          if wrapped_message.is_a?(Hash)\n            wrapped_message[:backtrace] = backtrace if merge_backtrace\n            wrapped_message[:original_exception] = original_exception.inspect if merge_original_exception\n          end\n\n          format_structured_message(wrapped_message)\n        end\n\n        def present(message, env)\n          # error! accepts a message hash with an optional :with key specifying the entity presenter.\n          # Extract it here so the presenter can be resolved and the key is not serialized in the response.\n          # See spec/integration/grape_entity/entity_spec.rb for examples.\n          with = nil\n          if message.is_a?(Hash) && message.key?(:with)\n            message = message.dup\n            with = message.delete(:with)\n          end\n\n          presenter = with || env[Grape::Env::API_ENDPOINT].entity_class_for_obj(message)\n\n          unless presenter || env[Grape::Env::GRAPE_ROUTING_ARGS].nil?\n            # env['api.endpoint'].route does not work when the error occurs within a middleware\n            # the Endpoint does not have a valid env at this moment\n            http_codes = env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info].http_codes || []\n            found_code = http_codes.find do |http_code|\n              (http_code[0].to_i == env[Grape::Env::API_ENDPOINT].status) && http_code[2].respond_to?(:represent)\n            end if env[Grape::Env::API_ENDPOINT].request\n\n            presenter = found_code[2] if found_code\n          end\n\n          return message unless presenter\n\n          embeds = { env: }\n          embeds[:version] = env[Grape::Env::API_VERSION] if env.key?(Grape::Env::API_VERSION)\n          presenter.represent(message, embeds).serializable_hash\n        end\n\n        def wrap_message(message)\n          return message if message.is_a?(Hash)\n\n          { message: }\n        end\n\n        def format_structured_message(_structured_message)\n          raise NotImplementedError\n        end\n\n        private\n\n        def inherited(klass)\n          super\n          ErrorFormatter.register(klass)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(message, backtrace, options = {}, env = nil, original_exception = nil)", "start_line": 7, "end_line": 18}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base"}, "task_id": 515}
{"function_name": "present", "file_path": "grape/lib/grape/error_formatter/base.rb", "focal_code": "def present(message, env)\n          # error! accepts a message hash with an optional :with key specifying the entity presenter.\n          # Extract it here so the presenter can be resolved and the key is not serialized in the response.\n          # See spec/integration/grape_entity/entity_spec.rb for examples.\n          with = nil\n          if message.is_a?(Hash) && message.key?(:with)\n            message = message.dup\n            with = message.delete(:with)\n          end\n\n          presenter = with || env[Grape::Env::API_ENDPOINT].entity_class_for_obj(message)\n\n          unless presenter || env[Grape::Env::GRAPE_ROUTING_ARGS].nil?\n            # env['api.endpoint'].route does not work when the error occurs within a middleware\n            # the Endpoint does not have a valid env at this moment\n            http_codes = env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info].http_codes || []\n            found_code = http_codes.find do |http_code|\n              (http_code[0].to_i == env[Grape::Env::API_ENDPOINT].status) && http_code[2].respond_to?(:represent)\n            end if env[Grape::Env::API_ENDPOINT].request\n\n            presenter = found_code[2] if found_code\n          end\n\n          return message unless presenter\n\n          embeds = { env: }\n          embeds[:version] = env[Grape::Env::API_VERSION] if env.key?(Grape::Env::API_VERSION)\n          presenter.represent(message, embeds).serializable_hash\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module ErrorFormatter\n    class Base\n      class << self\n        def call(message, backtrace, options = {}, env = nil, original_exception = nil)\n          merge_backtrace = backtrace.present? && options.dig(:rescue_options, :backtrace)\n          merge_original_exception = original_exception && options.dig(:rescue_options, :original_exception)\n\n          wrapped_message = wrap_message(present(message, env))\n          if wrapped_message.is_a?(Hash)\n            wrapped_message[:backtrace] = backtrace if merge_backtrace\n            wrapped_message[:original_exception] = original_exception.inspect if merge_original_exception\n          end\n\n          format_structured_message(wrapped_message)\n        end\n\n        def present(message, env)\n          # error! accepts a message hash with an optional :with key specifying the entity presenter.\n          # Extract it here so the presenter can be resolved and the key is not serialized in the response.\n          # See spec/integration/grape_entity/entity_spec.rb for examples.\n          with = nil\n          if message.is_a?(Hash) && message.key?(:with)\n            message = message.dup\n            with = message.delete(:with)\n          end\n\n          presenter = with || env[Grape::Env::API_ENDPOINT].entity_class_for_obj(message)\n\n          unless presenter || env[Grape::Env::GRAPE_ROUTING_ARGS].nil?\n            # env['api.endpoint'].route does not work when the error occurs within a middleware\n            # the Endpoint does not have a valid env at this moment\n            http_codes = env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info].http_codes || []\n            found_code = http_codes.find do |http_code|\n              (http_code[0].to_i == env[Grape::Env::API_ENDPOINT].status) && http_code[2].respond_to?(:represent)\n            end if env[Grape::Env::API_ENDPOINT].request\n\n            presenter = found_code[2] if found_code\n          end\n\n          return message unless presenter\n\n          embeds = { env: }\n          embeds[:version] = env[Grape::Env::API_VERSION] if env.key?(Grape::Env::API_VERSION)\n          presenter.represent(message, embeds).serializable_hash\n        end\n\n        def wrap_message(message)\n          return message if message.is_a?(Hash)\n\n          { message: }\n        end\n\n        def format_structured_message(_structured_message)\n          raise NotImplementedError\n        end\n\n        private\n\n        def inherited(klass)\n          super\n          ErrorFormatter.register(klass)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "present", "signature": "def present(message, env)", "start_line": 20, "end_line": 48}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base"}, "task_id": 516}
{"function_name": "format_structured_message", "file_path": "grape/lib/grape/error_formatter/txt.rb", "focal_code": "def self.format_structured_message(structured_message)\n        message = structured_message[:message] || Grape::Json.dump(structured_message)\n        Array.wrap(message).tap do |final_message|\n          if structured_message.key?(:backtrace)\n            final_message << 'backtrace:'\n            final_message.concat(structured_message[:backtrace])\n          end\n          if structured_message.key?(:original_exception)\n            final_message << 'original exception:'\n            final_message << structured_message[:original_exception]\n          end\n        end.join(\"\\r\\n \")\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module ErrorFormatter\n    class Txt < Base\n      def self.format_structured_message(structured_message)\n        message = structured_message[:message] || Grape::Json.dump(structured_message)\n        Array.wrap(message).tap do |final_message|\n          if structured_message.key?(:backtrace)\n            final_message << 'backtrace:'\n            final_message.concat(structured_message[:backtrace])\n          end\n          if structured_message.key?(:original_exception)\n            final_message << 'original exception:'\n            final_message << structured_message[:original_exception]\n          end\n        end.join(\"\\r\\n \")\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "format_structured_message", "signature": "def self.format_structured_message(structured_message)", "start_line": 6, "end_line": 18}, "metadata": {"module": "Grape", "class_name": "Txt", "class_signature": "class Txt < < Base"}, "task_id": 517}
{"function_name": "extract_details", "file_path": "grape/lib/grape/validations/params_documentation.rb", "focal_code": "def extract_details(validations, type, values, except_values)\n        {}.tap do |details|\n          details[:required] = validations.key?(:presence)\n          details[:type] = TypeCache[type] if type\n          details[:values] = values if values\n          details[:except_values] = except_values if except_values\n          details[:default] = validations[:default] if validations.key?(:default)\n          if validations.key?(:length)\n            details[:min_length] = validations[:length][:min] if validations[:length].key?(:min)\n            details[:max_length] = validations[:length][:max] if validations[:length].key?(:max)\n          end\n\n          desc = validations.delete(:desc) || validations.delete(:description)\n          details[:desc] = desc if desc\n\n          documentation = validations.delete(:documentation)\n          details[:documentation] = documentation if documentation\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    # Documents parameters of an endpoint. If documentation isn't needed (for instance, it is an\n    # internal API), the class only cleans up attributes to avoid junk in RAM.\n\n    module ParamsDocumentation\n      def document_params(attrs, validations, type = nil, values = nil, except_values = nil)\n        return validations.except!(:desc, :description, :documentation) if @api.inheritable_setting.namespace_inheritable[:do_not_document]\n\n        documented_attrs = attrs.to_h do |name|\n          [full_name(name), extract_details(validations, type, values, except_values)]\n        end\n        @api.inheritable_setting.namespace_stackable[:params] = documented_attrs\n      end\n\n      private\n\n      def extract_details(validations, type, values, except_values)\n        {}.tap do |details|\n          details[:required] = validations.key?(:presence)\n          details[:type] = TypeCache[type] if type\n          details[:values] = values if values\n          details[:except_values] = except_values if except_values\n          details[:default] = validations[:default] if validations.key?(:default)\n          if validations.key?(:length)\n            details[:min_length] = validations[:length][:min] if validations[:length].key?(:min)\n            details[:max_length] = validations[:length][:max] if validations[:length].key?(:max)\n          end\n\n          desc = validations.delete(:desc) || validations.delete(:description)\n          details[:desc] = desc if desc\n\n          documentation = validations.delete(:documentation)\n          details[:documentation] = documentation if documentation\n        end\n      end\n\n      class TypeCache < Grape::Util::Cache\n        def initialize\n          super\n          @cache = Hash.new do |h, type|\n            h[type] = type.to_s\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "extract_details", "signature": "def extract_details(validations, type, values, except_values)", "start_line": 20, "end_line": 38}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 518}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/contract_scope.rb", "focal_code": "def initialize(api, contract = nil, &block)\n        # When block is passed, the first arg is either schema or nil.\n        contract = Dry::Schema.Params(parent: contract, &block) if block\n\n        if contract.respond_to?(:schema)\n          # It's a Dry::Validation::Contract, then.\n          contract = contract.new\n          key_map = contract.schema.key_map\n        else\n          # Dry::Schema::Processor, hopefully.\n          key_map = contract.key_map\n        end\n\n        api.inheritable_setting.namespace_stackable[:contract_key_map] = key_map\n        api.inheritable_setting.namespace_stackable[:validations] = Validators::ContractScopeValidator.new(schema: contract)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ContractScope\n      # Declare the contract to be used for the endpoint's parameters.\n      # @param api [API] the API endpoint to modify.\n      # @param contract the contract or schema to be used for validation. Optional.\n      # @yield a block yielding a new schema class. Optional.\n      def initialize(api, contract = nil, &block)\n        # When block is passed, the first arg is either schema or nil.\n        contract = Dry::Schema.Params(parent: contract, &block) if block\n\n        if contract.respond_to?(:schema)\n          # It's a Dry::Validation::Contract, then.\n          contract = contract.new\n          key_map = contract.schema.key_map\n        else\n          # Dry::Schema::Processor, hopefully.\n          key_map = contract.key_map\n        end\n\n        api.inheritable_setting.namespace_stackable[:contract_key_map] = key_map\n        api.inheritable_setting.namespace_stackable[:validations] = Validators::ContractScopeValidator.new(schema: contract)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(api, contract = nil, &block)", "start_line": 10, "end_line": 25}, "metadata": {"module": "Grape", "class_name": "ContractScope", "class_signature": "class ContractScope"}, "task_id": 519}
{"function_name": "attr_key", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "attr_key", "signature": "def self.attr_key(declared_param_attr)", "start_line": 40, "end_line": 49}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 520}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)", "start_line": 67, "end_line": 87}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 521}
{"function_name": "meets_dependency?", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "meets_dependency?", "signature": "def meets_dependency?(params, request_params)", "start_line": 106, "end_line": 117}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 522}
{"function_name": "meets_hash_dependency?", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "meets_hash_dependency?", "signature": "def meets_hash_dependency?(params)", "start_line": 126, "end_line": 138}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 523}
{"function_name": "full_name", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "full_name", "signature": "def full_name(name, index: nil)", "start_line": 141, "end_line": 155}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 524}
{"function_name": "require_required_and_optional_fields", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "require_required_and_optional_fields", "signature": "def require_required_and_optional_fields(context, using:, except: nil)", "start_line": 223, "end_line": 244}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 525}
{"function_name": "require_optional_fields", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "require_optional_fields", "signature": "def require_optional_fields(context, using:, except: nil)", "start_line": 246, "end_line": 256}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 526}
{"function_name": "new_scope", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "new_scope", "signature": "def new_scope(element, type:, as:, optional: false, &)", "start_line": 271, "end_line": 288}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 527}
{"function_name": "new_lateral_scope", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "new_lateral_scope", "signature": "def new_lateral_scope(dependent_on:, &)", "start_line": 295, "end_line": 304}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 528}
{"function_name": "configure_declared_params", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "configure_declared_params", "signature": "def configure_declared_params push_renamed_param(full_path, @element_renamed) if @element_renamed", "start_line": 318, "end_line": 328}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 529}
{"function_name": "validates", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validates", "signature": "def validates(attrs, validations)", "start_line": 336, "end_line": 372}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 530}
{"function_name": "infer_coercion", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "infer_coercion", "signature": "def infer_coercion(validations)", "start_line": 387, "end_line": 410}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 531}
{"function_name": "coerce_type", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "coerce_type", "signature": "def coerce_type(validations, attrs, required, opts)", "start_line": 434, "end_line": 450}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 532}
{"function_name": "validate", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate", "signature": "def validate(type, options, attrs, required, opts)", "start_line": 472, "end_line": 482}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 533}
{"function_name": "validate_value_coercion", "file_path": "grape/lib/grape/validations/params_scope.rb", "focal_code": "def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class ParamsScope\n      attr_reader :parent, :type, :nearest_array_ancestor, :full_path\n\n      def qualifying_params\n        ParamScopeTracker.current&.qualifying_params(self)\n      end\n\n      include Grape::DSL::Parameters\n      include Grape::Validations::ParamsDocumentation\n\n      # There are a number of documentation options on entities that don't have\n      # corresponding validators. Since there is nowhere that enumerates them all,\n      # we maintain a list of them here and skip looking up validators for them.\n      RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze\n\n      SPECIAL_JSON = [JSON, Array[JSON]].freeze\n\n      class Attr\n        attr_reader :key, :scope\n\n        # Open up a new ParamsScope::Attr\n        # @param key [Hash, Symbol] key of attr\n        # @param scope [Grape::Validations::ParamsScope] scope of attr\n        def initialize(key, scope)\n          @key = key\n          @scope = scope\n        end\n\n        # @return Array[Symbol, Hash[Symbol => Array]] declared_params with symbol instead of Attr\n        def self.attrs_keys(declared_params)\n          declared_params.map do |declared_param_attr|\n            attr_key(declared_param_attr)\n          end\n        end\n\n        def self.attr_key(declared_param_attr)\n          case declared_param_attr\n          when self\n            attr_key(declared_param_attr.key)\n          when Hash\n            declared_param_attr.transform_values { |value| attrs_keys(value) }\n          else\n            declared_param_attr\n          end\n        end\n      end\n\n      # Open up a new ParamsScope, allowing parameter definitions per\n      #   Grape::DSL::Params.\n      # @param api [API] the API endpoint to modify\n      # @param element [Symbol] the element that contains this scope; for\n      #   this to be relevant, parent must be set\n      # @param element_renamed [Symbol, nil] whenever this scope should\n      #   be renamed and to what, given +nil+ no renaming is done\n      # @param parent [ParamsScope] the scope containing this scope\n      # @param optional [Boolean] whether or not this scope needs to have\n      #   any parameters set or not\n      # @param type [Class] a type meant to govern this scope (deprecated)\n      # @param type [Hash] group options for this scope\n      # @param dependent_on [Symbol] if present, this scope should only\n      #   validate if this param is present in the parent scope\n      # @yield the instance context, open for parameter definitions\n      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)\n        @element          = element\n        @element_renamed  = element_renamed\n        @parent           = parent\n        @api              = api\n        @optional         = optional\n        @type             = type\n        @group            = group\n        @dependent_on     = dependent_on\n        # Must be an ivar: push_declared_params is dispatched on self during\n        # instance_eval, so local variables from initialize are unreachable.\n        # configure_declared_params consumes it and clears @declared_params to nil.\n        @declared_params = []\n        @full_path = build_full_path\n\n        instance_eval(&block) if block\n\n        configure_declared_params\n        @nearest_array_ancestor = find_nearest_array_ancestor\n        freeze\n      end\n\n      def configuration\n        config = @api.configuration\n        config.is_a?(Grape::Util::Lazy::Base) ? config.evaluate : config\n      end\n\n      # @return [Boolean] whether or not this entire scope needs to be\n      #   validated\n      def should_validate?(parameters)\n        scoped_params = params(parameters)\n\n        return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))\n        return false unless meets_dependency?(scoped_params, parameters)\n        return true if @parent.nil?\n\n        @parent.should_validate?(parameters)\n      end\n\n      def meets_dependency?(params, request_params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)\n\n        if params.is_a?(Array)\n          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }\n          ParamScopeTracker.current&.store_qualifying_params(self, filtered)\n          return filtered.present?\n        end\n\n        meets_hash_dependency?(params)\n      end\n\n      def attr_meets_dependency?(params)\n        return true unless @dependent_on\n        return false if @parent.present? && !@parent.attr_meets_dependency?(params)\n\n        meets_hash_dependency?(params)\n      end\n\n      def meets_hash_dependency?(params)\n        # params might be anything what looks like a hash, so it must implement a `key?` method\n        return false unless params.respond_to?(:key?)\n\n        @dependent_on.all? do |dependency|\n          if dependency.is_a?(Hash)\n            key, callable = dependency.first\n            callable.call(params[key])\n          else\n            params[dependency].present?\n          end\n        end\n      end\n\n      # @return [String] the proper attribute name, with nesting considered.\n      def full_name(name, index: nil)\n        tracker = ParamScopeTracker.current\n        if nested?\n          # Find our containing element's name, and append ours.\n          resolved_index = index || tracker&.index_for(self)\n          \"#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}\"\n        elsif lateral?\n          # Find the name of the element as if it was at the same nesting level\n          # as our parent. We need to forward our index upward to achieve this.\n          @parent.full_name(name, index: tracker&.index_for(self))\n        else\n          # We must be the root scope, so no prefix needed.\n          name.to_s\n        end\n      end\n\n      def brackets(val)\n        \"[#{val}]\" if val\n      end\n\n      # @return [Boolean] whether or not this scope is the root-level scope\n      def root?\n        !@parent\n      end\n\n      # A nested scope is contained in one of its parent's elements.\n      # @return [Boolean] whether or not this scope is nested\n      def nested?\n        @parent && @element\n      end\n\n      # A lateral scope is subordinate to its parent, but its keys are at the\n      # same level as its parent and thus is not contained within an element.\n      # @return [Boolean] whether or not this scope is lateral\n      def lateral?\n        @parent && !@element\n      end\n\n      # @return [Boolean] whether or not this scope needs to be present, or can\n      #   be blank\n      def required?\n        !@optional\n      end\n\n      protected\n\n      # Adds a parameter declaration to our list of validations.\n      # @param attrs [Array] (see Grape::DSL::Parameters#requires)\n      def push_declared_params(attrs, **opts)\n        opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)\n        return @parent.push_declared_params(attrs, **opts) if lateral?\n\n        push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]\n        @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })\n      end\n\n      private\n\n      def build_full_path\n        if nested?\n          @parent.full_path + [@element]\n        elsif lateral?\n          @parent.full_path\n        else\n          []\n        end\n      end\n\n      # Add a new parameter which should be renamed when using the +#declared+\n      # method.\n      #\n      # @param path [Array<String, Symbol>] the full path of the parameter\n      #   (including the parameter name as last array element)\n      # @param new_name [String, Symbol] the new name of the parameter (the\n      #   renamed name, with the +as: ...+ semantic)\n      def push_renamed_param(path, new_name)\n        api_route_setting = @api.inheritable_setting.route\n        base = api_route_setting[:renamed_params] || {}\n        base[Array(path).map(&:to_s)] = new_name.to_s\n        api_route_setting[:renamed_params] = base\n      end\n\n      def require_required_and_optional_fields(context, using:, except: nil)\n        except_fields = Array.wrap(except)\n        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }\n\n        if context == :all\n          optional_fields = except_fields\n          required_fields = using_fields\n        else # context == :none\n          required_fields = except_fields\n          optional_fields = using_fields\n        end\n        required_fields.each do |field|\n          field_opts = using[field]\n          raise ArgumentError, \"required field not exist: #{field}\" unless field_opts\n\n          requires(field, **field_opts)\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def require_optional_fields(context, using:, except: nil)\n        optional_fields = using.keys\n        unless context == :all\n          except_fields = Array.wrap(except)\n          optional_fields.delete_if { |f| except_fields.include?(f) }\n        end\n        optional_fields.each do |field|\n          field_opts = using[field]\n          optional(field, **field_opts) if field_opts\n        end\n      end\n\n      def validate_attributes(attrs, **opts, &block)\n        opts[:type] ||= Array if block\n        validates(attrs, opts)\n      end\n\n      # Returns a new parameter scope, subordinate to the current one and nested\n      # under the given element.\n      # @param element [Symbol] the parameter name under which this scope is nested\n      # @param type [Class] the type governing this scope\n      # @param as [Symbol, nil] optional renamed name for the element\n      # @param optional [Boolean] whether the parameter this scope is nested under\n      #   is optional or not (and hence, whether this block's params will be).\n      # @yield parameter scope\n      def new_scope(element, type:, as:, optional: false, &)\n        # if required params are grouped and no type or unsupported type is provided, raise an error\n        if element && !optional\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        self.class.new(\n          api: @api,\n          element:,\n          element_renamed: as,\n          parent: self,\n          optional:,\n          type: type || Array,\n          group: @group,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, not nested under any current-level param\n      # but instead at the same level as the current scope.\n      # @param dependent_on [Symbol] if given, specifies that this scope should\n      #   only validate if this parameter from the above scope is present\n      # @yield parameter scope\n      def new_lateral_scope(dependent_on:, &)\n        self.class.new(\n          api: @api,\n          parent: self,\n          optional: @optional,\n          type: type == Array ? Array : Hash,\n          dependent_on:,\n          &\n        )\n      end\n\n      # Returns a new parameter scope, subordinate to the current one, sharing\n      # the given group options with all parameters defined within.\n      # @param group [Hash] common options to merge into each parameter in the scope\n      # @yield parameter scope\n      def new_group_scope(group, &)\n        self.class.new(api: @api, parent: self, group:, &)\n      end\n\n      # Pushes declared params to parent or settings, then clears @declared_params.\n      # Clearing here (rather than in initialize) keeps the lifecycle ownership in\n      # one place: this method both consumes and invalidates the ivar so that\n      # push_declared_params cannot be called on the frozen scope later.\n      def configure_declared_params\n        push_renamed_param(full_path, @element_renamed) if @element_renamed\n\n        if nested?\n          @parent.push_declared_params [{ @element => @declared_params }]\n        else\n          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params\n        end\n      ensure\n        @declared_params = nil\n      end\n\n      def find_nearest_array_ancestor\n        scope = @parent\n        scope = scope.parent while scope && scope.type != Array\n        scope\n      end\n\n      def validates(attrs, validations)\n        coerce_type = infer_coercion(validations)\n        required = validations.key?(:presence)\n        default = validations[:default]\n        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]\n        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]\n\n        # NB. values and excepts should be nil, Proc, Array, or Range.\n        # Specifically, values should NOT be a Hash\n        # use values or excepts to guess coerce type when stated type is Array\n        coerce_type = guess_coerce_type(coerce_type, values, except_values)\n\n        # default value should be present in values array, if both exist and are not procs\n        check_incompatible_option_values(default, values, except_values)\n\n        # type should be compatible with values array, if both exist\n        validate_value_coercion(coerce_type, values, except_values)\n\n        document_params attrs, validations, coerce_type, values, except_values\n\n        opts = derive_validator_options(validations).freeze\n\n        # Validate for presence before any other validators\n        validates_presence(validations, attrs, opts)\n\n        # Before we run the rest of the validators, let's handle\n        # whatever coercion so that we are working with correctly\n        # type casted values\n        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts\n\n        validations.each do |type, options|\n          # Don't try to look up validators for documentation params that don't have one.\n          next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)\n\n          validate(type, options, attrs, required, opts)\n        end\n      end\n\n      # Validate and comprehend the +:type+, +:types+, and +:coerce_with+\n      # options that have been supplied to the parameter declaration.\n      # The +:type+ and +:types+ options will be removed from the\n      # validations list, replaced appropriately with +:coerce+ and\n      # +:coerce_with+ options that will later be passed to\n      # {Validators::CoerceValidator}. The type that is returned may be\n      # used for documentation and further validation of parameter\n      # options.\n      #\n      # @param validations [Hash] list of validations supplied to the\n      #   parameter declaration\n      # @return [class-like] type to which the parameter will be coerced\n      # @raise [ArgumentError] if the given type options are invalid\n      def infer_coercion(validations)\n        raise ArgumentError, ':type may not be supplied with :types' if validations.key?(:type) && validations.key?(:types)\n\n        validations[:coerce] = (options_key?(:type, :value, validations) ? validations[:type][:value] : validations[:type]) if validations.key?(:type)\n        validations[:coerce_message] = (options_key?(:type, :message, validations) ? validations[:type][:message] : nil) if validations.key?(:type)\n        validations[:coerce] = (options_key?(:types, :value, validations) ? validations[:types][:value] : validations[:types]) if validations.key?(:types)\n        validations[:coerce_message] = (options_key?(:types, :message, validations) ? validations[:types][:message] : nil) if validations.key?(:types)\n\n        validations.delete(:types) if validations.key?(:types)\n\n        coerce_type = validations[:coerce]\n\n        # Special case - when the argument is a single type that is a\n        # variant-type collection.\n        if Types.multiple?(coerce_type) && validations.key?(:type)\n          validations[:coerce] = Types::VariantCollectionCoercer.new(\n            coerce_type,\n            validations.delete(:coerce_with)\n          )\n        end\n        validations.delete(:type)\n\n        coerce_type\n      end\n\n      # Enforce correct usage of :coerce_with parameter.\n      # We do not allow coercion without a type, nor with\n      # +JSON+ as a type since this defines its own coercion\n      # method.\n      def check_coerce_with(validations)\n        return unless validations.key?(:coerce_with)\n        # type must be supplied for coerce_with..\n        raise ArgumentError, 'must supply type for coerce_with' unless validations.key?(:coerce)\n\n        # but not special JSON types, which\n        # already imply coercion method\n        return unless SPECIAL_JSON.include?(validations[:coerce])\n\n        raise ArgumentError, 'coerce_with disallowed for type: JSON'\n      end\n\n      # Add type coercion validation to this scope,\n      # if any has been specified.\n      # This validation has special handling since it is\n      # composited from more than one +requires+/+optional+\n      # parameter, and needs to be run before most other\n      # validations.\n      def coerce_type(validations, attrs, required, opts)\n        check_coerce_with(validations)\n\n        # Falsy check (not key?) is intentional: when a remountable API is first\n        # evaluated on its base instance (no configuration supplied yet),\n        # configuration[:some_type] evaluates to nil. Skipping instantiation\n        # here is correct — the real mounted instance will replay this step with\n        # the actual type value.\n        return unless validations[:coerce]\n\n        coerce_options = {\n          type: validations[:coerce],\n          method: validations[:coerce_with],\n          message: validations[:coerce_message]\n        }\n        validate('coerce', coerce_options, attrs, required, opts)\n      end\n\n      def guess_coerce_type(coerce_type, *values_list)\n        return coerce_type unless coerce_type == Array\n\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n          return values.first.class if values.is_a?(Range) || !values.empty?\n        end\n        coerce_type\n      end\n\n      def check_incompatible_option_values(default, values, except_values)\n        return unless default && !default.is_a?(Proc)\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }\n\n        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }\n\n        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)\n      end\n\n      def validate(type, options, attrs, required, opts)\n        validator_class = Validations.require_validator(type)\n        validator_instance = validator_class.new(\n          attrs,\n          options,\n          required,\n          self,\n          opts\n        )\n        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance\n      end\n\n      def validate_value_coercion(coerce_type, *values_list)\n        return unless coerce_type\n\n        coerce_type = coerce_type.first if coerce_type.is_a?(Enumerable)\n        values_list.each do |values|\n          next if !values || values.is_a?(Proc)\n\n          value_types = values.is_a?(Range) ? [values.begin, values.end].compact : values\n          value_types = value_types.map { |type| Grape::API::Boolean.build(type) } if coerce_type == Grape::API::Boolean\n          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values) unless value_types.all?(coerce_type)\n        end\n      end\n\n      def options_key?(type, key, validations)\n        validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?\n      end\n\n      def all_element_blank?(scoped_params)\n        scoped_params.respond_to?(:all?) && scoped_params.all?(&:blank?)\n      end\n\n      # Validators don't have access to each other and they don't need, however,\n      # some validators might influence others, so their options should be shared\n      def derive_validator_options(validations)\n        allow_blank = validations[:allow_blank]\n\n        {\n          allow_blank: allow_blank.is_a?(Hash) ? allow_blank[:value] : allow_blank,\n          fail_fast: validations.delete(:fail_fast) || false\n        }\n      end\n\n      def validates_presence(validations, attrs, opts)\n        return unless validations.key?(:presence) && validations[:presence]\n\n        validate('presence', validations.delete(:presence), attrs, true, opts)\n        validations.delete(:message) if validations.key?(:message)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate_value_coercion", "signature": "def validate_value_coercion(coerce_type, *values_list)", "start_line": 484, "end_line": 495}, "metadata": {"module": "Grape", "class_name": "ParamsScope", "class_signature": "class ParamsScope"}, "task_id": 534}
{"function_name": "do_each", "file_path": "grape/lib/grape/validations/attributes_iterator.rb", "focal_code": "def do_each(params_to_process, parent_indices = [], &block)\n        params_to_process.each_with_index do |resource_params, index|\n          # when we get arrays of arrays it means that target element located inside array\n          # we need this because we want to know parent arrays indices\n          if resource_params.is_a?(Array)\n            do_each(resource_params, [index] + parent_indices, &block)\n            next\n          end\n\n          if @scope.type == Array\n            next unless @original_params.is_a?(Array) # do not validate content of array if it isn't array\n\n            store_indices(@scope, index, parent_indices)\n          elsif @original_params.is_a?(Array)\n            # Lateral scope (no @element) whose params resolved to an array —\n            # delegate index tracking to the nearest array-typed ancestor so\n            # that full_name produces the correct bracketed index.\n            target = @scope.nearest_array_ancestor\n            store_indices(target, index, parent_indices) if target\n          end\n\n          yield_attributes(resource_params, &block)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class AttributesIterator\n      include Enumerable\n\n      attr_reader :scope\n\n      def initialize(attrs, scope, params)\n        @attrs = attrs\n        @scope = scope\n        @original_params = scope.params(params)\n        @params = Array.wrap(@original_params)\n      end\n\n      def each(&)\n        do_each(@params, &) # because we need recursion for nested arrays\n      end\n\n      private\n\n      def do_each(params_to_process, parent_indices = [], &block)\n        params_to_process.each_with_index do |resource_params, index|\n          # when we get arrays of arrays it means that target element located inside array\n          # we need this because we want to know parent arrays indices\n          if resource_params.is_a?(Array)\n            do_each(resource_params, [index] + parent_indices, &block)\n            next\n          end\n\n          if @scope.type == Array\n            next unless @original_params.is_a?(Array) # do not validate content of array if it isn't array\n\n            store_indices(@scope, index, parent_indices)\n          elsif @original_params.is_a?(Array)\n            # Lateral scope (no @element) whose params resolved to an array —\n            # delegate index tracking to the nearest array-typed ancestor so\n            # that full_name produces the correct bracketed index.\n            target = @scope.nearest_array_ancestor\n            store_indices(target, index, parent_indices) if target\n          end\n\n          yield_attributes(resource_params, &block)\n        end\n      end\n\n      def store_indices(target_scope, index, parent_indices)\n        # No tracker means we're outside a ParamScopeTracker.track block (e.g.\n        # a unit test that invokes a validator directly). Index tracking is\n        # skipped — full_name will produce bracket-less names — but validation\n        # continues rather than crashing.\n        tracker = ParamScopeTracker.current or return\n        parent_scope = target_scope.parent\n        parent_indices.each do |parent_index|\n          break unless parent_scope\n\n          tracker.store_index(parent_scope, parent_index)\n          parent_scope = parent_scope.parent\n        end\n        tracker.store_index(target_scope, index)\n      end\n\n      def yield_attributes(_resource_params)\n        raise NotImplementedError\n      end\n\n      # This is a special case so that we can ignore trees where option\n      # values are missing lower down. Unfortunately we can't remove this\n      # at the parameter parsing stage as they are required to ensure\n      # the correct indexing is maintained\n      def skip?(val)\n        val == Grape::DSL::Parameters::EmptyOptionalValue\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "do_each", "signature": "def do_each(params_to_process, parent_indices = [], &block)", "start_line": 23, "end_line": 46}, "metadata": {"module": "Grape", "class_name": "AttributesIterator", "class_signature": "class AttributesIterator"}, "task_id": 535}
{"function_name": "store_indices", "file_path": "grape/lib/grape/validations/attributes_iterator.rb", "focal_code": "def store_indices(target_scope, index, parent_indices)\n        # No tracker means we're outside a ParamScopeTracker.track block (e.g.\n        # a unit test that invokes a validator directly). Index tracking is\n        # skipped — full_name will produce bracket-less names — but validation\n        # continues rather than crashing.\n        tracker = ParamScopeTracker.current or return\n        parent_scope = target_scope.parent\n        parent_indices.each do |parent_index|\n          break unless parent_scope\n\n          tracker.store_index(parent_scope, parent_index)\n          parent_scope = parent_scope.parent\n        end\n        tracker.store_index(target_scope, index)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    class AttributesIterator\n      include Enumerable\n\n      attr_reader :scope\n\n      def initialize(attrs, scope, params)\n        @attrs = attrs\n        @scope = scope\n        @original_params = scope.params(params)\n        @params = Array.wrap(@original_params)\n      end\n\n      def each(&)\n        do_each(@params, &) # because we need recursion for nested arrays\n      end\n\n      private\n\n      def do_each(params_to_process, parent_indices = [], &block)\n        params_to_process.each_with_index do |resource_params, index|\n          # when we get arrays of arrays it means that target element located inside array\n          # we need this because we want to know parent arrays indices\n          if resource_params.is_a?(Array)\n            do_each(resource_params, [index] + parent_indices, &block)\n            next\n          end\n\n          if @scope.type == Array\n            next unless @original_params.is_a?(Array) # do not validate content of array if it isn't array\n\n            store_indices(@scope, index, parent_indices)\n          elsif @original_params.is_a?(Array)\n            # Lateral scope (no @element) whose params resolved to an array —\n            # delegate index tracking to the nearest array-typed ancestor so\n            # that full_name produces the correct bracketed index.\n            target = @scope.nearest_array_ancestor\n            store_indices(target, index, parent_indices) if target\n          end\n\n          yield_attributes(resource_params, &block)\n        end\n      end\n\n      def store_indices(target_scope, index, parent_indices)\n        # No tracker means we're outside a ParamScopeTracker.track block (e.g.\n        # a unit test that invokes a validator directly). Index tracking is\n        # skipped — full_name will produce bracket-less names — but validation\n        # continues rather than crashing.\n        tracker = ParamScopeTracker.current or return\n        parent_scope = target_scope.parent\n        parent_indices.each do |parent_index|\n          break unless parent_scope\n\n          tracker.store_index(parent_scope, parent_index)\n          parent_scope = parent_scope.parent\n        end\n        tracker.store_index(target_scope, index)\n      end\n\n      def yield_attributes(_resource_params)\n        raise NotImplementedError\n      end\n\n      # This is a special case so that we can ignore trees where option\n      # values are missing lower down. Unfortunately we can't remove this\n      # at the parameter parsing stage as they are required to ensure\n      # the correct indexing is maintained\n      def skip?(val)\n        val == Grape::DSL::Parameters::EmptyOptionalValue\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "store_indices", "signature": "def store_indices(target_scope, index, parent_indices)", "start_line": 48, "end_line": 62}, "metadata": {"module": "Grape", "class_name": "AttributesIterator", "class_signature": "class AttributesIterator"}, "task_id": 536}
{"function_name": "merge_with", "file_path": "grape/lib/grape/middleware/stack.rb", "focal_code": "def merge_with(middleware_specs)\n        middleware_specs.each do |operation, klass, *args|\n          if args.last.is_a?(Proc)\n            last_proc = args.pop\n            public_send(operation, klass, *args, &last_proc)\n          else\n            public_send(operation, klass, *args)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    # Class to handle the stack of middlewares based on ActionDispatch::MiddlewareStack\n    # It allows to insert and insert after\n    class Stack\n      extend Forwardable\n\n      class Middleware\n        attr_reader :args, :block, :klass\n\n        def initialize(klass, args, block)\n          @klass = klass\n          @args = args\n          @block = block\n        end\n\n        def name\n          klass.name\n        end\n\n        def ==(other)\n          case other\n          when Middleware\n            klass == other.klass\n          when Class\n            klass == other || (name.nil? && klass.superclass == other)\n          end\n        end\n\n        def inspect\n          klass.to_s\n        end\n\n        def build(builder)\n          # we need to force the ruby2_keywords_hash for middlewares that initialize contains keywords\n          # like ActionDispatch::RequestId since middleware arguments are serialized\n          # https://rubyapi.org/3.4/o/hash#method-c-ruby2_keywords_hash\n          args[-1] = Hash.ruby2_keywords_hash(args[-1]) if args.last.is_a?(Hash) && Hash.respond_to?(:ruby2_keywords_hash)\n          builder.use(klass, *args, &block)\n        end\n      end\n\n      include Enumerable\n\n      attr_accessor :middlewares, :others\n\n      def_delegators :middlewares, :each, :size, :last, :[]\n\n      def initialize\n        @middlewares = []\n        @others = []\n      end\n\n      def insert(index, klass, *args, &block)\n        index = assert_index(index, :before)\n        middlewares.insert(index, self.class::Middleware.new(klass, args, block))\n      end\n\n      alias insert_before insert\n\n      def insert_after(index, ...)\n        index = assert_index(index, :after)\n        insert(index + 1, ...)\n      end\n\n      def use(klass, *args, &block)\n        middleware = self.class::Middleware.new(klass, args, block)\n        middlewares.push(middleware)\n      end\n\n      def merge_with(middleware_specs)\n        middleware_specs.each do |operation, klass, *args|\n          if args.last.is_a?(Proc)\n            last_proc = args.pop\n            public_send(operation, klass, *args, &last_proc)\n          else\n            public_send(operation, klass, *args)\n          end\n        end\n      end\n\n      # @return [Rack::Builder] the builder object with our middlewares applied\n      def build\n        Rack::Builder.new.tap do |builder|\n          others.shift(others.size).each { |m| merge_with(m) }\n          middlewares.each do |m|\n            m.build(builder)\n          end\n        end\n      end\n\n      # @description Add middlewares with :use operation to the stack. Store others with :insert_* operation for later\n      # @param [Array] other_specs An array of middleware specifications (e.g. [[:use, klass], [:insert_before, *args]])\n      def concat(other_specs)\n        use, not_use = other_specs.partition { |o| o.first == :use }\n        others << not_use\n        merge_with(use)\n      end\n\n      protected\n\n      def assert_index(index, where)\n        i = index.is_a?(Integer) ? index : middlewares.index(index)\n        i || raise(\"No such middleware to insert #{where}: #{index.inspect}\")\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "merge_with", "signature": "def merge_with(middleware_specs)", "start_line": 73, "end_line": 82}, "metadata": {"module": "Grape", "class_name": "Stack", "class_signature": "class Stack"}, "task_id": 537}
{"function_name": "build_formatted_response", "file_path": "grape/lib/grape/middleware/formatter.rb", "focal_code": "def build_formatted_response(status, headers, bodies)\n        headers = ensure_content_type(headers)\n\n        if bodies.is_a?(Grape::ServeStream::StreamResponse)\n          Grape::ServeStream::SendfileResponse.new([], status, headers) do |resp|\n            resp.body = bodies.stream\n          end\n        else\n          # Allow content-type to be explicitly overwritten\n          formatter = fetch_formatter(headers, options)\n          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do\n            bodies.map { |body| formatter.call(body, env) }\n          end\n          Rack::Response.new(bodymap, status, headers)\n        end\n      rescue Grape::Exceptions::InvalidFormatter => e\n        throw :error, status: 500, message: e.message, backtrace: e.backtrace, original_exception: e\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Formatter < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_format: :txt\n      }.freeze\n\n      ALL_MEDIA_TYPES = '*/*'\n\n      def before\n        negotiate_content_type\n        read_body_input\n      end\n\n      def after\n        return unless @app_response\n\n        status, headers, bodies = *@app_response\n\n        if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status)\n          [status, headers, []]\n        else\n          build_formatted_response(status, headers, bodies)\n        end\n      end\n\n      private\n\n      def build_formatted_response(status, headers, bodies)\n        headers = ensure_content_type(headers)\n\n        if bodies.is_a?(Grape::ServeStream::StreamResponse)\n          Grape::ServeStream::SendfileResponse.new([], status, headers) do |resp|\n            resp.body = bodies.stream\n          end\n        else\n          # Allow content-type to be explicitly overwritten\n          formatter = fetch_formatter(headers, options)\n          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do\n            bodies.map { |body| formatter.call(body, env) }\n          end\n          Rack::Response.new(bodymap, status, headers)\n        end\n      rescue Grape::Exceptions::InvalidFormatter => e\n        throw :error, status: 500, message: e.message, backtrace: e.backtrace, original_exception: e\n      end\n\n      def fetch_formatter(headers, options)\n        api_format = env.fetch(Grape::Env::API_FORMAT) { mime_types[headers[Rack::CONTENT_TYPE]] }\n        Grape::Formatter.formatter_for(api_format, options[:formatters])\n      end\n\n      # Set the content type header for the API format if it is not already present.\n      #\n      # @param headers [Hash]\n      # @return [Hash]\n      def ensure_content_type(headers)\n        return headers if headers[Rack::CONTENT_TYPE]\n\n        headers.merge(Rack::CONTENT_TYPE => content_type_for(env[Grape::Env::API_FORMAT]))\n      end\n\n      def read_body_input\n        input = rack_request.body # reads RACK_INPUT\n        return if input.nil?\n        return unless read_body_input?\n\n        rewind = input.respond_to?(:rewind)\n\n        input.rewind if rewind\n        body = env[Grape::Env::API_REQUEST_INPUT] = input.read\n        begin\n          read_rack_input(body)\n        ensure\n          input.rewind if rewind\n        end\n      end\n\n      def read_rack_input(body)\n        return if body.empty?\n\n        media_type = rack_request.media_type\n        fmt = media_type ? mime_types[media_type] : options[:default_format]\n\n        throw :error, status: 415, message: \"The provided content-type '#{media_type}' is not supported.\" unless content_type_for(fmt)\n        parser = Grape::Parser.parser_for fmt, options[:parsers]\n        return env[Grape::Env::API_REQUEST_BODY] = body unless parser\n\n        begin\n          body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))\n          if body.is_a?(Hash)\n            env[Rack::RACK_REQUEST_FORM_HASH] = if env.key?(Rack::RACK_REQUEST_FORM_HASH)\n                                                  env[Rack::RACK_REQUEST_FORM_HASH].merge(body)\n                                                else\n                                                  body\n                                                end\n            env[Rack::RACK_REQUEST_FORM_INPUT] = env[Rack::RACK_INPUT]\n          end\n        rescue Grape::Exceptions::Base => e\n          raise e\n        rescue StandardError => e\n          throw :error, status: 400, message: e.message, backtrace: e.backtrace, original_exception: e\n        end\n      end\n\n      # this middleware will not try to format the following content-types since Rack already handles them\n      # when calling Rack's `params` function\n      # - application/x-www-form-urlencoded\n      # - multipart/form-data\n      # - multipart/related\n      # - multipart/mixed\n      def read_body_input?\n        (rack_request.post? || rack_request.put? || rack_request.patch? || rack_request.delete?) &&\n          !(rack_request.form_data? && rack_request.content_type) &&\n          !rack_request.parseable_data? &&\n          (rack_request.content_length.to_i.positive? || rack_request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')\n      end\n\n      def negotiate_content_type\n        fmt = format_from_extension || query_params['format'] || options[:format] || format_from_header || options[:default_format]\n        if content_type_for(fmt)\n          env[Grape::Env::API_FORMAT] = fmt.to_sym\n        else\n          throw :error, status: 406, message: \"The requested format '#{fmt}' is not supported.\"\n        end\n      end\n\n      def format_from_extension\n        request_path = try_scrub(rack_request.path)\n        dot_pos = request_path.rindex('.')\n        return unless dot_pos\n\n        extension = request_path[(dot_pos + 1)..]\n        extension if content_type_for(extension)\n      end\n\n      def format_from_header\n        accept_header = try_scrub(env['HTTP_ACCEPT'])\n        return if accept_header.blank? || accept_header == ALL_MEDIA_TYPES\n\n        media_type = Rack::Utils.best_q_match(accept_header, mime_types.keys)\n        mime_types[media_type] if media_type\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_formatted_response", "signature": "def build_formatted_response(status, headers, bodies)", "start_line": 33, "end_line": 50}, "metadata": {"module": "Grape", "class_name": "Formatter", "class_signature": "class Formatter < < Base"}, "task_id": 538}
{"function_name": "read_body_input", "file_path": "grape/lib/grape/middleware/formatter.rb", "focal_code": "def read_body_input\n        input = rack_request.body # reads RACK_INPUT\n        return if input.nil?\n        return unless read_body_input?\n\n        rewind = input.respond_to?(:rewind)\n\n        input.rewind if rewind\n        body = env[Grape::Env::API_REQUEST_INPUT] = input.read\n        begin\n          read_rack_input(body)\n        ensure\n          input.rewind if rewind\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Formatter < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_format: :txt\n      }.freeze\n\n      ALL_MEDIA_TYPES = '*/*'\n\n      def before\n        negotiate_content_type\n        read_body_input\n      end\n\n      def after\n        return unless @app_response\n\n        status, headers, bodies = *@app_response\n\n        if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status)\n          [status, headers, []]\n        else\n          build_formatted_response(status, headers, bodies)\n        end\n      end\n\n      private\n\n      def build_formatted_response(status, headers, bodies)\n        headers = ensure_content_type(headers)\n\n        if bodies.is_a?(Grape::ServeStream::StreamResponse)\n          Grape::ServeStream::SendfileResponse.new([], status, headers) do |resp|\n            resp.body = bodies.stream\n          end\n        else\n          # Allow content-type to be explicitly overwritten\n          formatter = fetch_formatter(headers, options)\n          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do\n            bodies.map { |body| formatter.call(body, env) }\n          end\n          Rack::Response.new(bodymap, status, headers)\n        end\n      rescue Grape::Exceptions::InvalidFormatter => e\n        throw :error, status: 500, message: e.message, backtrace: e.backtrace, original_exception: e\n      end\n\n      def fetch_formatter(headers, options)\n        api_format = env.fetch(Grape::Env::API_FORMAT) { mime_types[headers[Rack::CONTENT_TYPE]] }\n        Grape::Formatter.formatter_for(api_format, options[:formatters])\n      end\n\n      # Set the content type header for the API format if it is not already present.\n      #\n      # @param headers [Hash]\n      # @return [Hash]\n      def ensure_content_type(headers)\n        return headers if headers[Rack::CONTENT_TYPE]\n\n        headers.merge(Rack::CONTENT_TYPE => content_type_for(env[Grape::Env::API_FORMAT]))\n      end\n\n      def read_body_input\n        input = rack_request.body # reads RACK_INPUT\n        return if input.nil?\n        return unless read_body_input?\n\n        rewind = input.respond_to?(:rewind)\n\n        input.rewind if rewind\n        body = env[Grape::Env::API_REQUEST_INPUT] = input.read\n        begin\n          read_rack_input(body)\n        ensure\n          input.rewind if rewind\n        end\n      end\n\n      def read_rack_input(body)\n        return if body.empty?\n\n        media_type = rack_request.media_type\n        fmt = media_type ? mime_types[media_type] : options[:default_format]\n\n        throw :error, status: 415, message: \"The provided content-type '#{media_type}' is not supported.\" unless content_type_for(fmt)\n        parser = Grape::Parser.parser_for fmt, options[:parsers]\n        return env[Grape::Env::API_REQUEST_BODY] = body unless parser\n\n        begin\n          body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))\n          if body.is_a?(Hash)\n            env[Rack::RACK_REQUEST_FORM_HASH] = if env.key?(Rack::RACK_REQUEST_FORM_HASH)\n                                                  env[Rack::RACK_REQUEST_FORM_HASH].merge(body)\n                                                else\n                                                  body\n                                                end\n            env[Rack::RACK_REQUEST_FORM_INPUT] = env[Rack::RACK_INPUT]\n          end\n        rescue Grape::Exceptions::Base => e\n          raise e\n        rescue StandardError => e\n          throw :error, status: 400, message: e.message, backtrace: e.backtrace, original_exception: e\n        end\n      end\n\n      # this middleware will not try to format the following content-types since Rack already handles them\n      # when calling Rack's `params` function\n      # - application/x-www-form-urlencoded\n      # - multipart/form-data\n      # - multipart/related\n      # - multipart/mixed\n      def read_body_input?\n        (rack_request.post? || rack_request.put? || rack_request.patch? || rack_request.delete?) &&\n          !(rack_request.form_data? && rack_request.content_type) &&\n          !rack_request.parseable_data? &&\n          (rack_request.content_length.to_i.positive? || rack_request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')\n      end\n\n      def negotiate_content_type\n        fmt = format_from_extension || query_params['format'] || options[:format] || format_from_header || options[:default_format]\n        if content_type_for(fmt)\n          env[Grape::Env::API_FORMAT] = fmt.to_sym\n        else\n          throw :error, status: 406, message: \"The requested format '#{fmt}' is not supported.\"\n        end\n      end\n\n      def format_from_extension\n        request_path = try_scrub(rack_request.path)\n        dot_pos = request_path.rindex('.')\n        return unless dot_pos\n\n        extension = request_path[(dot_pos + 1)..]\n        extension if content_type_for(extension)\n      end\n\n      def format_from_header\n        accept_header = try_scrub(env['HTTP_ACCEPT'])\n        return if accept_header.blank? || accept_header == ALL_MEDIA_TYPES\n\n        media_type = Rack::Utils.best_q_match(accept_header, mime_types.keys)\n        mime_types[media_type] if media_type\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "read_body_input", "signature": "def read_body_input input = rack_request.body # reads RACK_INPUT", "start_line": 67, "end_line": 81}, "metadata": {"module": "Grape", "class_name": "Formatter", "class_signature": "class Formatter < < Base"}, "task_id": 539}
{"function_name": "read_rack_input", "file_path": "grape/lib/grape/middleware/formatter.rb", "focal_code": "def read_rack_input(body)\n        return if body.empty?\n\n        media_type = rack_request.media_type\n        fmt = media_type ? mime_types[media_type] : options[:default_format]\n\n        throw :error, status: 415, message: \"The provided content-type '#{media_type}' is not supported.\" unless content_type_for(fmt)\n        parser = Grape::Parser.parser_for fmt, options[:parsers]\n        return env[Grape::Env::API_REQUEST_BODY] = body unless parser\n\n        begin\n          body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))\n          if body.is_a?(Hash)\n            env[Rack::RACK_REQUEST_FORM_HASH] = if env.key?(Rack::RACK_REQUEST_FORM_HASH)\n                                                  env[Rack::RACK_REQUEST_FORM_HASH].merge(body)\n                                                else\n                                                  body\n                                                end\n            env[Rack::RACK_REQUEST_FORM_INPUT] = env[Rack::RACK_INPUT]\n          end\n        rescue Grape::Exceptions::Base => e\n          raise e\n        rescue StandardError => e\n          throw :error, status: 400, message: e.message, backtrace: e.backtrace, original_exception: e\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Formatter < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_format: :txt\n      }.freeze\n\n      ALL_MEDIA_TYPES = '*/*'\n\n      def before\n        negotiate_content_type\n        read_body_input\n      end\n\n      def after\n        return unless @app_response\n\n        status, headers, bodies = *@app_response\n\n        if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status)\n          [status, headers, []]\n        else\n          build_formatted_response(status, headers, bodies)\n        end\n      end\n\n      private\n\n      def build_formatted_response(status, headers, bodies)\n        headers = ensure_content_type(headers)\n\n        if bodies.is_a?(Grape::ServeStream::StreamResponse)\n          Grape::ServeStream::SendfileResponse.new([], status, headers) do |resp|\n            resp.body = bodies.stream\n          end\n        else\n          # Allow content-type to be explicitly overwritten\n          formatter = fetch_formatter(headers, options)\n          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do\n            bodies.map { |body| formatter.call(body, env) }\n          end\n          Rack::Response.new(bodymap, status, headers)\n        end\n      rescue Grape::Exceptions::InvalidFormatter => e\n        throw :error, status: 500, message: e.message, backtrace: e.backtrace, original_exception: e\n      end\n\n      def fetch_formatter(headers, options)\n        api_format = env.fetch(Grape::Env::API_FORMAT) { mime_types[headers[Rack::CONTENT_TYPE]] }\n        Grape::Formatter.formatter_for(api_format, options[:formatters])\n      end\n\n      # Set the content type header for the API format if it is not already present.\n      #\n      # @param headers [Hash]\n      # @return [Hash]\n      def ensure_content_type(headers)\n        return headers if headers[Rack::CONTENT_TYPE]\n\n        headers.merge(Rack::CONTENT_TYPE => content_type_for(env[Grape::Env::API_FORMAT]))\n      end\n\n      def read_body_input\n        input = rack_request.body # reads RACK_INPUT\n        return if input.nil?\n        return unless read_body_input?\n\n        rewind = input.respond_to?(:rewind)\n\n        input.rewind if rewind\n        body = env[Grape::Env::API_REQUEST_INPUT] = input.read\n        begin\n          read_rack_input(body)\n        ensure\n          input.rewind if rewind\n        end\n      end\n\n      def read_rack_input(body)\n        return if body.empty?\n\n        media_type = rack_request.media_type\n        fmt = media_type ? mime_types[media_type] : options[:default_format]\n\n        throw :error, status: 415, message: \"The provided content-type '#{media_type}' is not supported.\" unless content_type_for(fmt)\n        parser = Grape::Parser.parser_for fmt, options[:parsers]\n        return env[Grape::Env::API_REQUEST_BODY] = body unless parser\n\n        begin\n          body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))\n          if body.is_a?(Hash)\n            env[Rack::RACK_REQUEST_FORM_HASH] = if env.key?(Rack::RACK_REQUEST_FORM_HASH)\n                                                  env[Rack::RACK_REQUEST_FORM_HASH].merge(body)\n                                                else\n                                                  body\n                                                end\n            env[Rack::RACK_REQUEST_FORM_INPUT] = env[Rack::RACK_INPUT]\n          end\n        rescue Grape::Exceptions::Base => e\n          raise e\n        rescue StandardError => e\n          throw :error, status: 400, message: e.message, backtrace: e.backtrace, original_exception: e\n        end\n      end\n\n      # this middleware will not try to format the following content-types since Rack already handles them\n      # when calling Rack's `params` function\n      # - application/x-www-form-urlencoded\n      # - multipart/form-data\n      # - multipart/related\n      # - multipart/mixed\n      def read_body_input?\n        (rack_request.post? || rack_request.put? || rack_request.patch? || rack_request.delete?) &&\n          !(rack_request.form_data? && rack_request.content_type) &&\n          !rack_request.parseable_data? &&\n          (rack_request.content_length.to_i.positive? || rack_request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')\n      end\n\n      def negotiate_content_type\n        fmt = format_from_extension || query_params['format'] || options[:format] || format_from_header || options[:default_format]\n        if content_type_for(fmt)\n          env[Grape::Env::API_FORMAT] = fmt.to_sym\n        else\n          throw :error, status: 406, message: \"The requested format '#{fmt}' is not supported.\"\n        end\n      end\n\n      def format_from_extension\n        request_path = try_scrub(rack_request.path)\n        dot_pos = request_path.rindex('.')\n        return unless dot_pos\n\n        extension = request_path[(dot_pos + 1)..]\n        extension if content_type_for(extension)\n      end\n\n      def format_from_header\n        accept_header = try_scrub(env['HTTP_ACCEPT'])\n        return if accept_header.blank? || accept_header == ALL_MEDIA_TYPES\n\n        media_type = Rack::Utils.best_q_match(accept_header, mime_types.keys)\n        mime_types[media_type] if media_type\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "read_rack_input", "signature": "def read_rack_input(body)", "start_line": 83, "end_line": 108}, "metadata": {"module": "Grape", "class_name": "Formatter", "class_signature": "class Formatter < < Base"}, "task_id": 540}
{"function_name": "format_message", "file_path": "grape/lib/grape/middleware/error.rb", "focal_code": "def format_message(message, backtrace, original_exception = nil)\n        format = env[Grape::Env::API_FORMAT] || options[:format]\n        formatter = Grape::ErrorFormatter.formatter_for(format, options[:error_formatters], options[:default_error_formatter])\n        return formatter.call(message, backtrace, options, env, original_exception) if formatter\n\n        throw :error,\n              status: 406,\n              message: \"The requested format '#{format}' is not supported.\",\n              backtrace:,\n              original_exception:\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Error < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_status: 500,\n        default_message: '',\n        format: :txt,\n        rescue_all: false,\n        rescue_grape_exceptions: false,\n        rescue_subclasses: true,\n        rescue_options: {\n          backtrace: false,\n          original_exception: false\n        }.freeze\n      }.freeze\n\n      def call!(env)\n        @env = env\n        error_response(catch(:error) { return @app.call(@env) })\n      rescue Exception => e # rubocop:disable Lint/RescueException\n        run_rescue_handler(find_handler(e.class), e, @env[Grape::Env::API_ENDPOINT])\n      end\n\n      private\n\n      def rack_response(status, headers, message)\n        message = Rack::Utils.escape_html(message) if headers[Rack::CONTENT_TYPE] == 'text/html'\n        Rack::Response.new(Array.wrap(message), Rack::Utils.status_code(status), Grape::Util::Header.new.merge(headers))\n      end\n\n      def format_message(message, backtrace, original_exception = nil)\n        format = env[Grape::Env::API_FORMAT] || options[:format]\n        formatter = Grape::ErrorFormatter.formatter_for(format, options[:error_formatters], options[:default_error_formatter])\n        return formatter.call(message, backtrace, options, env, original_exception) if formatter\n\n        throw :error,\n              status: 406,\n              message: \"The requested format '#{format}' is not supported.\",\n              backtrace:,\n              original_exception:\n      end\n\n      def find_handler(klass)\n        registered_rescue_handler(klass) ||\n          rescue_handler_for_grape_exception(klass) ||\n          rescue_handler_for_any_class(klass) ||\n          raise\n      end\n\n      def error_response(error = {})\n        status = error[:status] || options[:default_status]\n        env[Grape::Env::API_ENDPOINT].status(status) # error! may not have been called\n        message = error[:message] || options[:default_message]\n        headers = { Rack::CONTENT_TYPE => content_type }.tap do |h|\n          h.merge!(error[:headers]) if error[:headers].is_a?(Hash)\n        end\n        backtrace = error[:backtrace] || error[:original_exception]&.backtrace || []\n        original_exception = error.is_a?(Exception) ? error : error[:original_exception]\n        rack_response(status, headers, format_message(message, backtrace, original_exception))\n      end\n\n      def default_rescue_handler(exception)\n        error_response(message: exception.message, backtrace: exception.backtrace, original_exception: exception)\n      end\n\n      def registered_rescue_handler(klass)\n        rescue_handler_from(:base_only_rescue_handlers) { |err| klass == err } ||\n          rescue_handler_from(:rescue_handlers) { |err| klass <= err }\n      end\n\n      def rescue_handler_from(key)\n        error, handler = options[key]&.find { |err, _handler| yield(err) }\n\n        return unless error\n\n        handler || method(:default_rescue_handler)\n      end\n\n      def rescue_handler_for_grape_exception(klass)\n        return unless klass <= Grape::Exceptions::Base\n        return method(:error_response) if klass == Grape::Exceptions::InvalidVersionHeader\n        return unless options[:rescue_grape_exceptions] || !options[:rescue_all]\n\n        options[:grape_exceptions_rescue_handler] || method(:error_response)\n      end\n\n      def rescue_handler_for_any_class(klass)\n        return unless klass <= StandardError\n        return unless options[:rescue_all] || options[:rescue_grape_exceptions]\n\n        options[:all_rescue_handler] || method(:default_rescue_handler)\n      end\n\n      def run_rescue_handler(handler, error, endpoint)\n        handler = endpoint.public_method(handler) if handler.instance_of?(Symbol)\n        response = catch(:error) do\n          handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)\n        end\n\n        if error?(response)\n          error_response(response)\n        elsif response.is_a?(Rack::Response)\n          response\n        else\n          run_rescue_handler(method(:default_rescue_handler), Grape::Exceptions::InvalidResponse.new, endpoint)\n        end\n      end\n\n      def error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil)\n        env[Grape::Env::API_ENDPOINT].status(status) # not error! inside route\n        rack_response(\n          status, headers.reverse_merge(Rack::CONTENT_TYPE => content_type),\n          format_message(message, backtrace, original_exception)\n        )\n      end\n\n      def error?(response)\n        return false unless response.is_a?(Hash)\n\n        response.key?(:message) && response.key?(:status) && response.key?(:headers)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "format_message", "signature": "def format_message(message, backtrace, original_exception = nil)", "start_line": 35, "end_line": 45}, "metadata": {"module": "Grape", "class_name": "Error", "class_signature": "class Error < < Base"}, "task_id": 541}
{"function_name": "error_response", "file_path": "grape/lib/grape/middleware/error.rb", "focal_code": "def error_response(error = {})\n        status = error[:status] || options[:default_status]\n        env[Grape::Env::API_ENDPOINT].status(status) # error! may not have been called\n        message = error[:message] || options[:default_message]\n        headers = { Rack::CONTENT_TYPE => content_type }.tap do |h|\n          h.merge!(error[:headers]) if error[:headers].is_a?(Hash)\n        end\n        backtrace = error[:backtrace] || error[:original_exception]&.backtrace || []\n        original_exception = error.is_a?(Exception) ? error : error[:original_exception]\n        rack_response(status, headers, format_message(message, backtrace, original_exception))\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Error < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_status: 500,\n        default_message: '',\n        format: :txt,\n        rescue_all: false,\n        rescue_grape_exceptions: false,\n        rescue_subclasses: true,\n        rescue_options: {\n          backtrace: false,\n          original_exception: false\n        }.freeze\n      }.freeze\n\n      def call!(env)\n        @env = env\n        error_response(catch(:error) { return @app.call(@env) })\n      rescue Exception => e # rubocop:disable Lint/RescueException\n        run_rescue_handler(find_handler(e.class), e, @env[Grape::Env::API_ENDPOINT])\n      end\n\n      private\n\n      def rack_response(status, headers, message)\n        message = Rack::Utils.escape_html(message) if headers[Rack::CONTENT_TYPE] == 'text/html'\n        Rack::Response.new(Array.wrap(message), Rack::Utils.status_code(status), Grape::Util::Header.new.merge(headers))\n      end\n\n      def format_message(message, backtrace, original_exception = nil)\n        format = env[Grape::Env::API_FORMAT] || options[:format]\n        formatter = Grape::ErrorFormatter.formatter_for(format, options[:error_formatters], options[:default_error_formatter])\n        return formatter.call(message, backtrace, options, env, original_exception) if formatter\n\n        throw :error,\n              status: 406,\n              message: \"The requested format '#{format}' is not supported.\",\n              backtrace:,\n              original_exception:\n      end\n\n      def find_handler(klass)\n        registered_rescue_handler(klass) ||\n          rescue_handler_for_grape_exception(klass) ||\n          rescue_handler_for_any_class(klass) ||\n          raise\n      end\n\n      def error_response(error = {})\n        status = error[:status] || options[:default_status]\n        env[Grape::Env::API_ENDPOINT].status(status) # error! may not have been called\n        message = error[:message] || options[:default_message]\n        headers = { Rack::CONTENT_TYPE => content_type }.tap do |h|\n          h.merge!(error[:headers]) if error[:headers].is_a?(Hash)\n        end\n        backtrace = error[:backtrace] || error[:original_exception]&.backtrace || []\n        original_exception = error.is_a?(Exception) ? error : error[:original_exception]\n        rack_response(status, headers, format_message(message, backtrace, original_exception))\n      end\n\n      def default_rescue_handler(exception)\n        error_response(message: exception.message, backtrace: exception.backtrace, original_exception: exception)\n      end\n\n      def registered_rescue_handler(klass)\n        rescue_handler_from(:base_only_rescue_handlers) { |err| klass == err } ||\n          rescue_handler_from(:rescue_handlers) { |err| klass <= err }\n      end\n\n      def rescue_handler_from(key)\n        error, handler = options[key]&.find { |err, _handler| yield(err) }\n\n        return unless error\n\n        handler || method(:default_rescue_handler)\n      end\n\n      def rescue_handler_for_grape_exception(klass)\n        return unless klass <= Grape::Exceptions::Base\n        return method(:error_response) if klass == Grape::Exceptions::InvalidVersionHeader\n        return unless options[:rescue_grape_exceptions] || !options[:rescue_all]\n\n        options[:grape_exceptions_rescue_handler] || method(:error_response)\n      end\n\n      def rescue_handler_for_any_class(klass)\n        return unless klass <= StandardError\n        return unless options[:rescue_all] || options[:rescue_grape_exceptions]\n\n        options[:all_rescue_handler] || method(:default_rescue_handler)\n      end\n\n      def run_rescue_handler(handler, error, endpoint)\n        handler = endpoint.public_method(handler) if handler.instance_of?(Symbol)\n        response = catch(:error) do\n          handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)\n        end\n\n        if error?(response)\n          error_response(response)\n        elsif response.is_a?(Rack::Response)\n          response\n        else\n          run_rescue_handler(method(:default_rescue_handler), Grape::Exceptions::InvalidResponse.new, endpoint)\n        end\n      end\n\n      def error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil)\n        env[Grape::Env::API_ENDPOINT].status(status) # not error! inside route\n        rack_response(\n          status, headers.reverse_merge(Rack::CONTENT_TYPE => content_type),\n          format_message(message, backtrace, original_exception)\n        )\n      end\n\n      def error?(response)\n        return false unless response.is_a?(Hash)\n\n        response.key?(:message) && response.key?(:status) && response.key?(:headers)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "error_response", "signature": "def error_response(error = {})", "start_line": 54, "end_line": 64}, "metadata": {"module": "Grape", "class_name": "Error", "class_signature": "class Error < < Base"}, "task_id": 542}
{"function_name": "run_rescue_handler", "file_path": "grape/lib/grape/middleware/error.rb", "focal_code": "def run_rescue_handler(handler, error, endpoint)\n        handler = endpoint.public_method(handler) if handler.instance_of?(Symbol)\n        response = catch(:error) do\n          handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)\n        end\n\n        if error?(response)\n          error_response(response)\n        elsif response.is_a?(Rack::Response)\n          response\n        else\n          run_rescue_handler(method(:default_rescue_handler), Grape::Exceptions::InvalidResponse.new, endpoint)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Error < Base\n      include PrecomputedContentTypes\n\n      DEFAULT_OPTIONS = {\n        default_status: 500,\n        default_message: '',\n        format: :txt,\n        rescue_all: false,\n        rescue_grape_exceptions: false,\n        rescue_subclasses: true,\n        rescue_options: {\n          backtrace: false,\n          original_exception: false\n        }.freeze\n      }.freeze\n\n      def call!(env)\n        @env = env\n        error_response(catch(:error) { return @app.call(@env) })\n      rescue Exception => e # rubocop:disable Lint/RescueException\n        run_rescue_handler(find_handler(e.class), e, @env[Grape::Env::API_ENDPOINT])\n      end\n\n      private\n\n      def rack_response(status, headers, message)\n        message = Rack::Utils.escape_html(message) if headers[Rack::CONTENT_TYPE] == 'text/html'\n        Rack::Response.new(Array.wrap(message), Rack::Utils.status_code(status), Grape::Util::Header.new.merge(headers))\n      end\n\n      def format_message(message, backtrace, original_exception = nil)\n        format = env[Grape::Env::API_FORMAT] || options[:format]\n        formatter = Grape::ErrorFormatter.formatter_for(format, options[:error_formatters], options[:default_error_formatter])\n        return formatter.call(message, backtrace, options, env, original_exception) if formatter\n\n        throw :error,\n              status: 406,\n              message: \"The requested format '#{format}' is not supported.\",\n              backtrace:,\n              original_exception:\n      end\n\n      def find_handler(klass)\n        registered_rescue_handler(klass) ||\n          rescue_handler_for_grape_exception(klass) ||\n          rescue_handler_for_any_class(klass) ||\n          raise\n      end\n\n      def error_response(error = {})\n        status = error[:status] || options[:default_status]\n        env[Grape::Env::API_ENDPOINT].status(status) # error! may not have been called\n        message = error[:message] || options[:default_message]\n        headers = { Rack::CONTENT_TYPE => content_type }.tap do |h|\n          h.merge!(error[:headers]) if error[:headers].is_a?(Hash)\n        end\n        backtrace = error[:backtrace] || error[:original_exception]&.backtrace || []\n        original_exception = error.is_a?(Exception) ? error : error[:original_exception]\n        rack_response(status, headers, format_message(message, backtrace, original_exception))\n      end\n\n      def default_rescue_handler(exception)\n        error_response(message: exception.message, backtrace: exception.backtrace, original_exception: exception)\n      end\n\n      def registered_rescue_handler(klass)\n        rescue_handler_from(:base_only_rescue_handlers) { |err| klass == err } ||\n          rescue_handler_from(:rescue_handlers) { |err| klass <= err }\n      end\n\n      def rescue_handler_from(key)\n        error, handler = options[key]&.find { |err, _handler| yield(err) }\n\n        return unless error\n\n        handler || method(:default_rescue_handler)\n      end\n\n      def rescue_handler_for_grape_exception(klass)\n        return unless klass <= Grape::Exceptions::Base\n        return method(:error_response) if klass == Grape::Exceptions::InvalidVersionHeader\n        return unless options[:rescue_grape_exceptions] || !options[:rescue_all]\n\n        options[:grape_exceptions_rescue_handler] || method(:error_response)\n      end\n\n      def rescue_handler_for_any_class(klass)\n        return unless klass <= StandardError\n        return unless options[:rescue_all] || options[:rescue_grape_exceptions]\n\n        options[:all_rescue_handler] || method(:default_rescue_handler)\n      end\n\n      def run_rescue_handler(handler, error, endpoint)\n        handler = endpoint.public_method(handler) if handler.instance_of?(Symbol)\n        response = catch(:error) do\n          handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)\n        end\n\n        if error?(response)\n          error_response(response)\n        elsif response.is_a?(Rack::Response)\n          response\n        else\n          run_rescue_handler(method(:default_rescue_handler), Grape::Exceptions::InvalidResponse.new, endpoint)\n        end\n      end\n\n      def error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil)\n        env[Grape::Env::API_ENDPOINT].status(status) # not error! inside route\n        rack_response(\n          status, headers.reverse_merge(Rack::CONTENT_TYPE => content_type),\n          format_message(message, backtrace, original_exception)\n        )\n      end\n\n      def error?(response)\n        return false unless response.is_a?(Hash)\n\n        response.key?(:message) && response.key?(:status) && response.key?(:headers)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "run_rescue_handler", "signature": "def run_rescue_handler(handler, error, endpoint)", "start_line": 98, "end_line": 111}, "metadata": {"module": "Grape", "class_name": "Error", "class_signature": "class Error < < Base"}, "task_id": 543}
{"function_name": "call!", "file_path": "grape/lib/grape/middleware/base.rb", "focal_code": "def call!(env)\n        @env = env\n        before\n        begin\n          @app_response = @app.call(@env)\n        ensure\n          begin\n            after_response = after\n          rescue StandardError => e\n            warn \"caught error of type #{e.class} in after callback inside #{self.class.name} : #{e.message}\"\n            raise e\n          end\n        end\n\n        response = after_response || @app_response\n        merge_headers response\n        response\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    class Base\n      include Grape::DSL::Headers\n\n      attr_reader :app, :env, :options\n\n      # @param [Rack Application] app The standard argument for a Rack middleware.\n      # @param [Hash] options A hash of options, simply stored for use by subclasses.\n      def initialize(app, **options)\n        @app = app\n        @options = merge_default_options(options)\n        @app_response = nil\n      end\n\n      def call(env)\n        dup.call!(env).to_a\n      end\n\n      def call!(env)\n        @env = env\n        before\n        begin\n          @app_response = @app.call(@env)\n        ensure\n          begin\n            after_response = after\n          rescue StandardError => e\n            warn \"caught error of type #{e.class} in after callback inside #{self.class.name} : #{e.message}\"\n            raise e\n          end\n        end\n\n        response = after_response || @app_response\n        merge_headers response\n        response\n      end\n\n      # @abstract\n      # Called before the application is called in the middleware lifecycle.\n      def before; end\n\n      # @abstract\n      # Called after the application is called in the middleware lifecycle.\n      # @return [Response, nil] a Rack SPEC response or nil to call the application afterwards.\n      def after; end\n\n      def rack_request\n        @rack_request ||= Rack::Request.new(env)\n      end\n\n      def context\n        env[Grape::Env::API_ENDPOINT]\n      end\n\n      def response\n        return @app_response if @app_response.is_a?(Rack::Response)\n\n        @app_response = Rack::Response[*@app_response]\n      end\n\n      def content_types\n        @content_types ||= Grape::ContentTypes.content_types_for(options[:content_types])\n      end\n\n      def mime_types\n        @mime_types ||= Grape::ContentTypes.mime_types_for(content_types)\n      end\n\n      def content_type_for(format)\n        content_types_indifferent_access[format]\n      end\n\n      def content_type\n        content_type_for(env[Grape::Env::API_FORMAT] || options[:format]) || 'text/html'\n      end\n\n      def query_params\n        rack_request.GET\n      rescue *Grape::RACK_ERRORS\n        raise Grape::Exceptions::RequestError\n      end\n\n      private\n\n      def content_types_indifferent_access\n        @content_types_indifferent_access ||= content_types.with_indifferent_access\n      end\n\n      def merge_headers(response)\n        return if @header.blank?\n\n        case response\n        when Rack::Response then response.headers.merge!(@header)\n        when Array          then response[1].merge!(@header)\n        end\n      end\n\n      def merge_default_options(options)\n        if respond_to?(:default_options)\n          default_options.deep_merge(options)\n        elsif self.class.const_defined?(:DEFAULT_OPTIONS)\n          self.class::DEFAULT_OPTIONS.deep_merge(options)\n        else\n          options\n        end\n      end\n\n      def try_scrub(obj)\n        obj.respond_to?(:valid_encoding?) && !obj.valid_encoding? ? obj.scrub : obj\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call!", "signature": "def call!(env)", "start_line": 22, "end_line": 39}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base"}, "task_id": 544}
{"function_name": "serialize", "file_path": "grape/lib/grape/formatter/serializable_hash.rb", "focal_code": "def serialize(object)\n          if object.respond_to? :serializable_hash\n            object.serializable_hash\n          elsif array_serializable?(object)\n            object.map(&:serializable_hash)\n          elsif object.is_a?(Hash)\n            object.transform_values { |v| serialize(v) }\n          else\n            object\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Formatter\n    class SerializableHash < Base\n      class << self\n        def call(object, _env)\n          return object if object.is_a?(String)\n          return ::Grape::Json.dump(serialize(object)) if serializable?(object)\n          return object.to_json if object.respond_to?(:to_json)\n\n          ::Grape::Json.dump(object)\n        end\n\n        private\n\n        def serializable?(object)\n          object.respond_to?(:serializable_hash) || array_serializable?(object) || object.is_a?(Hash)\n        end\n\n        def serialize(object)\n          if object.respond_to? :serializable_hash\n            object.serializable_hash\n          elsif array_serializable?(object)\n            object.map(&:serializable_hash)\n          elsif object.is_a?(Hash)\n            object.transform_values { |v| serialize(v) }\n          else\n            object\n          end\n        end\n\n        def array_serializable?(object)\n          object.is_a?(Array) && object.all? { |o| o.respond_to? :serializable_hash }\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "serialize", "signature": "def serialize(object)", "start_line": 21, "end_line": 31}, "metadata": {"module": "Grape", "class_name": "SerializableHash", "class_signature": "class SerializableHash < < Base"}, "task_id": 545}
{"function_name": "translate_message", "file_path": "grape/lib/grape/exceptions/base.rb", "focal_code": "def translate_message(translation_key, **)\n        case translation_key\n        when Symbol\n          translate(translation_key, **)\n        when Hash\n          translation_key => { key:, **opts }\n          translate(key, **opts)\n        when Proc\n          translation_key.call\n        else\n          translation_key\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Exceptions\n    class Base < StandardError\n      include Grape::Util::Translation\n\n      MESSAGE_STEPS = %w[problem summary resolution].to_h { |s| [s, s.capitalize] }.freeze\n\n      attr_reader :status, :headers\n\n      def initialize(status: nil, message: nil, headers: nil)\n        super(message)\n\n        @status  = status\n        @headers = headers\n      end\n\n      def [](index)\n        __send__ index\n      end\n\n      private\n\n      def compose_message(key, **)\n        short_message = translate_message(key, **)\n        return short_message unless short_message.is_a?(Hash)\n\n        MESSAGE_STEPS.filter_map do |step, label|\n          detail = translate_message(:\"#{key}.#{step}\", **)\n          \"\\n#{label}:\\n  #{detail}\" if detail.present?\n        end.join\n      end\n\n      def translate_message(translation_key, **)\n        case translation_key\n        when Symbol\n          translate(translation_key, **)\n        when Hash\n          translation_key => { key:, **opts }\n          translate(key, **opts)\n        when Proc\n          translation_key.call\n        else\n          translation_key\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "translate_message", "signature": "def translate_message(translation_key, **)", "start_line": 35, "end_line": 47}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base < < StandardError"}, "task_id": 546}
{"function_name": "full_messages", "file_path": "grape/lib/grape/exceptions/validation_errors.rb", "focal_code": "def full_messages\n        messages = map do |attributes, error|\n          translate(\n            :format,\n            scope: 'grape.errors',\n            default: '%<attributes>s %<message>s',\n            attributes: translate_attributes(attributes),\n            message: error.message\n          )\n        end\n        messages.uniq!\n        messages\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Exceptions\n    class ValidationErrors < Base\n      include Enumerable\n\n      attr_reader :errors\n\n      def initialize(errors: [], headers: {})\n        @errors = errors.group_by(&:params)\n        super(message: full_messages.join(', '), status: 400, headers:)\n      end\n\n      def each\n        errors.each_pair do |attribute, errors|\n          errors.each do |error|\n            yield attribute, error\n          end\n        end\n      end\n\n      def as_json(**_opts)\n        errors.map do |k, v|\n          {\n            params: k,\n            messages: v.map(&:to_s)\n          }\n        end\n      end\n\n      def to_json(*_opts)\n        as_json.to_json\n      end\n\n      def full_messages\n        messages = map do |attributes, error|\n          translate(\n            :format,\n            scope: 'grape.errors',\n            default: '%<attributes>s %<message>s',\n            attributes: translate_attributes(attributes),\n            message: error.message\n          )\n        end\n        messages.uniq!\n        messages\n      end\n\n      private\n\n      def translate_attributes(keys)\n        keys.map do |key|\n          translate(key, scope: 'grape.errors.attributes', default: key.to_s)\n        end.join(', ')\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "full_messages", "signature": "def full_messages messages = map do |attributes, error|", "start_line": 36, "end_line": 48}, "metadata": {"module": "Grape", "class_name": "ValidationErrors", "class_signature": "class ValidationErrors < < Base"}, "task_id": 547}
{"function_name": "initialize", "file_path": "grape/lib/grape/exceptions/validation.rb", "focal_code": "def initialize(params:, message: nil, status: nil, headers: nil)\n        @params = Array(params)\n        if message\n          @message_key = case message\n                         when Symbol then message\n                         when Hash then message[:key]\n                         end\n          message = translate_message(message)\n        end\n\n        super(status:, message:, headers:)\n        # Pre-seed the backtrace so Ruby's raise skips capture. Validation errors are\n        # a hot path (raised per bad attribute) and end up as 400 Bad Request responses;\n        # backtraces here point into Grape internals and have no diagnostic value.\n        set_backtrace(EMPTY_BACKTRACE)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Exceptions\n    class Validation < Base\n      EMPTY_BACKTRACE = [].freeze\n\n      attr_reader :params, :message_key\n\n      def initialize(params:, message: nil, status: nil, headers: nil)\n        @params = Array(params)\n        if message\n          @message_key = case message\n                         when Symbol then message\n                         when Hash then message[:key]\n                         end\n          message = translate_message(message)\n        end\n\n        super(status:, message:, headers:)\n        # Pre-seed the backtrace so Ruby's raise skips capture. Validation errors are\n        # a hot path (raised per bad attribute) and end up as 400 Bad Request responses;\n        # backtraces here point into Grape internals and have no diagnostic value.\n        set_backtrace(EMPTY_BACKTRACE)\n      end\n\n      # Remove all the unnecessary stuff from Grape::Exceptions::Base like status\n      # and headers when converting a validation error to json or string\n      def as_json(*_args)\n        to_s\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(params:, message: nil, status: nil, headers: nil)", "start_line": 10, "end_line": 25}, "metadata": {"module": "Grape", "class_name": "Validation", "class_signature": "class Validation < < Base"}, "task_id": 548}
{"function_name": "within_namespace", "file_path": "grape/lib/grape/dsl/settings.rb", "focal_code": "def within_namespace\n        new_inheritable_settings = Grape::Util::InheritableSetting.new\n        new_inheritable_settings.inherit_from inheritable_setting\n\n        @inheritable_setting = new_inheritable_settings\n\n        result = yield\n\n        inheritable_setting.route_end\n        @inheritable_setting = inheritable_setting.parent\n        reset_validations!\n\n        result\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    # Keeps track of settings (implemented as key-value pairs, grouped by\n    # types), in two contexts: top-level settings which apply globally no\n    # matter where they're defined, and inheritable settings which apply only\n    # in the current scope and scopes nested under it.\n    module Settings\n      attr_writer :inheritable_setting\n\n      # Fetch our top-level settings, which apply to all endpoints in the API.\n      def top_level_setting\n        @top_level_setting ||= Grape::Util::InheritableSetting.new.tap do |setting|\n          # Doesn't try to inherit settings from +Grape::API::Instance+ which also responds to\n          # +inheritable_setting+, however, it doesn't contain any user-defined settings.\n          # Otherwise, it would lead to an extra instance of +Grape::Util::InheritableSetting+\n          # in the chain for every endpoint.\n          setting.inherit_from superclass.inheritable_setting if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API::Instance\n        end\n      end\n\n      # Fetch our current inheritable settings, which are inherited by\n      # nested scopes but not shared across siblings.\n      def inheritable_setting\n        @inheritable_setting ||= Grape::Util::InheritableSetting.new.tap { |new_settings| new_settings.inherit_from top_level_setting }\n      end\n\n      def global_setting(key, value = nil)\n        get_or_set(inheritable_setting.global, key, value)\n      end\n\n      def route_setting(key, value = nil)\n        get_or_set(inheritable_setting.route, key, value)\n      end\n\n      def namespace_setting(key, value = nil)\n        get_or_set(inheritable_setting.namespace, key, value)\n      end\n\n      private\n\n      # Execute the block within a context where our inheritable settings are forked\n      # to a new copy (see #namespace_start).\n      def within_namespace\n        new_inheritable_settings = Grape::Util::InheritableSetting.new\n        new_inheritable_settings.inherit_from inheritable_setting\n\n        @inheritable_setting = new_inheritable_settings\n\n        result = yield\n\n        inheritable_setting.route_end\n        @inheritable_setting = inheritable_setting.parent\n        reset_validations!\n\n        result\n      end\n\n      def get_or_set(setting, key, value)\n        return setting[key] if value.nil?\n\n        setting[key] = value\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "within_namespace", "signature": "def within_namespace new_inheritable_settings = Grape::Util::InheritableSetting.new", "start_line": 45, "end_line": 58}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 549}
{"function_name": "version", "file_path": "grape/lib/grape/dsl/routing.rb", "focal_code": "def version(*args, **options, &block)\n        if args.any?\n          options = options.reverse_merge(using: :path)\n          requested_versions = args.flatten.map(&:to_s)\n\n          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)\n\n          @versions = versions | requested_versions\n\n          if block\n            within_namespace do\n              inheritable_setting.namespace_inheritable[:version] = requested_versions\n              inheritable_setting.namespace_inheritable[:version_options] = options\n\n              instance_eval(&block)\n            end\n          else\n            inheritable_setting.namespace_inheritable[:version] = requested_versions\n            inheritable_setting.namespace_inheritable[:version_options] = options\n          end\n        end\n\n        @versions&.last\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Routing\n      attr_reader :endpoints\n\n      def given(conditional_option, &)\n        return unless conditional_option\n\n        mounted(&)\n      end\n\n      def mounted(&block)\n        evaluate_as_instance_with_configuration(block, lazy: true)\n      end\n\n      def cascade(value = nil)\n        return inheritable_setting.namespace_inheritable.key?(:cascade) ? !inheritable_setting.namespace_inheritable[:cascade].nil? : true if value.nil?\n\n        inheritable_setting.namespace_inheritable[:cascade] = value\n      end\n\n      # Specify an API version.\n      #\n      # @example API with legacy support.\n      #   class MyAPI < Grape::API\n      #     version 'v2'\n      #\n      #     get '/main' do\n      #       {some: 'data'}\n      #     end\n      #\n      #     version 'v1' do\n      #       get '/main' do\n      #         {legacy: 'data'}\n      #       end\n      #     end\n      #   end\n      #\n      def version(*args, **options, &block)\n        if args.any?\n          options = options.reverse_merge(using: :path)\n          requested_versions = args.flatten.map(&:to_s)\n\n          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)\n\n          @versions = versions | requested_versions\n\n          if block\n            within_namespace do\n              inheritable_setting.namespace_inheritable[:version] = requested_versions\n              inheritable_setting.namespace_inheritable[:version_options] = options\n\n              instance_eval(&block)\n            end\n          else\n            inheritable_setting.namespace_inheritable[:version] = requested_versions\n            inheritable_setting.namespace_inheritable[:version_options] = options\n          end\n        end\n\n        @versions&.last\n      end\n\n      # Define a root URL prefix for your entire API.\n      def prefix(prefix = nil)\n        return inheritable_setting.namespace_inheritable[:root_prefix] if prefix.nil?\n\n        inheritable_setting.namespace_inheritable[:root_prefix] = prefix.to_s\n      end\n\n      # Create a scope without affecting the URL.\n      #\n      # @param _name [Symbol] Purely placebo, just allows to name the scope to\n      # make the code more readable.\n      def scope(_name = nil, &block)\n        within_namespace do\n          nest(block)\n        end\n      end\n\n      def build_with(build_with)\n        inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Do not route HEAD requests to GET requests automatically.\n      def do_not_route_head!\n        inheritable_setting.namespace_inheritable[:do_not_route_head] = true\n      end\n\n      # Do not automatically route OPTIONS.\n      def do_not_route_options!\n        inheritable_setting.namespace_inheritable[:do_not_route_options] = true\n      end\n\n      def lint!\n        inheritable_setting.namespace_inheritable[:lint] = true\n      end\n\n      def do_not_document!\n        inheritable_setting.namespace_inheritable[:do_not_document] = true\n      end\n\n      def mount(mounts, *opts)\n        mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)\n        mounts.each_pair do |app, path|\n          if app.respond_to?(:mount_instance)\n            opts_with = opts.any? ? opts.first[:with] : {}\n            mount({ app.mount_instance(configuration: opts_with) => path }, *opts)\n            next\n          end\n          in_setting = inheritable_setting\n\n          if app.respond_to?(:inheritable_setting, true)\n            mount_path = Grape::Router.normalize_path(path)\n            app.top_level_setting.namespace_stackable[:mount_path] = mount_path\n\n            app.inherit_settings(inheritable_setting)\n\n            in_setting = app.top_level_setting\n\n            app.change!\n            change!\n          end\n\n          # When trying to mount multiple times the same endpoint, remove the previous ones\n          # from the list of endpoints if refresh_already_mounted parameter is true\n          refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false\n          if refresh_already_mounted && !endpoints.empty?\n            endpoints.delete_if do |endpoint|\n              endpoint.options[:app].to_s == app.to_s\n            end\n          end\n\n          endpoints << Grape::Endpoint.new(\n            in_setting,\n            method: :any,\n            path:,\n            app:,\n            route_options: { anchor: false },\n            forward_match: !app.respond_to?(:inheritable_setting),\n            for: self\n          )\n        end\n      end\n\n      # Defines a route that will be recognized\n      # by the Grape API.\n      #\n      # @param methods [HTTP Verb] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.\n      # @param paths [String] One or more strings representing the URL segment(s) for this route.\n      #\n      # @example Defining a basic route.\n      #   class MyAPI < Grape::API\n      #     route(:any, '/hello') do\n      #       {hello: 'world'}\n      #     end\n      #   end\n      def route(methods, paths = ['/'], route_options = {}, &)\n        method = methods == :any ? '*' : methods\n        endpoint_params = inheritable_setting.namespace_stackable_with_hash(:params) || {}\n        endpoint_description = inheritable_setting.route[:description]\n        all_route_options = { params: endpoint_params }\n        all_route_options.deep_merge!(endpoint_description) if endpoint_description\n        all_route_options.deep_merge!(route_options) if route_options&.any?\n\n        new_endpoint = Grape::Endpoint.new(\n          inheritable_setting,\n          method:,\n          path: paths,\n          for: self,\n          route_options: all_route_options,\n          &\n        )\n        endpoints << new_endpoint unless endpoints.include?(new_endpoint)\n\n        inheritable_setting.route_end\n        reset_validations!\n      end\n\n      Grape::HTTP_SUPPORTED_METHODS.each do |supported_method|\n        define_method supported_method.downcase do |*args, **options, &block|\n          paths = args.first || ['/']\n          route(supported_method, paths, options, &block)\n        end\n      end\n\n      # Declare a \"namespace\", which prefixes all subordinate routes with its\n      # name. Any endpoints within a namespace, group, resource or segment,\n      # etc., will share their parent context as well as any configuration\n      # done in the namespace context.\n      #\n      # @example\n      #\n      #     namespace :foo do\n      #       get 'bar' do\n      #         # defines the endpoint: GET /foo/bar\n      #       end\n      #     end\n      def namespace(space = nil, requirements: nil, **options, &block)\n        return Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace]) unless space || block\n\n        within_namespace do\n          nest(block) do\n            inheritable_setting.namespace_stackable[:namespace] = Grape::Namespace.new(space, requirements:, **options) if space\n          end\n        end\n      end\n\n      alias group namespace\n      alias resource namespace\n      alias resources namespace\n      alias segment namespace\n\n      # An array of API routes.\n      def routes\n        @routes ||= endpoints.map(&:routes).flatten\n      end\n\n      # This method allows you to quickly define a parameter route segment\n      # in your API.\n      #\n      # @param param [Symbol] The name of the parameter you wish to declare.\n      # @option options [Regexp] You may supply a regular expression that the declared parameter must meet.\n      def route_param(param, requirements: nil, type: nil, **, &)\n        requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp)\n\n        Grape::Validations::ParamsScope.new(api: self) do\n          requires param, type: type\n        end if type\n\n        namespace(\":#{param}\", requirements:, **, &)\n      end\n\n      # @return array of defined versions\n      def versions\n        @versions ||= []\n      end\n\n      private\n\n      # Remove all defined routes.\n      def reset_routes!\n        endpoints.each(&:reset_routes!)\n        @routes = nil\n      end\n\n      def reset_endpoints!\n        @endpoints = []\n      end\n\n      def refresh_mounted_api(mounts, *opts)\n        opts << { refresh_already_mounted: true }\n        mount(mounts, *opts)\n      end\n\n      # Execute first the provided block, then each of the\n      # block passed in. Allows for simple 'before' setups\n      # of settings stack pushes.\n      def nest(*blocks, &block)\n        blocks.compact!\n        return instance_eval(&block) if blocks.empty?\n\n        evaluate_as_instance_with_configuration(block) if block\n        blocks.each { |b| evaluate_as_instance_with_configuration(b) }\n        reset_validations!\n      end\n\n      def evaluate_as_instance_with_configuration(block, lazy: false)\n        lazy_block = Grape::Util::Lazy::Block.new do |configuration|\n          value_for_configuration = configuration\n          self.configuration = value_for_configuration.evaluate if value_for_configuration.is_a?(Grape::Util::Lazy::Base)\n          response = instance_eval(&block)\n          self.configuration = value_for_configuration\n          response\n        end\n        return lazy_block if @base && base_instance? && lazy\n\n        lazy_block.evaluate_from(configuration)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "version", "signature": "def version(*args, **options, &block)", "start_line": 41, "end_line": 64}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 550}
{"function_name": "mount", "file_path": "grape/lib/grape/dsl/routing.rb", "focal_code": "def mount(mounts, *opts)\n        mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)\n        mounts.each_pair do |app, path|\n          if app.respond_to?(:mount_instance)\n            opts_with = opts.any? ? opts.first[:with] : {}\n            mount({ app.mount_instance(configuration: opts_with) => path }, *opts)\n            next\n          end\n          in_setting = inheritable_setting\n\n          if app.respond_to?(:inheritable_setting, true)\n            mount_path = Grape::Router.normalize_path(path)\n            app.top_level_setting.namespace_stackable[:mount_path] = mount_path\n\n            app.inherit_settings(inheritable_setting)\n\n            in_setting = app.top_level_setting\n\n            app.change!\n            change!\n          end\n\n          # When trying to mount multiple times the same endpoint, remove the previous ones\n          # from the list of endpoints if refresh_already_mounted parameter is true\n          refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false\n          if refresh_already_mounted && !endpoints.empty?\n            endpoints.delete_if do |endpoint|\n              endpoint.options[:app].to_s == app.to_s\n            end\n          end\n\n          endpoints << Grape::Endpoint.new(\n            in_setting,\n            method: :any,\n            path:,\n            app:,\n            route_options: { anchor: false },\n            forward_match: !app.respond_to?(:inheritable_setting),\n            for: self\n          )\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Routing\n      attr_reader :endpoints\n\n      def given(conditional_option, &)\n        return unless conditional_option\n\n        mounted(&)\n      end\n\n      def mounted(&block)\n        evaluate_as_instance_with_configuration(block, lazy: true)\n      end\n\n      def cascade(value = nil)\n        return inheritable_setting.namespace_inheritable.key?(:cascade) ? !inheritable_setting.namespace_inheritable[:cascade].nil? : true if value.nil?\n\n        inheritable_setting.namespace_inheritable[:cascade] = value\n      end\n\n      # Specify an API version.\n      #\n      # @example API with legacy support.\n      #   class MyAPI < Grape::API\n      #     version 'v2'\n      #\n      #     get '/main' do\n      #       {some: 'data'}\n      #     end\n      #\n      #     version 'v1' do\n      #       get '/main' do\n      #         {legacy: 'data'}\n      #       end\n      #     end\n      #   end\n      #\n      def version(*args, **options, &block)\n        if args.any?\n          options = options.reverse_merge(using: :path)\n          requested_versions = args.flatten.map(&:to_s)\n\n          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)\n\n          @versions = versions | requested_versions\n\n          if block\n            within_namespace do\n              inheritable_setting.namespace_inheritable[:version] = requested_versions\n              inheritable_setting.namespace_inheritable[:version_options] = options\n\n              instance_eval(&block)\n            end\n          else\n            inheritable_setting.namespace_inheritable[:version] = requested_versions\n            inheritable_setting.namespace_inheritable[:version_options] = options\n          end\n        end\n\n        @versions&.last\n      end\n\n      # Define a root URL prefix for your entire API.\n      def prefix(prefix = nil)\n        return inheritable_setting.namespace_inheritable[:root_prefix] if prefix.nil?\n\n        inheritable_setting.namespace_inheritable[:root_prefix] = prefix.to_s\n      end\n\n      # Create a scope without affecting the URL.\n      #\n      # @param _name [Symbol] Purely placebo, just allows to name the scope to\n      # make the code more readable.\n      def scope(_name = nil, &block)\n        within_namespace do\n          nest(block)\n        end\n      end\n\n      def build_with(build_with)\n        inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Do not route HEAD requests to GET requests automatically.\n      def do_not_route_head!\n        inheritable_setting.namespace_inheritable[:do_not_route_head] = true\n      end\n\n      # Do not automatically route OPTIONS.\n      def do_not_route_options!\n        inheritable_setting.namespace_inheritable[:do_not_route_options] = true\n      end\n\n      def lint!\n        inheritable_setting.namespace_inheritable[:lint] = true\n      end\n\n      def do_not_document!\n        inheritable_setting.namespace_inheritable[:do_not_document] = true\n      end\n\n      def mount(mounts, *opts)\n        mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)\n        mounts.each_pair do |app, path|\n          if app.respond_to?(:mount_instance)\n            opts_with = opts.any? ? opts.first[:with] : {}\n            mount({ app.mount_instance(configuration: opts_with) => path }, *opts)\n            next\n          end\n          in_setting = inheritable_setting\n\n          if app.respond_to?(:inheritable_setting, true)\n            mount_path = Grape::Router.normalize_path(path)\n            app.top_level_setting.namespace_stackable[:mount_path] = mount_path\n\n            app.inherit_settings(inheritable_setting)\n\n            in_setting = app.top_level_setting\n\n            app.change!\n            change!\n          end\n\n          # When trying to mount multiple times the same endpoint, remove the previous ones\n          # from the list of endpoints if refresh_already_mounted parameter is true\n          refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false\n          if refresh_already_mounted && !endpoints.empty?\n            endpoints.delete_if do |endpoint|\n              endpoint.options[:app].to_s == app.to_s\n            end\n          end\n\n          endpoints << Grape::Endpoint.new(\n            in_setting,\n            method: :any,\n            path:,\n            app:,\n            route_options: { anchor: false },\n            forward_match: !app.respond_to?(:inheritable_setting),\n            for: self\n          )\n        end\n      end\n\n      # Defines a route that will be recognized\n      # by the Grape API.\n      #\n      # @param methods [HTTP Verb] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.\n      # @param paths [String] One or more strings representing the URL segment(s) for this route.\n      #\n      # @example Defining a basic route.\n      #   class MyAPI < Grape::API\n      #     route(:any, '/hello') do\n      #       {hello: 'world'}\n      #     end\n      #   end\n      def route(methods, paths = ['/'], route_options = {}, &)\n        method = methods == :any ? '*' : methods\n        endpoint_params = inheritable_setting.namespace_stackable_with_hash(:params) || {}\n        endpoint_description = inheritable_setting.route[:description]\n        all_route_options = { params: endpoint_params }\n        all_route_options.deep_merge!(endpoint_description) if endpoint_description\n        all_route_options.deep_merge!(route_options) if route_options&.any?\n\n        new_endpoint = Grape::Endpoint.new(\n          inheritable_setting,\n          method:,\n          path: paths,\n          for: self,\n          route_options: all_route_options,\n          &\n        )\n        endpoints << new_endpoint unless endpoints.include?(new_endpoint)\n\n        inheritable_setting.route_end\n        reset_validations!\n      end\n\n      Grape::HTTP_SUPPORTED_METHODS.each do |supported_method|\n        define_method supported_method.downcase do |*args, **options, &block|\n          paths = args.first || ['/']\n          route(supported_method, paths, options, &block)\n        end\n      end\n\n      # Declare a \"namespace\", which prefixes all subordinate routes with its\n      # name. Any endpoints within a namespace, group, resource or segment,\n      # etc., will share their parent context as well as any configuration\n      # done in the namespace context.\n      #\n      # @example\n      #\n      #     namespace :foo do\n      #       get 'bar' do\n      #         # defines the endpoint: GET /foo/bar\n      #       end\n      #     end\n      def namespace(space = nil, requirements: nil, **options, &block)\n        return Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace]) unless space || block\n\n        within_namespace do\n          nest(block) do\n            inheritable_setting.namespace_stackable[:namespace] = Grape::Namespace.new(space, requirements:, **options) if space\n          end\n        end\n      end\n\n      alias group namespace\n      alias resource namespace\n      alias resources namespace\n      alias segment namespace\n\n      # An array of API routes.\n      def routes\n        @routes ||= endpoints.map(&:routes).flatten\n      end\n\n      # This method allows you to quickly define a parameter route segment\n      # in your API.\n      #\n      # @param param [Symbol] The name of the parameter you wish to declare.\n      # @option options [Regexp] You may supply a regular expression that the declared parameter must meet.\n      def route_param(param, requirements: nil, type: nil, **, &)\n        requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp)\n\n        Grape::Validations::ParamsScope.new(api: self) do\n          requires param, type: type\n        end if type\n\n        namespace(\":#{param}\", requirements:, **, &)\n      end\n\n      # @return array of defined versions\n      def versions\n        @versions ||= []\n      end\n\n      private\n\n      # Remove all defined routes.\n      def reset_routes!\n        endpoints.each(&:reset_routes!)\n        @routes = nil\n      end\n\n      def reset_endpoints!\n        @endpoints = []\n      end\n\n      def refresh_mounted_api(mounts, *opts)\n        opts << { refresh_already_mounted: true }\n        mount(mounts, *opts)\n      end\n\n      # Execute first the provided block, then each of the\n      # block passed in. Allows for simple 'before' setups\n      # of settings stack pushes.\n      def nest(*blocks, &block)\n        blocks.compact!\n        return instance_eval(&block) if blocks.empty?\n\n        evaluate_as_instance_with_configuration(block) if block\n        blocks.each { |b| evaluate_as_instance_with_configuration(b) }\n        reset_validations!\n      end\n\n      def evaluate_as_instance_with_configuration(block, lazy: false)\n        lazy_block = Grape::Util::Lazy::Block.new do |configuration|\n          value_for_configuration = configuration\n          self.configuration = value_for_configuration.evaluate if value_for_configuration.is_a?(Grape::Util::Lazy::Base)\n          response = instance_eval(&block)\n          self.configuration = value_for_configuration\n          response\n        end\n        return lazy_block if @base && base_instance? && lazy\n\n        lazy_block.evaluate_from(configuration)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "mount", "signature": "def mount(mounts, *opts)", "start_line": 105, "end_line": 146}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 551}
{"function_name": "route", "file_path": "grape/lib/grape/dsl/routing.rb", "focal_code": "def route(methods, paths = ['/'], route_options = {}, &)\n        method = methods == :any ? '*' : methods\n        endpoint_params = inheritable_setting.namespace_stackable_with_hash(:params) || {}\n        endpoint_description = inheritable_setting.route[:description]\n        all_route_options = { params: endpoint_params }\n        all_route_options.deep_merge!(endpoint_description) if endpoint_description\n        all_route_options.deep_merge!(route_options) if route_options&.any?\n\n        new_endpoint = Grape::Endpoint.new(\n          inheritable_setting,\n          method:,\n          path: paths,\n          for: self,\n          route_options: all_route_options,\n          &\n        )\n        endpoints << new_endpoint unless endpoints.include?(new_endpoint)\n\n        inheritable_setting.route_end\n        reset_validations!\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Routing\n      attr_reader :endpoints\n\n      def given(conditional_option, &)\n        return unless conditional_option\n\n        mounted(&)\n      end\n\n      def mounted(&block)\n        evaluate_as_instance_with_configuration(block, lazy: true)\n      end\n\n      def cascade(value = nil)\n        return inheritable_setting.namespace_inheritable.key?(:cascade) ? !inheritable_setting.namespace_inheritable[:cascade].nil? : true if value.nil?\n\n        inheritable_setting.namespace_inheritable[:cascade] = value\n      end\n\n      # Specify an API version.\n      #\n      # @example API with legacy support.\n      #   class MyAPI < Grape::API\n      #     version 'v2'\n      #\n      #     get '/main' do\n      #       {some: 'data'}\n      #     end\n      #\n      #     version 'v1' do\n      #       get '/main' do\n      #         {legacy: 'data'}\n      #       end\n      #     end\n      #   end\n      #\n      def version(*args, **options, &block)\n        if args.any?\n          options = options.reverse_merge(using: :path)\n          requested_versions = args.flatten.map(&:to_s)\n\n          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)\n\n          @versions = versions | requested_versions\n\n          if block\n            within_namespace do\n              inheritable_setting.namespace_inheritable[:version] = requested_versions\n              inheritable_setting.namespace_inheritable[:version_options] = options\n\n              instance_eval(&block)\n            end\n          else\n            inheritable_setting.namespace_inheritable[:version] = requested_versions\n            inheritable_setting.namespace_inheritable[:version_options] = options\n          end\n        end\n\n        @versions&.last\n      end\n\n      # Define a root URL prefix for your entire API.\n      def prefix(prefix = nil)\n        return inheritable_setting.namespace_inheritable[:root_prefix] if prefix.nil?\n\n        inheritable_setting.namespace_inheritable[:root_prefix] = prefix.to_s\n      end\n\n      # Create a scope without affecting the URL.\n      #\n      # @param _name [Symbol] Purely placebo, just allows to name the scope to\n      # make the code more readable.\n      def scope(_name = nil, &block)\n        within_namespace do\n          nest(block)\n        end\n      end\n\n      def build_with(build_with)\n        inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Do not route HEAD requests to GET requests automatically.\n      def do_not_route_head!\n        inheritable_setting.namespace_inheritable[:do_not_route_head] = true\n      end\n\n      # Do not automatically route OPTIONS.\n      def do_not_route_options!\n        inheritable_setting.namespace_inheritable[:do_not_route_options] = true\n      end\n\n      def lint!\n        inheritable_setting.namespace_inheritable[:lint] = true\n      end\n\n      def do_not_document!\n        inheritable_setting.namespace_inheritable[:do_not_document] = true\n      end\n\n      def mount(mounts, *opts)\n        mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)\n        mounts.each_pair do |app, path|\n          if app.respond_to?(:mount_instance)\n            opts_with = opts.any? ? opts.first[:with] : {}\n            mount({ app.mount_instance(configuration: opts_with) => path }, *opts)\n            next\n          end\n          in_setting = inheritable_setting\n\n          if app.respond_to?(:inheritable_setting, true)\n            mount_path = Grape::Router.normalize_path(path)\n            app.top_level_setting.namespace_stackable[:mount_path] = mount_path\n\n            app.inherit_settings(inheritable_setting)\n\n            in_setting = app.top_level_setting\n\n            app.change!\n            change!\n          end\n\n          # When trying to mount multiple times the same endpoint, remove the previous ones\n          # from the list of endpoints if refresh_already_mounted parameter is true\n          refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false\n          if refresh_already_mounted && !endpoints.empty?\n            endpoints.delete_if do |endpoint|\n              endpoint.options[:app].to_s == app.to_s\n            end\n          end\n\n          endpoints << Grape::Endpoint.new(\n            in_setting,\n            method: :any,\n            path:,\n            app:,\n            route_options: { anchor: false },\n            forward_match: !app.respond_to?(:inheritable_setting),\n            for: self\n          )\n        end\n      end\n\n      # Defines a route that will be recognized\n      # by the Grape API.\n      #\n      # @param methods [HTTP Verb] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.\n      # @param paths [String] One or more strings representing the URL segment(s) for this route.\n      #\n      # @example Defining a basic route.\n      #   class MyAPI < Grape::API\n      #     route(:any, '/hello') do\n      #       {hello: 'world'}\n      #     end\n      #   end\n      def route(methods, paths = ['/'], route_options = {}, &)\n        method = methods == :any ? '*' : methods\n        endpoint_params = inheritable_setting.namespace_stackable_with_hash(:params) || {}\n        endpoint_description = inheritable_setting.route[:description]\n        all_route_options = { params: endpoint_params }\n        all_route_options.deep_merge!(endpoint_description) if endpoint_description\n        all_route_options.deep_merge!(route_options) if route_options&.any?\n\n        new_endpoint = Grape::Endpoint.new(\n          inheritable_setting,\n          method:,\n          path: paths,\n          for: self,\n          route_options: all_route_options,\n          &\n        )\n        endpoints << new_endpoint unless endpoints.include?(new_endpoint)\n\n        inheritable_setting.route_end\n        reset_validations!\n      end\n\n      Grape::HTTP_SUPPORTED_METHODS.each do |supported_method|\n        define_method supported_method.downcase do |*args, **options, &block|\n          paths = args.first || ['/']\n          route(supported_method, paths, options, &block)\n        end\n      end\n\n      # Declare a \"namespace\", which prefixes all subordinate routes with its\n      # name. Any endpoints within a namespace, group, resource or segment,\n      # etc., will share their parent context as well as any configuration\n      # done in the namespace context.\n      #\n      # @example\n      #\n      #     namespace :foo do\n      #       get 'bar' do\n      #         # defines the endpoint: GET /foo/bar\n      #       end\n      #     end\n      def namespace(space = nil, requirements: nil, **options, &block)\n        return Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace]) unless space || block\n\n        within_namespace do\n          nest(block) do\n            inheritable_setting.namespace_stackable[:namespace] = Grape::Namespace.new(space, requirements:, **options) if space\n          end\n        end\n      end\n\n      alias group namespace\n      alias resource namespace\n      alias resources namespace\n      alias segment namespace\n\n      # An array of API routes.\n      def routes\n        @routes ||= endpoints.map(&:routes).flatten\n      end\n\n      # This method allows you to quickly define a parameter route segment\n      # in your API.\n      #\n      # @param param [Symbol] The name of the parameter you wish to declare.\n      # @option options [Regexp] You may supply a regular expression that the declared parameter must meet.\n      def route_param(param, requirements: nil, type: nil, **, &)\n        requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp)\n\n        Grape::Validations::ParamsScope.new(api: self) do\n          requires param, type: type\n        end if type\n\n        namespace(\":#{param}\", requirements:, **, &)\n      end\n\n      # @return array of defined versions\n      def versions\n        @versions ||= []\n      end\n\n      private\n\n      # Remove all defined routes.\n      def reset_routes!\n        endpoints.each(&:reset_routes!)\n        @routes = nil\n      end\n\n      def reset_endpoints!\n        @endpoints = []\n      end\n\n      def refresh_mounted_api(mounts, *opts)\n        opts << { refresh_already_mounted: true }\n        mount(mounts, *opts)\n      end\n\n      # Execute first the provided block, then each of the\n      # block passed in. Allows for simple 'before' setups\n      # of settings stack pushes.\n      def nest(*blocks, &block)\n        blocks.compact!\n        return instance_eval(&block) if blocks.empty?\n\n        evaluate_as_instance_with_configuration(block) if block\n        blocks.each { |b| evaluate_as_instance_with_configuration(b) }\n        reset_validations!\n      end\n\n      def evaluate_as_instance_with_configuration(block, lazy: false)\n        lazy_block = Grape::Util::Lazy::Block.new do |configuration|\n          value_for_configuration = configuration\n          self.configuration = value_for_configuration.evaluate if value_for_configuration.is_a?(Grape::Util::Lazy::Base)\n          response = instance_eval(&block)\n          self.configuration = value_for_configuration\n          response\n        end\n        return lazy_block if @base && base_instance? && lazy\n\n        lazy_block.evaluate_from(configuration)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "route", "signature": "def route(methods, paths = ['/'], route_options = {}, &)", "start_line": 160, "end_line": 180}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 552}
{"function_name": "evaluate_as_instance_with_configuration", "file_path": "grape/lib/grape/dsl/routing.rb", "focal_code": "def evaluate_as_instance_with_configuration(block, lazy: false)\n        lazy_block = Grape::Util::Lazy::Block.new do |configuration|\n          value_for_configuration = configuration\n          self.configuration = value_for_configuration.evaluate if value_for_configuration.is_a?(Grape::Util::Lazy::Base)\n          response = instance_eval(&block)\n          self.configuration = value_for_configuration\n          response\n        end\n        return lazy_block if @base && base_instance? && lazy\n\n        lazy_block.evaluate_from(configuration)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Routing\n      attr_reader :endpoints\n\n      def given(conditional_option, &)\n        return unless conditional_option\n\n        mounted(&)\n      end\n\n      def mounted(&block)\n        evaluate_as_instance_with_configuration(block, lazy: true)\n      end\n\n      def cascade(value = nil)\n        return inheritable_setting.namespace_inheritable.key?(:cascade) ? !inheritable_setting.namespace_inheritable[:cascade].nil? : true if value.nil?\n\n        inheritable_setting.namespace_inheritable[:cascade] = value\n      end\n\n      # Specify an API version.\n      #\n      # @example API with legacy support.\n      #   class MyAPI < Grape::API\n      #     version 'v2'\n      #\n      #     get '/main' do\n      #       {some: 'data'}\n      #     end\n      #\n      #     version 'v1' do\n      #       get '/main' do\n      #         {legacy: 'data'}\n      #       end\n      #     end\n      #   end\n      #\n      def version(*args, **options, &block)\n        if args.any?\n          options = options.reverse_merge(using: :path)\n          requested_versions = args.flatten.map(&:to_s)\n\n          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)\n\n          @versions = versions | requested_versions\n\n          if block\n            within_namespace do\n              inheritable_setting.namespace_inheritable[:version] = requested_versions\n              inheritable_setting.namespace_inheritable[:version_options] = options\n\n              instance_eval(&block)\n            end\n          else\n            inheritable_setting.namespace_inheritable[:version] = requested_versions\n            inheritable_setting.namespace_inheritable[:version_options] = options\n          end\n        end\n\n        @versions&.last\n      end\n\n      # Define a root URL prefix for your entire API.\n      def prefix(prefix = nil)\n        return inheritable_setting.namespace_inheritable[:root_prefix] if prefix.nil?\n\n        inheritable_setting.namespace_inheritable[:root_prefix] = prefix.to_s\n      end\n\n      # Create a scope without affecting the URL.\n      #\n      # @param _name [Symbol] Purely placebo, just allows to name the scope to\n      # make the code more readable.\n      def scope(_name = nil, &block)\n        within_namespace do\n          nest(block)\n        end\n      end\n\n      def build_with(build_with)\n        inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Do not route HEAD requests to GET requests automatically.\n      def do_not_route_head!\n        inheritable_setting.namespace_inheritable[:do_not_route_head] = true\n      end\n\n      # Do not automatically route OPTIONS.\n      def do_not_route_options!\n        inheritable_setting.namespace_inheritable[:do_not_route_options] = true\n      end\n\n      def lint!\n        inheritable_setting.namespace_inheritable[:lint] = true\n      end\n\n      def do_not_document!\n        inheritable_setting.namespace_inheritable[:do_not_document] = true\n      end\n\n      def mount(mounts, *opts)\n        mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)\n        mounts.each_pair do |app, path|\n          if app.respond_to?(:mount_instance)\n            opts_with = opts.any? ? opts.first[:with] : {}\n            mount({ app.mount_instance(configuration: opts_with) => path }, *opts)\n            next\n          end\n          in_setting = inheritable_setting\n\n          if app.respond_to?(:inheritable_setting, true)\n            mount_path = Grape::Router.normalize_path(path)\n            app.top_level_setting.namespace_stackable[:mount_path] = mount_path\n\n            app.inherit_settings(inheritable_setting)\n\n            in_setting = app.top_level_setting\n\n            app.change!\n            change!\n          end\n\n          # When trying to mount multiple times the same endpoint, remove the previous ones\n          # from the list of endpoints if refresh_already_mounted parameter is true\n          refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false\n          if refresh_already_mounted && !endpoints.empty?\n            endpoints.delete_if do |endpoint|\n              endpoint.options[:app].to_s == app.to_s\n            end\n          end\n\n          endpoints << Grape::Endpoint.new(\n            in_setting,\n            method: :any,\n            path:,\n            app:,\n            route_options: { anchor: false },\n            forward_match: !app.respond_to?(:inheritable_setting),\n            for: self\n          )\n        end\n      end\n\n      # Defines a route that will be recognized\n      # by the Grape API.\n      #\n      # @param methods [HTTP Verb] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.\n      # @param paths [String] One or more strings representing the URL segment(s) for this route.\n      #\n      # @example Defining a basic route.\n      #   class MyAPI < Grape::API\n      #     route(:any, '/hello') do\n      #       {hello: 'world'}\n      #     end\n      #   end\n      def route(methods, paths = ['/'], route_options = {}, &)\n        method = methods == :any ? '*' : methods\n        endpoint_params = inheritable_setting.namespace_stackable_with_hash(:params) || {}\n        endpoint_description = inheritable_setting.route[:description]\n        all_route_options = { params: endpoint_params }\n        all_route_options.deep_merge!(endpoint_description) if endpoint_description\n        all_route_options.deep_merge!(route_options) if route_options&.any?\n\n        new_endpoint = Grape::Endpoint.new(\n          inheritable_setting,\n          method:,\n          path: paths,\n          for: self,\n          route_options: all_route_options,\n          &\n        )\n        endpoints << new_endpoint unless endpoints.include?(new_endpoint)\n\n        inheritable_setting.route_end\n        reset_validations!\n      end\n\n      Grape::HTTP_SUPPORTED_METHODS.each do |supported_method|\n        define_method supported_method.downcase do |*args, **options, &block|\n          paths = args.first || ['/']\n          route(supported_method, paths, options, &block)\n        end\n      end\n\n      # Declare a \"namespace\", which prefixes all subordinate routes with its\n      # name. Any endpoints within a namespace, group, resource or segment,\n      # etc., will share their parent context as well as any configuration\n      # done in the namespace context.\n      #\n      # @example\n      #\n      #     namespace :foo do\n      #       get 'bar' do\n      #         # defines the endpoint: GET /foo/bar\n      #       end\n      #     end\n      def namespace(space = nil, requirements: nil, **options, &block)\n        return Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace]) unless space || block\n\n        within_namespace do\n          nest(block) do\n            inheritable_setting.namespace_stackable[:namespace] = Grape::Namespace.new(space, requirements:, **options) if space\n          end\n        end\n      end\n\n      alias group namespace\n      alias resource namespace\n      alias resources namespace\n      alias segment namespace\n\n      # An array of API routes.\n      def routes\n        @routes ||= endpoints.map(&:routes).flatten\n      end\n\n      # This method allows you to quickly define a parameter route segment\n      # in your API.\n      #\n      # @param param [Symbol] The name of the parameter you wish to declare.\n      # @option options [Regexp] You may supply a regular expression that the declared parameter must meet.\n      def route_param(param, requirements: nil, type: nil, **, &)\n        requirements = { param.to_sym => requirements } if requirements.is_a?(Regexp)\n\n        Grape::Validations::ParamsScope.new(api: self) do\n          requires param, type: type\n        end if type\n\n        namespace(\":#{param}\", requirements:, **, &)\n      end\n\n      # @return array of defined versions\n      def versions\n        @versions ||= []\n      end\n\n      private\n\n      # Remove all defined routes.\n      def reset_routes!\n        endpoints.each(&:reset_routes!)\n        @routes = nil\n      end\n\n      def reset_endpoints!\n        @endpoints = []\n      end\n\n      def refresh_mounted_api(mounts, *opts)\n        opts << { refresh_already_mounted: true }\n        mount(mounts, *opts)\n      end\n\n      # Execute first the provided block, then each of the\n      # block passed in. Allows for simple 'before' setups\n      # of settings stack pushes.\n      def nest(*blocks, &block)\n        blocks.compact!\n        return instance_eval(&block) if blocks.empty?\n\n        evaluate_as_instance_with_configuration(block) if block\n        blocks.each { |b| evaluate_as_instance_with_configuration(b) }\n        reset_validations!\n      end\n\n      def evaluate_as_instance_with_configuration(block, lazy: false)\n        lazy_block = Grape::Util::Lazy::Block.new do |configuration|\n          value_for_configuration = configuration\n          self.configuration = value_for_configuration.evaluate if value_for_configuration.is_a?(Grape::Util::Lazy::Base)\n          response = instance_eval(&block)\n          self.configuration = value_for_configuration\n          response\n        end\n        return lazy_block if @base && base_instance? && lazy\n\n        lazy_block.evaluate_from(configuration)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "evaluate_as_instance_with_configuration", "signature": "def evaluate_as_instance_with_configuration(block, lazy: false)", "start_line": 270, "end_line": 281}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 553}
{"function_name": "present", "file_path": "grape/lib/grape/dsl/entity.rb", "focal_code": "def present(*args, root: nil, with: nil, **options)\n        key, object = args.count == 2 && args.first.is_a?(Symbol) ? args : [nil, args.first]\n        entity_class = with || entity_class_for_obj(object)\n        representation = entity_class ? entity_representation_for(entity_class, object, options) : object\n        representation = { root => representation } if root\n\n        if key\n          representation = body&.merge(key => representation) || { key => representation }\n        elsif entity_class.present? && body\n          raise ArgumentError, \"Representation of type #{representation.class} cannot be merged.\" unless representation.respond_to?(:merge)\n\n          representation = body.merge(representation)\n        end\n\n        body representation\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Entity\n      # Allows you to make use of Grape Entities by setting\n      # the response body to the serializable hash of the\n      # entity provided in the `:with` option. This has the\n      # added benefit of automatically passing along environment\n      # and version information to the serialization, making it\n      # very easy to do conditional exposures. See Entity docs\n      # for more info.\n      #\n      # @param args [Array] either `(object)` or `(key, object)` where key is a Symbol\n      #   used to nest the representation under that key in the response body.\n      # @param root [Symbol, String, nil] wraps the representation under this root key.\n      # @param with [Class, nil] the entity class to use for representation.\n      #   If omitted, the entity class is inferred from the object via {#entity_class_for_obj}.\n      # @param options [Hash] additional options forwarded to the entity's `represent` call.\n      #\n      # @example\n      #\n      #   get '/users/:id' do\n      #     present User.find(params[:id]),\n      #       with: API::Entities::User,\n      #       admin: current_user.admin?\n      #   end\n      def present(*args, root: nil, with: nil, **options)\n        key, object = args.count == 2 && args.first.is_a?(Symbol) ? args : [nil, args.first]\n        entity_class = with || entity_class_for_obj(object)\n        representation = entity_class ? entity_representation_for(entity_class, object, options) : object\n        representation = { root => representation } if root\n\n        if key\n          representation = body&.merge(key => representation) || { key => representation }\n        elsif entity_class.present? && body\n          raise ArgumentError, \"Representation of type #{representation.class} cannot be merged.\" unless representation.respond_to?(:merge)\n\n          representation = body.merge(representation)\n        end\n\n        body representation\n      end\n\n      # Attempt to locate the Entity class for a given object, if not given\n      # explicitly. This is done by looking for the presence of Klass::Entity,\n      # where Klass is the class of the `object` parameter, or one of its\n      # ancestors.\n      # @param object [Object] the object to locate the Entity class for\n      # @return [Class] the located Entity class, or nil if none is found\n      def entity_class_for_obj(object)\n        object_class =\n          if object.respond_to?(:klass)\n            object.klass\n          elsif object.respond_to?(:first)\n            object.first.class\n          else\n            object.class\n          end\n\n        representations = inheritable_setting.namespace_stackable_with_hash(:representations)\n        if representations\n          potential = object_class.ancestors.detect { |potential| representations.key?(potential) }\n          return representations[potential] if potential && representations[potential]\n        end\n\n        return unless object_class.const_defined?(:Entity)\n\n        entity = object_class.const_get(:Entity)\n        entity if entity.respond_to?(:represent)\n      end\n\n      private\n\n      # @param entity_class [Class] the entity class to use for representation.\n      # @param object [Object] the object to represent.\n      # @param options [Hash] additional options forwarded to the entity's `represent` call.\n      # @return the representation of the given object as done through the given entity_class.\n      def entity_representation_for(entity_class, object, options)\n        embeds = env.key?(Grape::Env::API_VERSION) ? { env:, version: env[Grape::Env::API_VERSION] } : { env: }\n        entity_class.represent(object, **embeds, **options)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "present", "signature": "def present(*args, root: nil, with: nil, **options)", "start_line": 28, "end_line": 43}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 554}
{"function_name": "entity_class_for_obj", "file_path": "grape/lib/grape/dsl/entity.rb", "focal_code": "def entity_class_for_obj(object)\n        object_class =\n          if object.respond_to?(:klass)\n            object.klass\n          elsif object.respond_to?(:first)\n            object.first.class\n          else\n            object.class\n          end\n\n        representations = inheritable_setting.namespace_stackable_with_hash(:representations)\n        if representations\n          potential = object_class.ancestors.detect { |potential| representations.key?(potential) }\n          return representations[potential] if potential && representations[potential]\n        end\n\n        return unless object_class.const_defined?(:Entity)\n\n        entity = object_class.const_get(:Entity)\n        entity if entity.respond_to?(:represent)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Entity\n      # Allows you to make use of Grape Entities by setting\n      # the response body to the serializable hash of the\n      # entity provided in the `:with` option. This has the\n      # added benefit of automatically passing along environment\n      # and version information to the serialization, making it\n      # very easy to do conditional exposures. See Entity docs\n      # for more info.\n      #\n      # @param args [Array] either `(object)` or `(key, object)` where key is a Symbol\n      #   used to nest the representation under that key in the response body.\n      # @param root [Symbol, String, nil] wraps the representation under this root key.\n      # @param with [Class, nil] the entity class to use for representation.\n      #   If omitted, the entity class is inferred from the object via {#entity_class_for_obj}.\n      # @param options [Hash] additional options forwarded to the entity's `represent` call.\n      #\n      # @example\n      #\n      #   get '/users/:id' do\n      #     present User.find(params[:id]),\n      #       with: API::Entities::User,\n      #       admin: current_user.admin?\n      #   end\n      def present(*args, root: nil, with: nil, **options)\n        key, object = args.count == 2 && args.first.is_a?(Symbol) ? args : [nil, args.first]\n        entity_class = with || entity_class_for_obj(object)\n        representation = entity_class ? entity_representation_for(entity_class, object, options) : object\n        representation = { root => representation } if root\n\n        if key\n          representation = body&.merge(key => representation) || { key => representation }\n        elsif entity_class.present? && body\n          raise ArgumentError, \"Representation of type #{representation.class} cannot be merged.\" unless representation.respond_to?(:merge)\n\n          representation = body.merge(representation)\n        end\n\n        body representation\n      end\n\n      # Attempt to locate the Entity class for a given object, if not given\n      # explicitly. This is done by looking for the presence of Klass::Entity,\n      # where Klass is the class of the `object` parameter, or one of its\n      # ancestors.\n      # @param object [Object] the object to locate the Entity class for\n      # @return [Class] the located Entity class, or nil if none is found\n      def entity_class_for_obj(object)\n        object_class =\n          if object.respond_to?(:klass)\n            object.klass\n          elsif object.respond_to?(:first)\n            object.first.class\n          else\n            object.class\n          end\n\n        representations = inheritable_setting.namespace_stackable_with_hash(:representations)\n        if representations\n          potential = object_class.ancestors.detect { |potential| representations.key?(potential) }\n          return representations[potential] if potential && representations[potential]\n        end\n\n        return unless object_class.const_defined?(:Entity)\n\n        entity = object_class.const_get(:Entity)\n        entity if entity.respond_to?(:represent)\n      end\n\n      private\n\n      # @param entity_class [Class] the entity class to use for representation.\n      # @param object [Object] the object to represent.\n      # @param options [Hash] additional options forwarded to the entity's `represent` call.\n      # @return the representation of the given object as done through the given entity_class.\n      def entity_representation_for(entity_class, object, options)\n        embeds = env.key?(Grape::Env::API_VERSION) ? { env:, version: env[Grape::Env::API_VERSION] } : { env: }\n        entity_class.represent(object, **embeds, **options)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "entity_class_for_obj", "signature": "def entity_class_for_obj(object)", "start_line": 51, "end_line": 71}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 555}
{"function_name": "rescue_from", "file_path": "grape/lib/grape/dsl/request_response.rb", "focal_code": "def rescue_from(*args, with: nil, **options, &block)\n        handler = extract_handler(args, with:, block:)\n\n        if args.include?(:all)\n          inheritable_setting.namespace_inheritable[:rescue_all] = true\n          inheritable_setting.namespace_inheritable[:all_rescue_handler] = handler\n        elsif args.include?(:grape_exceptions)\n          inheritable_setting.namespace_inheritable[:rescue_all] = true\n          inheritable_setting.namespace_inheritable[:rescue_grape_exceptions] = true\n          inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler] = handler\n        else\n          handler_type =\n            case options[:rescue_subclasses]\n            when nil, true\n              :rescue_handlers\n            else\n              :base_only_rescue_handlers\n            end\n\n          inheritable_setting.namespace_reverse_stackable[handler_type] = args.to_h { |arg| [arg, handler] }\n        end\n\n        inheritable_setting.namespace_stackable[:rescue_options] = options\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module RequestResponse\n      # Specify the default format for the API's serializers.\n      # May be `:json` or `:txt` (default).\n      def default_format(new_format = nil)\n        return inheritable_setting.namespace_inheritable[:default_format] if new_format.nil?\n\n        inheritable_setting.namespace_inheritable[:default_format] = new_format.to_sym\n      end\n\n      # Specify the format for the API's serializers.\n      # May be `:json`, `:xml`, `:txt`, etc.\n      def format(new_format = nil)\n        return inheritable_setting.namespace_inheritable[:format] if new_format.nil?\n\n        symbolic_new_format = new_format.to_sym\n        inheritable_setting.namespace_inheritable[:format] = symbolic_new_format\n        inheritable_setting.namespace_inheritable[:default_error_formatter] = Grape::ErrorFormatter.formatter_for(symbolic_new_format)\n\n        content_type = content_types[symbolic_new_format]\n        raise Grape::Exceptions::MissingMimeType.new(new_format) unless content_type\n\n        inheritable_setting.namespace_stackable[:content_types] = { symbolic_new_format => content_type }\n      end\n\n      # Specify a custom formatter for a content-type.\n      def formatter(content_type, new_formatter)\n        inheritable_setting.namespace_stackable[:formatters] = { content_type.to_sym => new_formatter }\n      end\n\n      # Specify a custom parser for a content-type.\n      def parser(content_type, new_parser)\n        inheritable_setting.namespace_stackable[:parsers] = { content_type.to_sym => new_parser }\n      end\n\n      # Specify a default error formatter.\n      def default_error_formatter(new_formatter_name = nil)\n        return inheritable_setting.namespace_inheritable[:default_error_formatter] if new_formatter_name.nil?\n\n        new_formatter = Grape::ErrorFormatter.formatter_for(new_formatter_name)\n        inheritable_setting.namespace_inheritable[:default_error_formatter] = new_formatter\n      end\n\n      def error_formatter(format, options = nil, with: nil)\n        formatter = with || options\n        inheritable_setting.namespace_stackable[:error_formatters] = { format.to_sym => formatter }\n      end\n\n      # Specify additional content-types, e.g.:\n      #   content_type :xls, 'application/vnd.ms-excel'\n      def content_type(key, val)\n        inheritable_setting.namespace_stackable[:content_types] = { key.to_sym => val }\n      end\n\n      # All available content types.\n      def content_types\n        c_types = inheritable_setting.namespace_stackable_with_hash(:content_types)\n        Grape::ContentTypes.content_types_for c_types\n      end\n\n      # Specify the default status code for errors.\n      def default_error_status(new_status = nil)\n        return inheritable_setting.namespace_inheritable[:default_error_status] if new_status.nil?\n\n        inheritable_setting.namespace_inheritable[:default_error_status] = new_status\n      end\n\n      # Allows you to rescue certain exceptions that occur to return\n      # a grape error rather than raising all the way to the\n      # server level.\n      #\n      # @example Rescue from custom exceptions\n      #     class ExampleAPI < Grape::API\n      #       class CustomError < StandardError; end\n      #\n      #       rescue_from CustomError\n      #     end\n      #\n      # @overload rescue_from(*exception_classes, **options)\n      #   @param [Array] exception_classes A list of classes that you want to rescue, or\n      #     the symbol :all to rescue from all exceptions.\n      #   @param [Block] block Execution block to handle the given exception.\n      #   @param [Hash] options Options for the rescue usage.\n      #   @option options [Boolean] :backtrace Include a backtrace in the rescue response.\n      #   @option options [Boolean] :rescue_subclasses Also rescue subclasses of exception classes\n      #   @param [Proc] handler Execution proc to handle the given exception as an\n      #     alternative to passing a block.\n      def rescue_from(*args, with: nil, **options, &block)\n        handler = extract_handler(args, with:, block:)\n\n        if args.include?(:all)\n          inheritable_setting.namespace_inheritable[:rescue_all] = true\n          inheritable_setting.namespace_inheritable[:all_rescue_handler] = handler\n        elsif args.include?(:grape_exceptions)\n          inheritable_setting.namespace_inheritable[:rescue_all] = true\n          inheritable_setting.namespace_inheritable[:rescue_grape_exceptions] = true\n          inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler] = handler\n        else\n          handler_type =\n            case options[:rescue_subclasses]\n            when nil, true\n              :rescue_handlers\n            else\n              :base_only_rescue_handlers\n            end\n\n          inheritable_setting.namespace_reverse_stackable[handler_type] = args.to_h { |arg| [arg, handler] }\n        end\n\n        inheritable_setting.namespace_stackable[:rescue_options] = options\n      end\n\n      # Allows you to specify a default representation entity for a\n      # class. This allows you to map your models to their respective\n      # entities once and then simply call `present` with the model.\n      #\n      # @example\n      #   class ExampleAPI < Grape::API\n      #     represent User, with: Entity::User\n      #\n      #     get '/me' do\n      #       present current_user # with: Entity::User is assumed\n      #     end\n      #   end\n      #\n      # Note that Grape will automatically go up the class ancestry to\n      # try to find a representing entity, so if you, for example, define\n      # an entity to represent `Object` then all presented objects will\n      # bubble up and utilize the entity provided on that `represent` call.\n      #\n      # @param model_class [Class] The model class that will be represented.\n      # @option options [Class] :with The entity class that will represent the model.\n      def represent(model_class, with:)\n        raise Grape::Exceptions::InvalidWithOptionForRepresent.new unless with.is_a?(Class)\n\n        inheritable_setting.namespace_stackable[:representations] = { model_class => with }\n      end\n\n      private\n\n      def extract_handler(args, with:, block:)\n        raise ArgumentError, 'both :with option and block cannot be passed' if block && with\n\n        return args.pop if args.last.is_a?(Proc)\n        return block if block\n        return with if with.instance_of?(Proc) || with.instance_of?(Symbol)\n        return with.to_sym if with.instance_of?(String)\n\n        raise ArgumentError, \"with: #{with.class}, expected Symbol, String or Proc\" if with\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "rescue_from", "signature": "def rescue_from(*args, with: nil, **options, &block)", "start_line": 91, "end_line": 114}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 556}
{"function_name": "error!", "file_path": "grape/lib/grape/dsl/inside_route.rb", "focal_code": "def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module InsideRoute\n      include Declared\n      include Entity\n\n      # Backward compatibility: alias exception class to previous location\n      MethodNotYetAvailable = Declared::MethodNotYetAvailable\n\n      # The API version as specified in the URL.\n      def version\n        env[Grape::Env::API_VERSION]\n      end\n\n      def configuration\n        options[:for].configuration.evaluate\n      end\n\n      # End the request and display an error to the\n      # end user with the specified message.\n      #\n      # @param message [String] The message to display.\n      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.\n      # @param additional_headers [Hash] Addtional headers for the response.\n      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.\n      # @param original_exception [Exception] The original exception that caused the error.\n      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end\n\n      # Redirect to a new url.\n      #\n      # @param url [String] The url to be redirect.\n      # @param permanent [Boolean] default false.\n      # @param body default a short message including the URL.\n      def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end\n\n      # Set or retrieve the HTTP status code.\n      #\n      # @param status [Integer] The HTTP Status Code to return for this request.\n      def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end\n\n      # Set response content-type\n      def content_type(val = nil)\n        if val\n          header(Rack::CONTENT_TYPE, val)\n        else\n          header[Rack::CONTENT_TYPE]\n        end\n      end\n\n      # Allows you to define the response body as something other than the\n      # return value.\n      #\n      # @example\n      #   get '/body' do\n      #     body \"Body\"\n      #     \"Not the Body\"\n      #   end\n      #\n      #   GET /body # => \"Body\"\n      def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end\n\n      # Allows you to explicitly return no content.\n      #\n      # @example\n      #   delete :id do\n      #     return_no_content\n      #     \"not returned\"\n      #   end\n      #\n      #   DELETE /12 # => 204 No Content, \"\"\n      def return_no_content\n        status 204\n        body false\n      end\n\n      # Allows you to send a file to the client via sendfile.\n      #\n      # @example\n      #   get '/file' do\n      #     sendfile FileStreamer.new(...)\n      #   end\n      #\n      #   GET /file # => \"contents of file\"\n      def sendfile(value = nil)\n        return stream if value.nil?\n\n        raise ArgumentError, 'Argument must be a file path' unless value.is_a?(String)\n\n        file_body = Grape::ServeStream::FileBody.new(value)\n        @stream = Grape::ServeStream::StreamResponse.new(file_body)\n      end\n\n      # Allows you to define the response as a streamable object.\n      #\n      # If Content-Length and Transfer-Encoding are blank (among other conditions),\n      # Rack assumes this response can be streamed in chunks.\n      #\n      # @example\n      #   get '/stream' do\n      #     stream FileStreamer.new(...)\n      #   end\n      #\n      #   GET /stream # => \"chunked contents of file\"\n      #\n      # See:\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/chunked.rb\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/etag.rb\n      def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end\n\n      # Returns route information for the current request.\n      #\n      # @example\n      #\n      #   desc \"Returns the route description.\"\n      #   get '/' do\n      #     route.description\n      #   end\n      def route\n        env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]\n      end\n\n      def http_version\n        env.fetch('HTTP_VERSION') { env[Rack::SERVER_PROTOCOL] }\n      end\n\n      def api_format(format)\n        env[Grape::Env::API_FORMAT] = format\n      end\n\n      def context\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "error!", "signature": "def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)", "start_line": 29, "end_line": 38}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 557}
{"function_name": "redirect", "file_path": "grape/lib/grape/dsl/inside_route.rb", "focal_code": "def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module InsideRoute\n      include Declared\n      include Entity\n\n      # Backward compatibility: alias exception class to previous location\n      MethodNotYetAvailable = Declared::MethodNotYetAvailable\n\n      # The API version as specified in the URL.\n      def version\n        env[Grape::Env::API_VERSION]\n      end\n\n      def configuration\n        options[:for].configuration.evaluate\n      end\n\n      # End the request and display an error to the\n      # end user with the specified message.\n      #\n      # @param message [String] The message to display.\n      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.\n      # @param additional_headers [Hash] Addtional headers for the response.\n      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.\n      # @param original_exception [Exception] The original exception that caused the error.\n      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end\n\n      # Redirect to a new url.\n      #\n      # @param url [String] The url to be redirect.\n      # @param permanent [Boolean] default false.\n      # @param body default a short message including the URL.\n      def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end\n\n      # Set or retrieve the HTTP status code.\n      #\n      # @param status [Integer] The HTTP Status Code to return for this request.\n      def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end\n\n      # Set response content-type\n      def content_type(val = nil)\n        if val\n          header(Rack::CONTENT_TYPE, val)\n        else\n          header[Rack::CONTENT_TYPE]\n        end\n      end\n\n      # Allows you to define the response body as something other than the\n      # return value.\n      #\n      # @example\n      #   get '/body' do\n      #     body \"Body\"\n      #     \"Not the Body\"\n      #   end\n      #\n      #   GET /body # => \"Body\"\n      def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end\n\n      # Allows you to explicitly return no content.\n      #\n      # @example\n      #   delete :id do\n      #     return_no_content\n      #     \"not returned\"\n      #   end\n      #\n      #   DELETE /12 # => 204 No Content, \"\"\n      def return_no_content\n        status 204\n        body false\n      end\n\n      # Allows you to send a file to the client via sendfile.\n      #\n      # @example\n      #   get '/file' do\n      #     sendfile FileStreamer.new(...)\n      #   end\n      #\n      #   GET /file # => \"contents of file\"\n      def sendfile(value = nil)\n        return stream if value.nil?\n\n        raise ArgumentError, 'Argument must be a file path' unless value.is_a?(String)\n\n        file_body = Grape::ServeStream::FileBody.new(value)\n        @stream = Grape::ServeStream::StreamResponse.new(file_body)\n      end\n\n      # Allows you to define the response as a streamable object.\n      #\n      # If Content-Length and Transfer-Encoding are blank (among other conditions),\n      # Rack assumes this response can be streamed in chunks.\n      #\n      # @example\n      #   get '/stream' do\n      #     stream FileStreamer.new(...)\n      #   end\n      #\n      #   GET /stream # => \"chunked contents of file\"\n      #\n      # See:\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/chunked.rb\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/etag.rb\n      def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end\n\n      # Returns route information for the current request.\n      #\n      # @example\n      #\n      #   desc \"Returns the route description.\"\n      #   get '/' do\n      #     route.description\n      #   end\n      def route\n        env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]\n      end\n\n      def http_version\n        env.fetch('HTTP_VERSION') { env[Rack::SERVER_PROTOCOL] }\n      end\n\n      def api_format(format)\n        env[Grape::Env::API_FORMAT] = format\n      end\n\n      def context\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "redirect", "signature": "def redirect(url, permanent: false, body: nil)", "start_line": 45, "end_line": 60}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 558}
{"function_name": "status", "file_path": "grape/lib/grape/dsl/inside_route.rb", "focal_code": "def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module InsideRoute\n      include Declared\n      include Entity\n\n      # Backward compatibility: alias exception class to previous location\n      MethodNotYetAvailable = Declared::MethodNotYetAvailable\n\n      # The API version as specified in the URL.\n      def version\n        env[Grape::Env::API_VERSION]\n      end\n\n      def configuration\n        options[:for].configuration.evaluate\n      end\n\n      # End the request and display an error to the\n      # end user with the specified message.\n      #\n      # @param message [String] The message to display.\n      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.\n      # @param additional_headers [Hash] Addtional headers for the response.\n      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.\n      # @param original_exception [Exception] The original exception that caused the error.\n      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end\n\n      # Redirect to a new url.\n      #\n      # @param url [String] The url to be redirect.\n      # @param permanent [Boolean] default false.\n      # @param body default a short message including the URL.\n      def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end\n\n      # Set or retrieve the HTTP status code.\n      #\n      # @param status [Integer] The HTTP Status Code to return for this request.\n      def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end\n\n      # Set response content-type\n      def content_type(val = nil)\n        if val\n          header(Rack::CONTENT_TYPE, val)\n        else\n          header[Rack::CONTENT_TYPE]\n        end\n      end\n\n      # Allows you to define the response body as something other than the\n      # return value.\n      #\n      # @example\n      #   get '/body' do\n      #     body \"Body\"\n      #     \"Not the Body\"\n      #   end\n      #\n      #   GET /body # => \"Body\"\n      def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end\n\n      # Allows you to explicitly return no content.\n      #\n      # @example\n      #   delete :id do\n      #     return_no_content\n      #     \"not returned\"\n      #   end\n      #\n      #   DELETE /12 # => 204 No Content, \"\"\n      def return_no_content\n        status 204\n        body false\n      end\n\n      # Allows you to send a file to the client via sendfile.\n      #\n      # @example\n      #   get '/file' do\n      #     sendfile FileStreamer.new(...)\n      #   end\n      #\n      #   GET /file # => \"contents of file\"\n      def sendfile(value = nil)\n        return stream if value.nil?\n\n        raise ArgumentError, 'Argument must be a file path' unless value.is_a?(String)\n\n        file_body = Grape::ServeStream::FileBody.new(value)\n        @stream = Grape::ServeStream::StreamResponse.new(file_body)\n      end\n\n      # Allows you to define the response as a streamable object.\n      #\n      # If Content-Length and Transfer-Encoding are blank (among other conditions),\n      # Rack assumes this response can be streamed in chunks.\n      #\n      # @example\n      #   get '/stream' do\n      #     stream FileStreamer.new(...)\n      #   end\n      #\n      #   GET /stream # => \"chunked contents of file\"\n      #\n      # See:\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/chunked.rb\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/etag.rb\n      def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end\n\n      # Returns route information for the current request.\n      #\n      # @example\n      #\n      #   desc \"Returns the route description.\"\n      #   get '/' do\n      #     route.description\n      #   end\n      def route\n        env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]\n      end\n\n      def http_version\n        env.fetch('HTTP_VERSION') { env[Rack::SERVER_PROTOCOL] }\n      end\n\n      def api_format(format)\n        env[Grape::Env::API_FORMAT] = format\n      end\n\n      def context\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "status", "signature": "def status(status = nil)", "start_line": 65, "end_line": 90}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 559}
{"function_name": "body", "file_path": "grape/lib/grape/dsl/inside_route.rb", "focal_code": "def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module InsideRoute\n      include Declared\n      include Entity\n\n      # Backward compatibility: alias exception class to previous location\n      MethodNotYetAvailable = Declared::MethodNotYetAvailable\n\n      # The API version as specified in the URL.\n      def version\n        env[Grape::Env::API_VERSION]\n      end\n\n      def configuration\n        options[:for].configuration.evaluate\n      end\n\n      # End the request and display an error to the\n      # end user with the specified message.\n      #\n      # @param message [String] The message to display.\n      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.\n      # @param additional_headers [Hash] Addtional headers for the response.\n      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.\n      # @param original_exception [Exception] The original exception that caused the error.\n      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end\n\n      # Redirect to a new url.\n      #\n      # @param url [String] The url to be redirect.\n      # @param permanent [Boolean] default false.\n      # @param body default a short message including the URL.\n      def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end\n\n      # Set or retrieve the HTTP status code.\n      #\n      # @param status [Integer] The HTTP Status Code to return for this request.\n      def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end\n\n      # Set response content-type\n      def content_type(val = nil)\n        if val\n          header(Rack::CONTENT_TYPE, val)\n        else\n          header[Rack::CONTENT_TYPE]\n        end\n      end\n\n      # Allows you to define the response body as something other than the\n      # return value.\n      #\n      # @example\n      #   get '/body' do\n      #     body \"Body\"\n      #     \"Not the Body\"\n      #   end\n      #\n      #   GET /body # => \"Body\"\n      def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end\n\n      # Allows you to explicitly return no content.\n      #\n      # @example\n      #   delete :id do\n      #     return_no_content\n      #     \"not returned\"\n      #   end\n      #\n      #   DELETE /12 # => 204 No Content, \"\"\n      def return_no_content\n        status 204\n        body false\n      end\n\n      # Allows you to send a file to the client via sendfile.\n      #\n      # @example\n      #   get '/file' do\n      #     sendfile FileStreamer.new(...)\n      #   end\n      #\n      #   GET /file # => \"contents of file\"\n      def sendfile(value = nil)\n        return stream if value.nil?\n\n        raise ArgumentError, 'Argument must be a file path' unless value.is_a?(String)\n\n        file_body = Grape::ServeStream::FileBody.new(value)\n        @stream = Grape::ServeStream::StreamResponse.new(file_body)\n      end\n\n      # Allows you to define the response as a streamable object.\n      #\n      # If Content-Length and Transfer-Encoding are blank (among other conditions),\n      # Rack assumes this response can be streamed in chunks.\n      #\n      # @example\n      #   get '/stream' do\n      #     stream FileStreamer.new(...)\n      #   end\n      #\n      #   GET /stream # => \"chunked contents of file\"\n      #\n      # See:\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/chunked.rb\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/etag.rb\n      def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end\n\n      # Returns route information for the current request.\n      #\n      # @example\n      #\n      #   desc \"Returns the route description.\"\n      #   get '/' do\n      #     route.description\n      #   end\n      def route\n        env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]\n      end\n\n      def http_version\n        env.fetch('HTTP_VERSION') { env[Rack::SERVER_PROTOCOL] }\n      end\n\n      def api_format(format)\n        env[Grape::Env::API_FORMAT] = format\n      end\n\n      def context\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "body", "signature": "def body(value = nil)", "start_line": 111, "end_line": 120}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 560}
{"function_name": "stream", "file_path": "grape/lib/grape/dsl/inside_route.rb", "focal_code": "def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module InsideRoute\n      include Declared\n      include Entity\n\n      # Backward compatibility: alias exception class to previous location\n      MethodNotYetAvailable = Declared::MethodNotYetAvailable\n\n      # The API version as specified in the URL.\n      def version\n        env[Grape::Env::API_VERSION]\n      end\n\n      def configuration\n        options[:for].configuration.evaluate\n      end\n\n      # End the request and display an error to the\n      # end user with the specified message.\n      #\n      # @param message [String] The message to display.\n      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.\n      # @param additional_headers [Hash] Addtional headers for the response.\n      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.\n      # @param original_exception [Exception] The original exception that caused the error.\n      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)\n        status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])\n        headers = additional_headers.present? ? header.merge(additional_headers) : header\n        throw :error,\n              message:,\n              status:,\n              headers:,\n              backtrace:,\n              original_exception:\n      end\n\n      # Redirect to a new url.\n      #\n      # @param url [String] The url to be redirect.\n      # @param permanent [Boolean] default false.\n      # @param body default a short message including the URL.\n      def redirect(url, permanent: false, body: nil)\n        body_message = body\n        if permanent\n          status 301\n          body_message ||= \"This resource has been moved permanently to #{url}.\"\n        elsif http_version == 'HTTP/1.1' && !request.get?\n          status 303\n          body_message ||= \"An alternate resource is located at #{url}.\"\n        else\n          status 302\n          body_message ||= \"This resource has been moved temporarily to #{url}.\"\n        end\n        header 'Location', url\n        content_type 'text/plain'\n        body body_message\n      end\n\n      # Set or retrieve the HTTP status code.\n      #\n      # @param status [Integer] The HTTP Status Code to return for this request.\n      def status(status = nil)\n        case status\n        when Symbol\n          raise ArgumentError, \"Status code :#{status} is invalid.\" unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)\n\n          @status = Rack::Utils.status_code(status)\n        when Integer\n          @status = status\n        when nil\n          return @status if @status\n\n          if request.post?\n            201\n          elsif request.delete?\n            if @body.present?\n              200\n            else\n              204\n            end\n          else\n            200\n          end\n        else\n          raise ArgumentError, 'Status code must be Integer or Symbol.'\n        end\n      end\n\n      # Set response content-type\n      def content_type(val = nil)\n        if val\n          header(Rack::CONTENT_TYPE, val)\n        else\n          header[Rack::CONTENT_TYPE]\n        end\n      end\n\n      # Allows you to define the response body as something other than the\n      # return value.\n      #\n      # @example\n      #   get '/body' do\n      #     body \"Body\"\n      #     \"Not the Body\"\n      #   end\n      #\n      #   GET /body # => \"Body\"\n      def body(value = nil)\n        if value\n          @body = value\n        elsif value == false\n          @body = ''\n          status 204\n        else\n          @body\n        end\n      end\n\n      # Allows you to explicitly return no content.\n      #\n      # @example\n      #   delete :id do\n      #     return_no_content\n      #     \"not returned\"\n      #   end\n      #\n      #   DELETE /12 # => 204 No Content, \"\"\n      def return_no_content\n        status 204\n        body false\n      end\n\n      # Allows you to send a file to the client via sendfile.\n      #\n      # @example\n      #   get '/file' do\n      #     sendfile FileStreamer.new(...)\n      #   end\n      #\n      #   GET /file # => \"contents of file\"\n      def sendfile(value = nil)\n        return stream if value.nil?\n\n        raise ArgumentError, 'Argument must be a file path' unless value.is_a?(String)\n\n        file_body = Grape::ServeStream::FileBody.new(value)\n        @stream = Grape::ServeStream::StreamResponse.new(file_body)\n      end\n\n      # Allows you to define the response as a streamable object.\n      #\n      # If Content-Length and Transfer-Encoding are blank (among other conditions),\n      # Rack assumes this response can be streamed in chunks.\n      #\n      # @example\n      #   get '/stream' do\n      #     stream FileStreamer.new(...)\n      #   end\n      #\n      #   GET /stream # => \"chunked contents of file\"\n      #\n      # See:\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/chunked.rb\n      # * https://github.com/rack/rack/blob/99293fa13d86cd48021630fcc4bd5acc9de5bdc3/lib/rack/etag.rb\n      def stream(value = nil)\n        return if value.nil? && @stream.nil?\n\n        header Rack::CONTENT_LENGTH, nil\n        header 'Transfer-Encoding', nil\n        header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)\n\n        return @stream if value.nil?\n\n        stream_body =\n          if value.is_a?(String)\n            Grape::ServeStream::FileBody.new(value)\n          elsif value.respond_to?(:each)\n            value\n          else\n            raise ArgumentError, 'Stream object must respond to :each.'\n          end\n\n        @stream = Grape::ServeStream::StreamResponse.new(stream_body)\n      end\n\n      # Returns route information for the current request.\n      #\n      # @example\n      #\n      #   desc \"Returns the route description.\"\n      #   get '/' do\n      #     route.description\n      #   end\n      def route\n        env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]\n      end\n\n      def http_version\n        env.fetch('HTTP_VERSION') { env[Rack::SERVER_PROTOCOL] }\n      end\n\n      def api_format(format)\n        env[Grape::Env::API_FORMAT] = format\n      end\n\n      def context\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "stream", "signature": "def stream(value = nil)", "start_line": 168, "end_line": 187}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 561}
{"function_name": "desc", "file_path": "grape/lib/grape/dsl/desc.rb", "focal_code": "def desc(description, options = {}, &config_block)\n        settings =\n          if config_block\n            endpoint_config = defined?(configuration) ? configuration : nil\n            Grape::Util::ApiDescription.new(description, endpoint_config, &config_block).settings\n          else\n            options.merge(description:)\n          end\n        inheritable_setting.namespace[:description] = settings\n        inheritable_setting.route[:description] = settings\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    module Desc\n      extend Grape::DSL::Settings\n\n      # Add a description to the next namespace or function.\n      # @param description [String] descriptive string for this endpoint\n      #   or namespace\n      # @param options [Hash] other properties you can set to describe the\n      #   endpoint or namespace. Optional.\n      # @option options :detail [String] additional detail about this endpoint\n      # @option options :summary [String] summary for this endpoint\n      # @option options :params [Hash] param types and info. normally, you set\n      #   these via the `params` dsl method.\n      # @option options :entity [Grape::Entity] the entity returned upon a\n      #   successful call to this action\n      # @option options :http_codes [Array[Array]] possible HTTP codes this\n      #   endpoint may return, with their meanings, in a 2d array\n      # @option options :named [String] a specific name to help find this route\n      # @option options :body_name [String] override the autogenerated body name param\n      # @option options :headers [Hash] HTTP headers this method can accept\n      # @option options :hidden [Boolean] hide the endpoint or not\n      # @option options :deprecated [Boolean] deprecate the endpoint or not\n      # @option options :is_array [Boolean] response entity is array or not\n      # @option options :nickname [String] nickname of the endpoint\n      # @option options :produces [Array[String]] a list of MIME types the endpoint produce\n      # @option options :consumes [Array[String]] a list of MIME types the endpoint consume\n      # @option options :security [Array[Hash]] a list of security schemes\n      # @option options :tags [Array[String]] a list of tags\n      # @yield a block yielding an instance context with methods mapping to\n      #   each of the above, except that :entity is also aliased as #success\n      #   and :http_codes is aliased as #failure.\n      #\n      # @example\n      #\n      #     desc 'create a user'\n      #     post '/users' do\n      #       # ...\n      #     end\n      #\n      #     desc 'find a user' do\n      #       detail 'locates the user from the given user ID'\n      #       failure [ [404, 'Couldn\\'t find the given user' ] ]\n      #       success User::Entity\n      #     end\n      #     get '/user/:id' do\n      #       # ...\n      #     end\n      #\n      def desc(description, options = {}, &config_block)\n        settings =\n          if config_block\n            endpoint_config = defined?(configuration) ? configuration : nil\n            Grape::Util::ApiDescription.new(description, endpoint_config, &config_block).settings\n          else\n            options.merge(description:)\n          end\n        inheritable_setting.namespace[:description] = settings\n        inheritable_setting.route[:description] = settings\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "desc", "signature": "def desc(description, options = {}, &config_block)", "start_line": 52, "end_line": 62}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 562}
{"function_name": "use", "file_path": "grape/lib/grape/dsl/parameters.rb", "focal_code": "def use(*names, **options)\n        named_params = @api.inheritable_setting.namespace_stackable_with_hash(:named_params) || {}\n        names.each do |name|\n          params_block = named_params.fetch(name) do\n            raise \"Params :#{name} not found!\"\n          end\n\n          if options.empty?\n            instance_exec(options, &params_block)\n          else\n            instance_exec(**options, &params_block)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    # Defines DSL methods, meant to be applied to a ParamsScope, which define\n    # and describe the parameters accepted by an endpoint, or all endpoints\n    # within a namespace.\n    module Parameters\n      # Set the module used to build the request.params.\n      #\n      # @param build_with the ParamBuilder module to use when building request.params\n      #   Available builders are:\n      #\n      #     * Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder (default)\n      #     * Grape::Extensions::Hash::ParamBuilder\n      #     * Grape::Extensions::Hashie::Mash::ParamBuilder\n      #\n      # @example\n      #\n      #     require 'grape/extenstions/hashie_mash'\n      #     class API < Grape::API\n      #       desc \"Get collection\"\n      #       params do\n      #         build_with :hashie_mash\n      #         requires :user_id, type: Integer\n      #       end\n      #       get do\n      #         params['user_id']\n      #       end\n      #     end\n      def build_with(build_with)\n        @api.inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Include reusable params rules among current.\n      # You can define reusable params with helpers method.\n      #\n      # @example\n      #\n      #     class API < Grape::API\n      #       helpers do\n      #         params :pagination do\n      #           optional :page, type: Integer\n      #           optional :per_page, type: Integer\n      #         end\n      #       end\n      #\n      #       desc \"Get collection\"\n      #       params do\n      #         use :pagination\n      #       end\n      #       get do\n      #         Collection.page(params[:page]).per(params[:per_page])\n      #       end\n      #     end\n      def use(*names, **options)\n        named_params = @api.inheritable_setting.namespace_stackable_with_hash(:named_params) || {}\n        names.each do |name|\n          params_block = named_params.fetch(name) do\n            raise \"Params :#{name} not found!\"\n          end\n\n          if options.empty?\n            instance_exec(options, &params_block)\n          else\n            instance_exec(**options, &params_block)\n          end\n        end\n      end\n      alias use_scope use\n      alias includes use\n\n      # Require one or more parameters for the current endpoint.\n      #\n      # @param attrs list of parameters names, or, if :using is\n      #   passed as an option, which keys to include (:all or :none) from\n      #   the :using hash. The last key can be a hash, which specifies\n      #   options for the parameters\n      # @option attrs :type [Class] the type to coerce this parameter to before\n      #   passing it to the endpoint. See {Grape::Validations::Types} for a list of\n      #   types that are supported automatically. Custom classes may be used\n      #   where they define a class-level `::parse` method, or in conjunction\n      #   with the `:coerce_with` parameter. `JSON` may be supplied to denote\n      #   `JSON`-formatted objects or arrays of objects. `Array[JSON]` accepts\n      #   the same values as `JSON` but will wrap single objects in an `Array`.\n      # @option attrs :types [Array<Class>] may be supplied in place of +:type+\n      #   to declare an attribute that has multiple allowed types. See\n      #   {Validations::Types::MultipleTypeCoercer} for more details on coercion\n      #   and validation rules for variant-type parameters.\n      # @option attrs :desc [String] description to document this parameter\n      # @option attrs :default [Object] default value, if parameter is optional\n      # @option attrs :values [Array] permissable values for this field. If any\n      #   other value is given, it will be handled as a validation error\n      # @option attrs :using [Hash[Symbol => Hash]] a hash defining keys and\n      #   options, like that returned by {Grape::Entity#documentation}. The value\n      #   of each key is an options hash accepting the same parameters\n      # @option attrs :except [Array[Symbol]] a list of keys to exclude from\n      #   the :using Hash. The meaning of this depends on if :all or :none was\n      #   passed; :all + :except will make the :except fields optional, whereas\n      #   :none + :except will make the :except fields required\n      # @option attrs :coerce_with [#parse, #call] method to be used when coercing\n      #   the parameter to the type named by `attrs[:type]`. Any class or object\n      #   that defines `::parse` or `::call` may be used.\n      #\n      # @example\n      #\n      #     params do\n      #       # Basic usage: require a parameter of a certain type\n      #       requires :user_id, type: Integer\n      #\n      #       # You don't need to specify type; String is default\n      #       requires :foo\n      #\n      #       # Multiple params can be specified at once if they share\n      #       # the same options.\n      #       requires :x, :y, :z, type: Date\n      #\n      #       # Nested parameters can be handled as hashes. You must\n      #       # pass in a block, within which you can use any of the\n      #       # parameters DSL methods.\n      #       requires :user, type: Hash do\n      #         requires :name, type: String\n      #       end\n      #     end\n      def requires(*attrs, **opts, &block)\n        opts[:presence] = { value: true, message: opts[:message] }\n        opts = @group.deep_merge(opts) if @group\n\n        if opts[:using]\n          require_required_and_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Allow, but don't require, one or more parameters for the current\n      #   endpoint.\n      # @param (see #requires)\n      # @option (see #requires)\n      def optional(*attrs, **opts, &block)\n        type = opts[:type]\n        opts = @group.deep_merge(opts) if @group\n\n        # check type for optional parameter group\n        if attrs && block\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        if opts[:using]\n          require_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], optional: true, &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Define common settings for one or more parameters\n      # @param (see #requires)\n      # @option (see #requires)\n      def with(**opts, &)\n        new_group_attrs = @group&.deep_merge(opts) || opts\n        new_group_scope(new_group_attrs, &)\n      end\n\n      %i[mutually_exclusive exactly_one_of at_least_one_of all_or_none_of].each do |validator|\n        define_method validator do |*attrs, message: nil|\n          validates(attrs, validator => { value: true, message: })\n        end\n      end\n\n      # Define a block of validations which should be applied if and only if\n      # the given parameter is present. The parameters are not nested.\n      # @param attr [Symbol] the parameter which, if present, triggers the\n      #   validations\n      # @raise Grape::Exceptions::UnknownParameter if `attr` has not been\n      #   defined in this scope yet\n      # @yield a parameter definition DSL\n      def given(*attrs, &)\n        attrs.each do |attr|\n          proxy_attr = first_hash_key_or_param(attr)\n          raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr)\n        end\n        new_lateral_scope(dependent_on: attrs, &)\n      end\n\n      # Test for whether a certain parameter has been defined in this params\n      # block yet.\n      # @return [Boolean] whether the parameter has been defined\n      def declared_param?(param)\n        if lateral?\n          # Elements of @declared_params of lateral scope are pushed in @parent. So check them in @parent.\n          @parent.declared_param?(param)\n        else\n          # @declared_params also includes hashes of options and such, but those\n          # won't be flattened out.\n          @declared_params.flatten.any? do |declared_param_attr|\n            first_hash_key_or_param(declared_param_attr.key) == param\n          end\n        end\n      end\n\n      alias group requires\n\n      EmptyOptionalValue = Object.new.freeze\n\n      # @param params [Hash] initial hash of parameters\n      # @return hash of parameters relevant for the current scope\n      # @api private\n      def params(params)\n        params = @parent.qualifying_params.presence || @parent.params(params) if @parent\n        params = map_params(params, @element) if @element\n        params\n      end\n\n      private\n\n      def first_hash_key_or_param(parameter)\n        parameter.is_a?(Hash) ? parameter.keys.first : parameter\n      end\n\n      def map_params(params, element, is_array: false)\n        case params\n        when Array\n          params.map do |el|\n            map_params(el, element, is_array: true)\n          end\n        when Hash\n          params[element] || (@optional && is_array ? EmptyOptionalValue : {})\n        when EmptyOptionalValue\n          EmptyOptionalValue\n        else\n          {}\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "use", "signature": "def use(*names, **options)", "start_line": 56, "end_line": 69}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 563}
{"function_name": "requires", "file_path": "grape/lib/grape/dsl/parameters.rb", "focal_code": "def requires(*attrs, **opts, &block)\n        opts[:presence] = { value: true, message: opts[:message] }\n        opts = @group.deep_merge(opts) if @group\n\n        if opts[:using]\n          require_required_and_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    # Defines DSL methods, meant to be applied to a ParamsScope, which define\n    # and describe the parameters accepted by an endpoint, or all endpoints\n    # within a namespace.\n    module Parameters\n      # Set the module used to build the request.params.\n      #\n      # @param build_with the ParamBuilder module to use when building request.params\n      #   Available builders are:\n      #\n      #     * Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder (default)\n      #     * Grape::Extensions::Hash::ParamBuilder\n      #     * Grape::Extensions::Hashie::Mash::ParamBuilder\n      #\n      # @example\n      #\n      #     require 'grape/extenstions/hashie_mash'\n      #     class API < Grape::API\n      #       desc \"Get collection\"\n      #       params do\n      #         build_with :hashie_mash\n      #         requires :user_id, type: Integer\n      #       end\n      #       get do\n      #         params['user_id']\n      #       end\n      #     end\n      def build_with(build_with)\n        @api.inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Include reusable params rules among current.\n      # You can define reusable params with helpers method.\n      #\n      # @example\n      #\n      #     class API < Grape::API\n      #       helpers do\n      #         params :pagination do\n      #           optional :page, type: Integer\n      #           optional :per_page, type: Integer\n      #         end\n      #       end\n      #\n      #       desc \"Get collection\"\n      #       params do\n      #         use :pagination\n      #       end\n      #       get do\n      #         Collection.page(params[:page]).per(params[:per_page])\n      #       end\n      #     end\n      def use(*names, **options)\n        named_params = @api.inheritable_setting.namespace_stackable_with_hash(:named_params) || {}\n        names.each do |name|\n          params_block = named_params.fetch(name) do\n            raise \"Params :#{name} not found!\"\n          end\n\n          if options.empty?\n            instance_exec(options, &params_block)\n          else\n            instance_exec(**options, &params_block)\n          end\n        end\n      end\n      alias use_scope use\n      alias includes use\n\n      # Require one or more parameters for the current endpoint.\n      #\n      # @param attrs list of parameters names, or, if :using is\n      #   passed as an option, which keys to include (:all or :none) from\n      #   the :using hash. The last key can be a hash, which specifies\n      #   options for the parameters\n      # @option attrs :type [Class] the type to coerce this parameter to before\n      #   passing it to the endpoint. See {Grape::Validations::Types} for a list of\n      #   types that are supported automatically. Custom classes may be used\n      #   where they define a class-level `::parse` method, or in conjunction\n      #   with the `:coerce_with` parameter. `JSON` may be supplied to denote\n      #   `JSON`-formatted objects or arrays of objects. `Array[JSON]` accepts\n      #   the same values as `JSON` but will wrap single objects in an `Array`.\n      # @option attrs :types [Array<Class>] may be supplied in place of +:type+\n      #   to declare an attribute that has multiple allowed types. See\n      #   {Validations::Types::MultipleTypeCoercer} for more details on coercion\n      #   and validation rules for variant-type parameters.\n      # @option attrs :desc [String] description to document this parameter\n      # @option attrs :default [Object] default value, if parameter is optional\n      # @option attrs :values [Array] permissable values for this field. If any\n      #   other value is given, it will be handled as a validation error\n      # @option attrs :using [Hash[Symbol => Hash]] a hash defining keys and\n      #   options, like that returned by {Grape::Entity#documentation}. The value\n      #   of each key is an options hash accepting the same parameters\n      # @option attrs :except [Array[Symbol]] a list of keys to exclude from\n      #   the :using Hash. The meaning of this depends on if :all or :none was\n      #   passed; :all + :except will make the :except fields optional, whereas\n      #   :none + :except will make the :except fields required\n      # @option attrs :coerce_with [#parse, #call] method to be used when coercing\n      #   the parameter to the type named by `attrs[:type]`. Any class or object\n      #   that defines `::parse` or `::call` may be used.\n      #\n      # @example\n      #\n      #     params do\n      #       # Basic usage: require a parameter of a certain type\n      #       requires :user_id, type: Integer\n      #\n      #       # You don't need to specify type; String is default\n      #       requires :foo\n      #\n      #       # Multiple params can be specified at once if they share\n      #       # the same options.\n      #       requires :x, :y, :z, type: Date\n      #\n      #       # Nested parameters can be handled as hashes. You must\n      #       # pass in a block, within which you can use any of the\n      #       # parameters DSL methods.\n      #       requires :user, type: Hash do\n      #         requires :name, type: String\n      #       end\n      #     end\n      def requires(*attrs, **opts, &block)\n        opts[:presence] = { value: true, message: opts[:message] }\n        opts = @group.deep_merge(opts) if @group\n\n        if opts[:using]\n          require_required_and_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Allow, but don't require, one or more parameters for the current\n      #   endpoint.\n      # @param (see #requires)\n      # @option (see #requires)\n      def optional(*attrs, **opts, &block)\n        type = opts[:type]\n        opts = @group.deep_merge(opts) if @group\n\n        # check type for optional parameter group\n        if attrs && block\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        if opts[:using]\n          require_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], optional: true, &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Define common settings for one or more parameters\n      # @param (see #requires)\n      # @option (see #requires)\n      def with(**opts, &)\n        new_group_attrs = @group&.deep_merge(opts) || opts\n        new_group_scope(new_group_attrs, &)\n      end\n\n      %i[mutually_exclusive exactly_one_of at_least_one_of all_or_none_of].each do |validator|\n        define_method validator do |*attrs, message: nil|\n          validates(attrs, validator => { value: true, message: })\n        end\n      end\n\n      # Define a block of validations which should be applied if and only if\n      # the given parameter is present. The parameters are not nested.\n      # @param attr [Symbol] the parameter which, if present, triggers the\n      #   validations\n      # @raise Grape::Exceptions::UnknownParameter if `attr` has not been\n      #   defined in this scope yet\n      # @yield a parameter definition DSL\n      def given(*attrs, &)\n        attrs.each do |attr|\n          proxy_attr = first_hash_key_or_param(attr)\n          raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr)\n        end\n        new_lateral_scope(dependent_on: attrs, &)\n      end\n\n      # Test for whether a certain parameter has been defined in this params\n      # block yet.\n      # @return [Boolean] whether the parameter has been defined\n      def declared_param?(param)\n        if lateral?\n          # Elements of @declared_params of lateral scope are pushed in @parent. So check them in @parent.\n          @parent.declared_param?(param)\n        else\n          # @declared_params also includes hashes of options and such, but those\n          # won't be flattened out.\n          @declared_params.flatten.any? do |declared_param_attr|\n            first_hash_key_or_param(declared_param_attr.key) == param\n          end\n        end\n      end\n\n      alias group requires\n\n      EmptyOptionalValue = Object.new.freeze\n\n      # @param params [Hash] initial hash of parameters\n      # @return hash of parameters relevant for the current scope\n      # @api private\n      def params(params)\n        params = @parent.qualifying_params.presence || @parent.params(params) if @parent\n        params = map_params(params, @element) if @element\n        params\n      end\n\n      private\n\n      def first_hash_key_or_param(parameter)\n        parameter.is_a?(Hash) ? parameter.keys.first : parameter\n      end\n\n      def map_params(params, element, is_array: false)\n        case params\n        when Array\n          params.map do |el|\n            map_params(el, element, is_array: true)\n          end\n        when Hash\n          params[element] || (@optional && is_array ? EmptyOptionalValue : {})\n        when EmptyOptionalValue\n          EmptyOptionalValue\n        else\n          {}\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "requires", "signature": "def requires(*attrs, **opts, &block)", "start_line": 125, "end_line": 135}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 564}
{"function_name": "optional", "file_path": "grape/lib/grape/dsl/parameters.rb", "focal_code": "def optional(*attrs, **opts, &block)\n        type = opts[:type]\n        opts = @group.deep_merge(opts) if @group\n\n        # check type for optional parameter group\n        if attrs && block\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        if opts[:using]\n          require_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], optional: true, &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    # Defines DSL methods, meant to be applied to a ParamsScope, which define\n    # and describe the parameters accepted by an endpoint, or all endpoints\n    # within a namespace.\n    module Parameters\n      # Set the module used to build the request.params.\n      #\n      # @param build_with the ParamBuilder module to use when building request.params\n      #   Available builders are:\n      #\n      #     * Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder (default)\n      #     * Grape::Extensions::Hash::ParamBuilder\n      #     * Grape::Extensions::Hashie::Mash::ParamBuilder\n      #\n      # @example\n      #\n      #     require 'grape/extenstions/hashie_mash'\n      #     class API < Grape::API\n      #       desc \"Get collection\"\n      #       params do\n      #         build_with :hashie_mash\n      #         requires :user_id, type: Integer\n      #       end\n      #       get do\n      #         params['user_id']\n      #       end\n      #     end\n      def build_with(build_with)\n        @api.inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Include reusable params rules among current.\n      # You can define reusable params with helpers method.\n      #\n      # @example\n      #\n      #     class API < Grape::API\n      #       helpers do\n      #         params :pagination do\n      #           optional :page, type: Integer\n      #           optional :per_page, type: Integer\n      #         end\n      #       end\n      #\n      #       desc \"Get collection\"\n      #       params do\n      #         use :pagination\n      #       end\n      #       get do\n      #         Collection.page(params[:page]).per(params[:per_page])\n      #       end\n      #     end\n      def use(*names, **options)\n        named_params = @api.inheritable_setting.namespace_stackable_with_hash(:named_params) || {}\n        names.each do |name|\n          params_block = named_params.fetch(name) do\n            raise \"Params :#{name} not found!\"\n          end\n\n          if options.empty?\n            instance_exec(options, &params_block)\n          else\n            instance_exec(**options, &params_block)\n          end\n        end\n      end\n      alias use_scope use\n      alias includes use\n\n      # Require one or more parameters for the current endpoint.\n      #\n      # @param attrs list of parameters names, or, if :using is\n      #   passed as an option, which keys to include (:all or :none) from\n      #   the :using hash. The last key can be a hash, which specifies\n      #   options for the parameters\n      # @option attrs :type [Class] the type to coerce this parameter to before\n      #   passing it to the endpoint. See {Grape::Validations::Types} for a list of\n      #   types that are supported automatically. Custom classes may be used\n      #   where they define a class-level `::parse` method, or in conjunction\n      #   with the `:coerce_with` parameter. `JSON` may be supplied to denote\n      #   `JSON`-formatted objects or arrays of objects. `Array[JSON]` accepts\n      #   the same values as `JSON` but will wrap single objects in an `Array`.\n      # @option attrs :types [Array<Class>] may be supplied in place of +:type+\n      #   to declare an attribute that has multiple allowed types. See\n      #   {Validations::Types::MultipleTypeCoercer} for more details on coercion\n      #   and validation rules for variant-type parameters.\n      # @option attrs :desc [String] description to document this parameter\n      # @option attrs :default [Object] default value, if parameter is optional\n      # @option attrs :values [Array] permissable values for this field. If any\n      #   other value is given, it will be handled as a validation error\n      # @option attrs :using [Hash[Symbol => Hash]] a hash defining keys and\n      #   options, like that returned by {Grape::Entity#documentation}. The value\n      #   of each key is an options hash accepting the same parameters\n      # @option attrs :except [Array[Symbol]] a list of keys to exclude from\n      #   the :using Hash. The meaning of this depends on if :all or :none was\n      #   passed; :all + :except will make the :except fields optional, whereas\n      #   :none + :except will make the :except fields required\n      # @option attrs :coerce_with [#parse, #call] method to be used when coercing\n      #   the parameter to the type named by `attrs[:type]`. Any class or object\n      #   that defines `::parse` or `::call` may be used.\n      #\n      # @example\n      #\n      #     params do\n      #       # Basic usage: require a parameter of a certain type\n      #       requires :user_id, type: Integer\n      #\n      #       # You don't need to specify type; String is default\n      #       requires :foo\n      #\n      #       # Multiple params can be specified at once if they share\n      #       # the same options.\n      #       requires :x, :y, :z, type: Date\n      #\n      #       # Nested parameters can be handled as hashes. You must\n      #       # pass in a block, within which you can use any of the\n      #       # parameters DSL methods.\n      #       requires :user, type: Hash do\n      #         requires :name, type: String\n      #       end\n      #     end\n      def requires(*attrs, **opts, &block)\n        opts[:presence] = { value: true, message: opts[:message] }\n        opts = @group.deep_merge(opts) if @group\n\n        if opts[:using]\n          require_required_and_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Allow, but don't require, one or more parameters for the current\n      #   endpoint.\n      # @param (see #requires)\n      # @option (see #requires)\n      def optional(*attrs, **opts, &block)\n        type = opts[:type]\n        opts = @group.deep_merge(opts) if @group\n\n        # check type for optional parameter group\n        if attrs && block\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        if opts[:using]\n          require_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], optional: true, &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Define common settings for one or more parameters\n      # @param (see #requires)\n      # @option (see #requires)\n      def with(**opts, &)\n        new_group_attrs = @group&.deep_merge(opts) || opts\n        new_group_scope(new_group_attrs, &)\n      end\n\n      %i[mutually_exclusive exactly_one_of at_least_one_of all_or_none_of].each do |validator|\n        define_method validator do |*attrs, message: nil|\n          validates(attrs, validator => { value: true, message: })\n        end\n      end\n\n      # Define a block of validations which should be applied if and only if\n      # the given parameter is present. The parameters are not nested.\n      # @param attr [Symbol] the parameter which, if present, triggers the\n      #   validations\n      # @raise Grape::Exceptions::UnknownParameter if `attr` has not been\n      #   defined in this scope yet\n      # @yield a parameter definition DSL\n      def given(*attrs, &)\n        attrs.each do |attr|\n          proxy_attr = first_hash_key_or_param(attr)\n          raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr)\n        end\n        new_lateral_scope(dependent_on: attrs, &)\n      end\n\n      # Test for whether a certain parameter has been defined in this params\n      # block yet.\n      # @return [Boolean] whether the parameter has been defined\n      def declared_param?(param)\n        if lateral?\n          # Elements of @declared_params of lateral scope are pushed in @parent. So check them in @parent.\n          @parent.declared_param?(param)\n        else\n          # @declared_params also includes hashes of options and such, but those\n          # won't be flattened out.\n          @declared_params.flatten.any? do |declared_param_attr|\n            first_hash_key_or_param(declared_param_attr.key) == param\n          end\n        end\n      end\n\n      alias group requires\n\n      EmptyOptionalValue = Object.new.freeze\n\n      # @param params [Hash] initial hash of parameters\n      # @return hash of parameters relevant for the current scope\n      # @api private\n      def params(params)\n        params = @parent.qualifying_params.presence || @parent.params(params) if @parent\n        params = map_params(params, @element) if @element\n        params\n      end\n\n      private\n\n      def first_hash_key_or_param(parameter)\n        parameter.is_a?(Hash) ? parameter.keys.first : parameter\n      end\n\n      def map_params(params, element, is_array: false)\n        case params\n        when Array\n          params.map do |el|\n            map_params(el, element, is_array: true)\n          end\n        when Hash\n          params[element] || (@optional && is_array ? EmptyOptionalValue : {})\n        when EmptyOptionalValue\n          EmptyOptionalValue\n        else\n          {}\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "optional", "signature": "def optional(*attrs, **opts, &block)", "start_line": 141, "end_line": 158}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 565}
{"function_name": "map_params", "file_path": "grape/lib/grape/dsl/parameters.rb", "focal_code": "def map_params(params, element, is_array: false)\n        case params\n        when Array\n          params.map do |el|\n            map_params(el, element, is_array: true)\n          end\n        when Hash\n          params[element] || (@optional && is_array ? EmptyOptionalValue : {})\n        when EmptyOptionalValue\n          EmptyOptionalValue\n        else\n          {}\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module DSL\n    # Defines DSL methods, meant to be applied to a ParamsScope, which define\n    # and describe the parameters accepted by an endpoint, or all endpoints\n    # within a namespace.\n    module Parameters\n      # Set the module used to build the request.params.\n      #\n      # @param build_with the ParamBuilder module to use when building request.params\n      #   Available builders are:\n      #\n      #     * Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder (default)\n      #     * Grape::Extensions::Hash::ParamBuilder\n      #     * Grape::Extensions::Hashie::Mash::ParamBuilder\n      #\n      # @example\n      #\n      #     require 'grape/extenstions/hashie_mash'\n      #     class API < Grape::API\n      #       desc \"Get collection\"\n      #       params do\n      #         build_with :hashie_mash\n      #         requires :user_id, type: Integer\n      #       end\n      #       get do\n      #         params['user_id']\n      #       end\n      #     end\n      def build_with(build_with)\n        @api.inheritable_setting.namespace_inheritable[:build_params_with] = build_with\n      end\n\n      # Include reusable params rules among current.\n      # You can define reusable params with helpers method.\n      #\n      # @example\n      #\n      #     class API < Grape::API\n      #       helpers do\n      #         params :pagination do\n      #           optional :page, type: Integer\n      #           optional :per_page, type: Integer\n      #         end\n      #       end\n      #\n      #       desc \"Get collection\"\n      #       params do\n      #         use :pagination\n      #       end\n      #       get do\n      #         Collection.page(params[:page]).per(params[:per_page])\n      #       end\n      #     end\n      def use(*names, **options)\n        named_params = @api.inheritable_setting.namespace_stackable_with_hash(:named_params) || {}\n        names.each do |name|\n          params_block = named_params.fetch(name) do\n            raise \"Params :#{name} not found!\"\n          end\n\n          if options.empty?\n            instance_exec(options, &params_block)\n          else\n            instance_exec(**options, &params_block)\n          end\n        end\n      end\n      alias use_scope use\n      alias includes use\n\n      # Require one or more parameters for the current endpoint.\n      #\n      # @param attrs list of parameters names, or, if :using is\n      #   passed as an option, which keys to include (:all or :none) from\n      #   the :using hash. The last key can be a hash, which specifies\n      #   options for the parameters\n      # @option attrs :type [Class] the type to coerce this parameter to before\n      #   passing it to the endpoint. See {Grape::Validations::Types} for a list of\n      #   types that are supported automatically. Custom classes may be used\n      #   where they define a class-level `::parse` method, or in conjunction\n      #   with the `:coerce_with` parameter. `JSON` may be supplied to denote\n      #   `JSON`-formatted objects or arrays of objects. `Array[JSON]` accepts\n      #   the same values as `JSON` but will wrap single objects in an `Array`.\n      # @option attrs :types [Array<Class>] may be supplied in place of +:type+\n      #   to declare an attribute that has multiple allowed types. See\n      #   {Validations::Types::MultipleTypeCoercer} for more details on coercion\n      #   and validation rules for variant-type parameters.\n      # @option attrs :desc [String] description to document this parameter\n      # @option attrs :default [Object] default value, if parameter is optional\n      # @option attrs :values [Array] permissable values for this field. If any\n      #   other value is given, it will be handled as a validation error\n      # @option attrs :using [Hash[Symbol => Hash]] a hash defining keys and\n      #   options, like that returned by {Grape::Entity#documentation}. The value\n      #   of each key is an options hash accepting the same parameters\n      # @option attrs :except [Array[Symbol]] a list of keys to exclude from\n      #   the :using Hash. The meaning of this depends on if :all or :none was\n      #   passed; :all + :except will make the :except fields optional, whereas\n      #   :none + :except will make the :except fields required\n      # @option attrs :coerce_with [#parse, #call] method to be used when coercing\n      #   the parameter to the type named by `attrs[:type]`. Any class or object\n      #   that defines `::parse` or `::call` may be used.\n      #\n      # @example\n      #\n      #     params do\n      #       # Basic usage: require a parameter of a certain type\n      #       requires :user_id, type: Integer\n      #\n      #       # You don't need to specify type; String is default\n      #       requires :foo\n      #\n      #       # Multiple params can be specified at once if they share\n      #       # the same options.\n      #       requires :x, :y, :z, type: Date\n      #\n      #       # Nested parameters can be handled as hashes. You must\n      #       # pass in a block, within which you can use any of the\n      #       # parameters DSL methods.\n      #       requires :user, type: Hash do\n      #         requires :name, type: String\n      #       end\n      #     end\n      def requires(*attrs, **opts, &block)\n        opts[:presence] = { value: true, message: opts[:message] }\n        opts = @group.deep_merge(opts) if @group\n\n        if opts[:using]\n          require_required_and_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Allow, but don't require, one or more parameters for the current\n      #   endpoint.\n      # @param (see #requires)\n      # @option (see #requires)\n      def optional(*attrs, **opts, &block)\n        type = opts[:type]\n        opts = @group.deep_merge(opts) if @group\n\n        # check type for optional parameter group\n        if attrs && block\n          raise Grape::Exceptions::MissingGroupType if type.nil?\n          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)\n        end\n\n        if opts[:using]\n          require_optional_fields(attrs.first, using: opts[:using], except: opts[:except])\n        else\n          validate_attributes(attrs, **opts, &block)\n\n          block ? new_scope(attrs.first, type: opts[:type], as: opts[:as], optional: true, &block) : push_declared_params(attrs, as: opts[:as])\n        end\n      end\n\n      # Define common settings for one or more parameters\n      # @param (see #requires)\n      # @option (see #requires)\n      def with(**opts, &)\n        new_group_attrs = @group&.deep_merge(opts) || opts\n        new_group_scope(new_group_attrs, &)\n      end\n\n      %i[mutually_exclusive exactly_one_of at_least_one_of all_or_none_of].each do |validator|\n        define_method validator do |*attrs, message: nil|\n          validates(attrs, validator => { value: true, message: })\n        end\n      end\n\n      # Define a block of validations which should be applied if and only if\n      # the given parameter is present. The parameters are not nested.\n      # @param attr [Symbol] the parameter which, if present, triggers the\n      #   validations\n      # @raise Grape::Exceptions::UnknownParameter if `attr` has not been\n      #   defined in this scope yet\n      # @yield a parameter definition DSL\n      def given(*attrs, &)\n        attrs.each do |attr|\n          proxy_attr = first_hash_key_or_param(attr)\n          raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr)\n        end\n        new_lateral_scope(dependent_on: attrs, &)\n      end\n\n      # Test for whether a certain parameter has been defined in this params\n      # block yet.\n      # @return [Boolean] whether the parameter has been defined\n      def declared_param?(param)\n        if lateral?\n          # Elements of @declared_params of lateral scope are pushed in @parent. So check them in @parent.\n          @parent.declared_param?(param)\n        else\n          # @declared_params also includes hashes of options and such, but those\n          # won't be flattened out.\n          @declared_params.flatten.any? do |declared_param_attr|\n            first_hash_key_or_param(declared_param_attr.key) == param\n          end\n        end\n      end\n\n      alias group requires\n\n      EmptyOptionalValue = Object.new.freeze\n\n      # @param params [Hash] initial hash of parameters\n      # @return hash of parameters relevant for the current scope\n      # @api private\n      def params(params)\n        params = @parent.qualifying_params.presence || @parent.params(params) if @parent\n        params = map_params(params, @element) if @element\n        params\n      end\n\n      private\n\n      def first_hash_key_or_param(parameter)\n        parameter.is_a?(Hash) ? parameter.keys.first : parameter\n      end\n\n      def map_params(params, element, is_array: false)\n        case params\n        when Array\n          params.map do |el|\n            map_params(el, element, is_array: true)\n          end\n        when Hash\n          params[element] || (@optional && is_array ? EmptyOptionalValue : {})\n        when EmptyOptionalValue\n          EmptyOptionalValue\n        else\n          {}\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "map_params", "signature": "def map_params(params, element, is_array: false)", "start_line": 224, "end_line": 237}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 566}
{"function_name": "initialize", "file_path": "grape/lib/grape/util/inheritable_setting.rb", "focal_code": "def initialize\n        self.route = {}\n        self.api_class = {}\n        self.namespace = InheritableValues.new # only inheritable from a parent when\n        # used with a mount, or should every API::Class be a separate namespace by default?\n        self.namespace_inheritable = InheritableValues.new\n        self.namespace_stackable = StackableValues.new\n        self.namespace_reverse_stackable = ReverseStackableValues.new\n\n        self.point_in_time_copies = []\n\n        self.parent = nil\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    # A branchable, inheritable settings object which can store both stackable\n    # and inheritable values (see InheritableValues and StackableValues).\n    class InheritableSetting\n      attr_accessor :route, :api_class, :namespace, :namespace_inheritable, :namespace_stackable, :namespace_reverse_stackable, :parent, :point_in_time_copies\n\n      # Retrieve global settings.\n      def self.global\n        @global ||= {}\n      end\n\n      # Clear all global settings.\n      # @api private\n      # @note only for testing\n      def self.reset_global!\n        @global = {}\n      end\n\n      # Instantiate a new settings instance, with blank values. The fresh\n      # instance can then be set to inherit from an existing instance (see\n      # #inherit_from).\n      def initialize\n        self.route = {}\n        self.api_class = {}\n        self.namespace = InheritableValues.new # only inheritable from a parent when\n        # used with a mount, or should every API::Class be a separate namespace by default?\n        self.namespace_inheritable = InheritableValues.new\n        self.namespace_stackable = StackableValues.new\n        self.namespace_reverse_stackable = ReverseStackableValues.new\n\n        self.point_in_time_copies = []\n\n        self.parent = nil\n      end\n\n      # Return the class-level global properties.\n      def global\n        self.class.global\n      end\n\n      # Set our inherited values to the given parent's current values. Also,\n      # update the inherited values on any settings instances which were forked\n      # from us.\n      # @param parent [InheritableSetting]\n      def inherit_from(parent)\n        return if parent.nil?\n\n        self.parent = parent\n\n        namespace_inheritable.inherited_values = parent.namespace_inheritable\n        namespace_stackable.inherited_values = parent.namespace_stackable\n        namespace_reverse_stackable.inherited_values = parent.namespace_reverse_stackable\n        self.route = parent.route.merge(route)\n\n        point_in_time_copies.each { |cloned_one| cloned_one.inherit_from parent }\n      end\n\n      # Create a point-in-time copy of this settings instance, with clones of\n      # all our values. Note that, should this instance's parent be set or\n      # changed via #inherit_from, it will copy that inheritence to any copies\n      # which were made.\n      def point_in_time_copy\n        self.class.new.tap do |new_setting|\n          point_in_time_copies << new_setting\n          new_setting.point_in_time_copies = []\n\n          new_setting.namespace = namespace.clone\n          new_setting.namespace_inheritable = namespace_inheritable.clone\n          new_setting.namespace_stackable = namespace_stackable.clone\n          new_setting.namespace_reverse_stackable = namespace_reverse_stackable.clone\n          new_setting.route = route.clone\n          new_setting.api_class = api_class\n\n          new_setting.inherit_from(parent)\n        end\n      end\n\n      # Resets the instance store of per-route settings.\n      # @api private\n      def route_end\n        @route = {}\n      end\n\n      # Return a serializable hash of our values.\n      def to_hash\n        {\n          global: global.clone,\n          route: route.clone,\n          namespace: namespace.to_hash,\n          namespace_inheritable: namespace_inheritable.to_hash,\n          namespace_stackable: namespace_stackable.to_hash,\n          namespace_reverse_stackable: namespace_reverse_stackable.to_hash\n        }\n      end\n\n      def namespace_stackable_with_hash(key)\n        data = namespace_stackable[key]\n        return if data.blank?\n\n        data.each_with_object({}) { |value, result| result.deep_merge!(value) }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize self.route = {}", "start_line": 25, "end_line": 37}, "metadata": {"module": "Grape", "class_name": "InheritableSetting", "class_signature": "class InheritableSetting"}, "task_id": 567}
{"function_name": "point_in_time_copy", "file_path": "grape/lib/grape/util/inheritable_setting.rb", "focal_code": "def point_in_time_copy\n        self.class.new.tap do |new_setting|\n          point_in_time_copies << new_setting\n          new_setting.point_in_time_copies = []\n\n          new_setting.namespace = namespace.clone\n          new_setting.namespace_inheritable = namespace_inheritable.clone\n          new_setting.namespace_stackable = namespace_stackable.clone\n          new_setting.namespace_reverse_stackable = namespace_reverse_stackable.clone\n          new_setting.route = route.clone\n          new_setting.api_class = api_class\n\n          new_setting.inherit_from(parent)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    # A branchable, inheritable settings object which can store both stackable\n    # and inheritable values (see InheritableValues and StackableValues).\n    class InheritableSetting\n      attr_accessor :route, :api_class, :namespace, :namespace_inheritable, :namespace_stackable, :namespace_reverse_stackable, :parent, :point_in_time_copies\n\n      # Retrieve global settings.\n      def self.global\n        @global ||= {}\n      end\n\n      # Clear all global settings.\n      # @api private\n      # @note only for testing\n      def self.reset_global!\n        @global = {}\n      end\n\n      # Instantiate a new settings instance, with blank values. The fresh\n      # instance can then be set to inherit from an existing instance (see\n      # #inherit_from).\n      def initialize\n        self.route = {}\n        self.api_class = {}\n        self.namespace = InheritableValues.new # only inheritable from a parent when\n        # used with a mount, or should every API::Class be a separate namespace by default?\n        self.namespace_inheritable = InheritableValues.new\n        self.namespace_stackable = StackableValues.new\n        self.namespace_reverse_stackable = ReverseStackableValues.new\n\n        self.point_in_time_copies = []\n\n        self.parent = nil\n      end\n\n      # Return the class-level global properties.\n      def global\n        self.class.global\n      end\n\n      # Set our inherited values to the given parent's current values. Also,\n      # update the inherited values on any settings instances which were forked\n      # from us.\n      # @param parent [InheritableSetting]\n      def inherit_from(parent)\n        return if parent.nil?\n\n        self.parent = parent\n\n        namespace_inheritable.inherited_values = parent.namespace_inheritable\n        namespace_stackable.inherited_values = parent.namespace_stackable\n        namespace_reverse_stackable.inherited_values = parent.namespace_reverse_stackable\n        self.route = parent.route.merge(route)\n\n        point_in_time_copies.each { |cloned_one| cloned_one.inherit_from parent }\n      end\n\n      # Create a point-in-time copy of this settings instance, with clones of\n      # all our values. Note that, should this instance's parent be set or\n      # changed via #inherit_from, it will copy that inheritence to any copies\n      # which were made.\n      def point_in_time_copy\n        self.class.new.tap do |new_setting|\n          point_in_time_copies << new_setting\n          new_setting.point_in_time_copies = []\n\n          new_setting.namespace = namespace.clone\n          new_setting.namespace_inheritable = namespace_inheritable.clone\n          new_setting.namespace_stackable = namespace_stackable.clone\n          new_setting.namespace_reverse_stackable = namespace_reverse_stackable.clone\n          new_setting.route = route.clone\n          new_setting.api_class = api_class\n\n          new_setting.inherit_from(parent)\n        end\n      end\n\n      # Resets the instance store of per-route settings.\n      # @api private\n      def route_end\n        @route = {}\n      end\n\n      # Return a serializable hash of our values.\n      def to_hash\n        {\n          global: global.clone,\n          route: route.clone,\n          namespace: namespace.to_hash,\n          namespace_inheritable: namespace_inheritable.to_hash,\n          namespace_stackable: namespace_stackable.to_hash,\n          namespace_reverse_stackable: namespace_reverse_stackable.to_hash\n        }\n      end\n\n      def namespace_stackable_with_hash(key)\n        data = namespace_stackable[key]\n        return if data.blank?\n\n        data.each_with_object({}) { |value, result| result.deep_merge!(value) }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "point_in_time_copy", "signature": "def point_in_time_copy self.class.new.tap do |new_setting|", "start_line": 65, "end_line": 79}, "metadata": {"module": "Grape", "class_name": "InheritableSetting", "class_signature": "class InheritableSetting"}, "task_id": 568}
{"function_name": "to_hash", "file_path": "grape/lib/grape/util/inheritable_setting.rb", "focal_code": "def to_hash\n        {\n          global: global.clone,\n          route: route.clone,\n          namespace: namespace.to_hash,\n          namespace_inheritable: namespace_inheritable.to_hash,\n          namespace_stackable: namespace_stackable.to_hash,\n          namespace_reverse_stackable: namespace_reverse_stackable.to_hash\n        }\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    # A branchable, inheritable settings object which can store both stackable\n    # and inheritable values (see InheritableValues and StackableValues).\n    class InheritableSetting\n      attr_accessor :route, :api_class, :namespace, :namespace_inheritable, :namespace_stackable, :namespace_reverse_stackable, :parent, :point_in_time_copies\n\n      # Retrieve global settings.\n      def self.global\n        @global ||= {}\n      end\n\n      # Clear all global settings.\n      # @api private\n      # @note only for testing\n      def self.reset_global!\n        @global = {}\n      end\n\n      # Instantiate a new settings instance, with blank values. The fresh\n      # instance can then be set to inherit from an existing instance (see\n      # #inherit_from).\n      def initialize\n        self.route = {}\n        self.api_class = {}\n        self.namespace = InheritableValues.new # only inheritable from a parent when\n        # used with a mount, or should every API::Class be a separate namespace by default?\n        self.namespace_inheritable = InheritableValues.new\n        self.namespace_stackable = StackableValues.new\n        self.namespace_reverse_stackable = ReverseStackableValues.new\n\n        self.point_in_time_copies = []\n\n        self.parent = nil\n      end\n\n      # Return the class-level global properties.\n      def global\n        self.class.global\n      end\n\n      # Set our inherited values to the given parent's current values. Also,\n      # update the inherited values on any settings instances which were forked\n      # from us.\n      # @param parent [InheritableSetting]\n      def inherit_from(parent)\n        return if parent.nil?\n\n        self.parent = parent\n\n        namespace_inheritable.inherited_values = parent.namespace_inheritable\n        namespace_stackable.inherited_values = parent.namespace_stackable\n        namespace_reverse_stackable.inherited_values = parent.namespace_reverse_stackable\n        self.route = parent.route.merge(route)\n\n        point_in_time_copies.each { |cloned_one| cloned_one.inherit_from parent }\n      end\n\n      # Create a point-in-time copy of this settings instance, with clones of\n      # all our values. Note that, should this instance's parent be set or\n      # changed via #inherit_from, it will copy that inheritence to any copies\n      # which were made.\n      def point_in_time_copy\n        self.class.new.tap do |new_setting|\n          point_in_time_copies << new_setting\n          new_setting.point_in_time_copies = []\n\n          new_setting.namespace = namespace.clone\n          new_setting.namespace_inheritable = namespace_inheritable.clone\n          new_setting.namespace_stackable = namespace_stackable.clone\n          new_setting.namespace_reverse_stackable = namespace_reverse_stackable.clone\n          new_setting.route = route.clone\n          new_setting.api_class = api_class\n\n          new_setting.inherit_from(parent)\n        end\n      end\n\n      # Resets the instance store of per-route settings.\n      # @api private\n      def route_end\n        @route = {}\n      end\n\n      # Return a serializable hash of our values.\n      def to_hash\n        {\n          global: global.clone,\n          route: route.clone,\n          namespace: namespace.to_hash,\n          namespace_inheritable: namespace_inheritable.to_hash,\n          namespace_stackable: namespace_stackable.to_hash,\n          namespace_reverse_stackable: namespace_reverse_stackable.to_hash\n        }\n      end\n\n      def namespace_stackable_with_hash(key)\n        data = namespace_stackable[key]\n        return if data.blank?\n\n        data.each_with_object({}) { |value, result| result.deep_merge!(value) }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "to_hash", "signature": "def to_hash {", "start_line": 88, "end_line": 97}, "metadata": {"module": "Grape", "class_name": "InheritableSetting", "class_signature": "class InheritableSetting"}, "task_id": 569}
{"function_name": "deep_freeze", "file_path": "grape/lib/grape/util/deep_freeze.rb", "focal_code": "def deep_freeze(obj)\n        case obj\n        when Hash\n          obj.each do |k, v|\n            deep_freeze(k)\n            deep_freeze(v)\n          end\n          obj.freeze\n        when Array\n          obj.each { |v| deep_freeze(v) }\n          obj.freeze\n        when String\n          obj.freeze\n        else\n          obj\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    module DeepFreeze\n      module_function\n\n      # Recursively freezes Hash (keys and values), Array (elements), and String\n      # objects. All other types are returned as-is.\n      #\n      # Intentionally left unfrozen:\n      #   - Procs / lambdas — may be deferred DB-backed callables\n      #   - Coercers (e.g. ArrayCoercer) — use lazy ivar memoization at request time\n      #   - Classes / Modules — shared constants that must remain open\n      #   - ParamsScope — self-freezes at the end of its own initialize\n      def deep_freeze(obj)\n        case obj\n        when Hash\n          obj.each do |k, v|\n            deep_freeze(k)\n            deep_freeze(v)\n          end\n          obj.freeze\n        when Array\n          obj.each { |v| deep_freeze(v) }\n          obj.freeze\n        when String\n          obj.freeze\n        else\n          obj\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "deep_freeze", "signature": "def deep_freeze(obj)", "start_line": 16, "end_line": 32}, "metadata": {"module": "Grape", "class_name": "", "class_signature": ""}, "task_id": 570}
{"function_name": "keys", "file_path": "grape/lib/grape/util/base_inheritable.rb", "focal_code": "def keys\n        if new_values.any?\n          inherited_values.keys.tap do |combined|\n            combined.concat(new_values.keys)\n            combined.uniq!\n          end\n        else\n          inherited_values.keys\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    # Base for classes which need to operate with own values kept\n    # in the hash and inherited values kept in a Hash-like object.\n    class BaseInheritable\n      attr_accessor :inherited_values, :new_values\n\n      # @param inherited_values [Object] An object implementing an interface\n      #   of the Hash class.\n      def initialize(inherited_values = nil)\n        @inherited_values = inherited_values || {}\n        @new_values = {}\n      end\n\n      def delete(*keys)\n        keys.map do |key|\n          # since delete returns the deleted value, seems natural to `map` the result\n          new_values.delete key\n        end\n      end\n\n      def initialize_copy(other)\n        super\n        self.inherited_values = other.inherited_values\n        self.new_values = other.new_values.dup\n      end\n\n      def keys\n        if new_values.any?\n          inherited_values.keys.tap do |combined|\n            combined.concat(new_values.keys)\n            combined.uniq!\n          end\n        else\n          inherited_values.keys\n        end\n      end\n\n      def key?(name)\n        inherited_values.key?(name) || new_values.key?(name)\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "keys", "signature": "def keys if new_values.any?", "start_line": 30, "end_line": 39}, "metadata": {"module": "Grape", "class_name": "BaseInheritable", "class_signature": "class BaseInheritable"}, "task_id": 571}
{"function_name": "build_path_from_pattern", "file_path": "grape/lib/grape/router/pattern.rb", "focal_code": "def build_path_from_pattern(pattern, anchor)\n        if pattern.end_with?('*path')\n          pattern.dup.insert(pattern.rindex('/') + 1, '?')\n        elsif anchor\n          pattern\n        elsif pattern.end_with?('/')\n          \"#{pattern}?*path\"\n        else\n          \"#{pattern}/?*path\"\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  class Router\n    class Pattern\n      extend Forwardable\n\n      DEFAULT_CAPTURES = %w[format version].freeze\n\n      attr_reader :origin, :path, :pattern, :to_regexp\n\n      def_delegators :pattern, :params\n      def_delegators :to_regexp, :===\n      alias match? ===\n\n      def initialize(origin:, suffix:, anchor:, params:, format:, version:, requirements:)\n        @origin = origin\n        @path = PatternCache[[build_path_from_pattern(@origin, anchor), suffix]]\n        @pattern = Mustermann::Grape.new(@path, uri_decode: true, params:, capture: extract_capture(format, version, requirements))\n        @to_regexp = @pattern.to_regexp\n      end\n\n      def captures_default\n        to_regexp.names\n                 .delete_if { |n| DEFAULT_CAPTURES.include?(n) }\n                 .to_h { |k| [k, ''] }\n      end\n\n      private\n\n      def extract_capture(format, version, requirements)\n        capture = {}\n        capture[:format] = map_str(format) if format.present?\n        capture[:version] = map_str(version) if version.present?\n\n        return capture if requirements.blank?\n\n        requirements.merge(capture)\n      end\n\n      def build_path_from_pattern(pattern, anchor)\n        if pattern.end_with?('*path')\n          pattern.dup.insert(pattern.rindex('/') + 1, '?')\n        elsif anchor\n          pattern\n        elsif pattern.end_with?('/')\n          \"#{pattern}?*path\"\n        else\n          \"#{pattern}/?*path\"\n        end\n      end\n\n      def map_str(value)\n        Array.wrap(value).map(&:to_s)\n      end\n\n      class PatternCache < Grape::Util::Cache\n        def initialize\n          super\n          @cache = Hash.new do |h, (pattern, suffix)|\n            h[[pattern, suffix]] = -\"#{pattern}#{suffix}\"\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_path_from_pattern", "signature": "def build_path_from_pattern(pattern, anchor)", "start_line": 41, "end_line": 51}, "metadata": {"module": "Grape", "class_name": "Router", "class_signature": "class Router"}, "task_id": 572}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/validators/values_validator.rb", "focal_code": "def initialize(attrs, options, required, scope, opts)\n          super\n          values = option_value\n\n          # Zero-arity procs return a collection per-request (e.g. DB-backed lists).\n          # Non-zero-arity procs are per-element predicates, called directly at validation time.\n          # Non-Proc values are wrapped in a zero-arity lambda for a uniform call interface.\n          if values.is_a?(Proc)\n            @values_call = values\n            @values_is_predicate = !values.arity.zero?\n          else\n            @values_call = -> { values }\n            @values_is_predicate = false\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class ValuesValidator < Base\n        default_message_key :values\n\n        def initialize(attrs, options, required, scope, opts)\n          super\n          values = option_value\n\n          # Zero-arity procs return a collection per-request (e.g. DB-backed lists).\n          # Non-zero-arity procs are per-element predicates, called directly at validation time.\n          # Non-Proc values are wrapped in a zero-arity lambda for a uniform call interface.\n          if values.is_a?(Proc)\n            @values_call = values\n            @values_is_predicate = !values.arity.zero?\n          else\n            @values_call = -> { values }\n            @values_is_predicate = false\n          end\n        end\n\n        def validate_param!(attr_name, params)\n          return unless hash_like?(params)\n\n          val = scrub(params[attr_name])\n\n          return if val.nil? && !required_for_root_scope?\n          return if val != false && val.blank? && @allow_blank\n          return if check_values?(val, attr_name)\n\n          validation_error!(attr_name)\n        end\n\n        private\n\n        def check_values?(val, attr_name)\n          param_array = val.nil? ? [nil] : Array.wrap(val)\n\n          if @values_is_predicate\n            begin\n              param_array.all? { |param| @values_call.call(param) }\n            rescue StandardError => e\n              warn \"Error '#{e}' raised while validating attribute '#{attr_name}'\"\n              false\n            end\n          else\n            values = @values_call.call\n            return true if values.nil?\n\n            param_array.all? { |param| values.include?(param) }\n          end\n        end\n\n        def required_for_root_scope?\n          return false unless @required\n\n          scope = @scope\n          scope = scope.parent while scope.lateral?\n\n          scope.root?\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attrs, options, required, scope, opts)", "start_line": 9, "end_line": 23}, "metadata": {"module": "Grape", "class_name": "ValuesValidator", "class_signature": "class ValuesValidator < < Base"}, "task_id": 573}
{"function_name": "check_values?", "file_path": "grape/lib/grape/validations/validators/values_validator.rb", "focal_code": "def check_values?(val, attr_name)\n          param_array = val.nil? ? [nil] : Array.wrap(val)\n\n          if @values_is_predicate\n            begin\n              param_array.all? { |param| @values_call.call(param) }\n            rescue StandardError => e\n              warn \"Error '#{e}' raised while validating attribute '#{attr_name}'\"\n              false\n            end\n          else\n            values = @values_call.call\n            return true if values.nil?\n\n            param_array.all? { |param| values.include?(param) }\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class ValuesValidator < Base\n        default_message_key :values\n\n        def initialize(attrs, options, required, scope, opts)\n          super\n          values = option_value\n\n          # Zero-arity procs return a collection per-request (e.g. DB-backed lists).\n          # Non-zero-arity procs are per-element predicates, called directly at validation time.\n          # Non-Proc values are wrapped in a zero-arity lambda for a uniform call interface.\n          if values.is_a?(Proc)\n            @values_call = values\n            @values_is_predicate = !values.arity.zero?\n          else\n            @values_call = -> { values }\n            @values_is_predicate = false\n          end\n        end\n\n        def validate_param!(attr_name, params)\n          return unless hash_like?(params)\n\n          val = scrub(params[attr_name])\n\n          return if val.nil? && !required_for_root_scope?\n          return if val != false && val.blank? && @allow_blank\n          return if check_values?(val, attr_name)\n\n          validation_error!(attr_name)\n        end\n\n        private\n\n        def check_values?(val, attr_name)\n          param_array = val.nil? ? [nil] : Array.wrap(val)\n\n          if @values_is_predicate\n            begin\n              param_array.all? { |param| @values_call.call(param) }\n            rescue StandardError => e\n              warn \"Error '#{e}' raised while validating attribute '#{attr_name}'\"\n              false\n            end\n          else\n            values = @values_call.call\n            return true if values.nil?\n\n            param_array.all? { |param| values.include?(param) }\n          end\n        end\n\n        def required_for_root_scope?\n          return false unless @required\n\n          scope = @scope\n          scope = scope.parent while scope.lateral?\n\n          scope.root?\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "check_values?", "signature": "def check_values?(val, attr_name)", "start_line": 39, "end_line": 55}, "metadata": {"module": "Grape", "class_name": "ValuesValidator", "class_signature": "class ValuesValidator < < Base"}, "task_id": 574}
{"function_name": "validate!", "file_path": "grape/lib/grape/validations/validators/multiple_params_base.rb", "focal_code": "def validate!(params)\n          attributes = MultipleAttributesIterator.new(@attrs, @scope, params)\n          array_errors = []\n\n          attributes.each do |resource_params|\n            validate_params!(resource_params)\n          rescue Grape::Exceptions::Validation => e\n            array_errors << e\n          end\n\n          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class MultipleParamsBase < Base\n        def validate!(params)\n          attributes = MultipleAttributesIterator.new(@attrs, @scope, params)\n          array_errors = []\n\n          attributes.each do |resource_params|\n            validate_params!(resource_params)\n          rescue Grape::Exceptions::Validation => e\n            array_errors << e\n          end\n\n          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?\n        end\n\n        private\n\n        def keys_in_common(resource_params, known_keys = all_keys)\n          return [] unless hash_like?(resource_params)\n\n          known_keys & resource_params.keys.map! { |attr| @scope.full_name(attr) }\n        end\n\n        def all_keys\n          @attrs.map { |attr| @scope.full_name(attr) }\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate!", "signature": "def validate!(params)", "start_line": 7, "end_line": 18}, "metadata": {"module": "Grape", "class_name": "MultipleParamsBase", "class_signature": "class MultipleParamsBase < < Base"}, "task_id": 575}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/validators/coerce_validator.rb", "focal_code": "def initialize(attrs, options, required, scope, opts)\n          super\n\n          raw_type = @options[:type]\n          type = hash_like?(raw_type) ? raw_type[:value] : raw_type\n          @converter =\n            if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)\n              type\n            else\n              Types.build_coercer(type, method: @options[:method])\n            end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class CoerceValidator < Base\n        default_message_key :coerce\n\n        def initialize(attrs, options, required, scope, opts)\n          super\n\n          raw_type = @options[:type]\n          type = hash_like?(raw_type) ? raw_type[:value] : raw_type\n          @converter =\n            if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)\n              type\n            else\n              Types.build_coercer(type, method: @options[:method])\n            end\n        end\n\n        def validate_param!(attr_name, params)\n          validation_error!(attr_name) unless hash_like?(params)\n\n          new_value = coerce_value(params[attr_name])\n\n          validation_error!(attr_name, new_value.message || @exception_message) if new_value.is_a?(Types::InvalidValue)\n\n          # Don't assign a value if it is identical. It fixes a problem with Hashie::Mash\n          # which looses wrappers for hashes and arrays after reassigning values\n          #\n          #     h = Hashie::Mash.new(list: [1, 2, 3, 4])\n          #     => #<Hashie::Mash list=#<Hashie::Array [1, 2, 3, 4]>>\n          #     list = h.list\n          #     h[:list] = list\n          #     h\n          #     => #<Hashie::Mash list=[1, 2, 3, 4]>\n          return if params[attr_name].instance_of?(new_value.class) && params[attr_name] == new_value\n\n          params[attr_name] = new_value\n        end\n\n        private\n\n        # Calls the converter built at definition time.\n        # Custom coercers may raise; any StandardError is treated as an invalid value.\n        def coerce_value(val)\n          @converter.call(val)\n        rescue StandardError\n          Types::InvalidValue.new\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attrs, options, required, scope, opts)", "start_line": 9, "end_line": 20}, "metadata": {"module": "Grape", "class_name": "CoerceValidator", "class_signature": "class CoerceValidator < < Base"}, "task_id": 576}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/validators/length_validator.rb", "focal_code": "def initialize(attrs, options, required, scope, opts)\n          super\n\n          @min, @max, @is = @options.values_at(:min, :max, :is)\n          validate_boundary!(:min, @min)\n          validate_boundary!(:max, @max)\n          raise ArgumentError, \"min #{@min} cannot be greater than max #{@max}\" if @min && @max && @min > @max\n\n          return if @is.nil?\n          raise ArgumentError, 'is must be an integer greater than zero' unless @is.is_a?(Integer) && @is.positive?\n          raise ArgumentError, 'is cannot be combined with min or max' unless @min.nil? && @max.nil?\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class LengthValidator < Base\n        def initialize(attrs, options, required, scope, opts)\n          super\n\n          @min, @max, @is = @options.values_at(:min, :max, :is)\n          validate_boundary!(:min, @min)\n          validate_boundary!(:max, @max)\n          raise ArgumentError, \"min #{@min} cannot be greater than max #{@max}\" if @min && @max && @min > @max\n\n          return if @is.nil?\n          raise ArgumentError, 'is must be an integer greater than zero' unless @is.is_a?(Integer) && @is.positive?\n          raise ArgumentError, 'is cannot be combined with min or max' unless @min.nil? && @max.nil?\n        end\n\n        def validate_param!(attr_name, params)\n          param = params[attr_name]\n\n          return unless param.respond_to?(:length)\n\n          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)\n\n          validation_error!(attr_name, message do\n            if @min && @max\n              translate(:length, min: @min, max: @max)\n            elsif @min\n              translate(:length_min, min: @min)\n            elsif @max\n              translate(:length_max, max: @max)\n            else\n              translate(:length_is, is: @is)\n            end\n          end)\n        end\n\n        private\n\n        def validate_boundary!(name, val)\n          raise ArgumentError, \"#{name} must be an integer greater than or equal to zero\" if !val.nil? && (!val.is_a?(Integer) || val.negative?)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attrs, options, required, scope, opts)", "start_line": 7, "end_line": 18}, "metadata": {"module": "Grape", "class_name": "LengthValidator", "class_signature": "class LengthValidator < < Base"}, "task_id": 577}
{"function_name": "validate_param!", "file_path": "grape/lib/grape/validations/validators/length_validator.rb", "focal_code": "def validate_param!(attr_name, params)\n          param = params[attr_name]\n\n          return unless param.respond_to?(:length)\n\n          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)\n\n          validation_error!(attr_name, message do\n            if @min && @max\n              translate(:length, min: @min, max: @max)\n            elsif @min\n              translate(:length_min, min: @min)\n            elsif @max\n              translate(:length_max, max: @max)\n            else\n              translate(:length_is, is: @is)\n            end\n          end)\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class LengthValidator < Base\n        def initialize(attrs, options, required, scope, opts)\n          super\n\n          @min, @max, @is = @options.values_at(:min, :max, :is)\n          validate_boundary!(:min, @min)\n          validate_boundary!(:max, @max)\n          raise ArgumentError, \"min #{@min} cannot be greater than max #{@max}\" if @min && @max && @min > @max\n\n          return if @is.nil?\n          raise ArgumentError, 'is must be an integer greater than zero' unless @is.is_a?(Integer) && @is.positive?\n          raise ArgumentError, 'is cannot be combined with min or max' unless @min.nil? && @max.nil?\n        end\n\n        def validate_param!(attr_name, params)\n          param = params[attr_name]\n\n          return unless param.respond_to?(:length)\n\n          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)\n\n          validation_error!(attr_name, message do\n            if @min && @max\n              translate(:length, min: @min, max: @max)\n            elsif @min\n              translate(:length_min, min: @min)\n            elsif @max\n              translate(:length_max, max: @max)\n            else\n              translate(:length_is, is: @is)\n            end\n          end)\n        end\n\n        private\n\n        def validate_boundary!(name, val)\n          raise ArgumentError, \"#{name} must be an integer greater than or equal to zero\" if !val.nil? && (!val.is_a?(Integer) || val.negative?)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate_param!", "signature": "def validate_param!(attr_name, params)", "start_line": 20, "end_line": 38}, "metadata": {"module": "Grape", "class_name": "LengthValidator", "class_signature": "class LengthValidator < < Base"}, "task_id": 578}
{"function_name": "validate!", "file_path": "grape/lib/grape/validations/validators/base.rb", "focal_code": "def validate!(params)\n          attributes = SingleAttributeIterator.new(@attrs, @scope, params)\n          # we collect errors inside array because\n          # there may be more than one error per field\n          array_errors = []\n\n          attributes.each do |val, attr_name, empty_val|\n            next if !@scope.required? && empty_val\n            next unless @scope.meets_dependency?(val, params)\n\n            validate_param!(attr_name, val) if @required || (hash_like?(val) && val.key?(attr_name))\n          rescue Grape::Exceptions::Validation => e\n            array_errors << e\n          end\n\n          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      # Base class for all parameter validators.\n      #\n      # == Freeze contract\n      # Validator instances are shared across requests and are frozen after\n      # initialization (via +.new+). All inputs (+options+, +opts+, +attrs+)\n      # arrive pre-frozen from the DSL boundary, so subclass ivars derived\n      # from them are frozen by construction. Lazy ivar assignment\n      # (e.g. +memoize+, <tt>||=</tt>) will raise +FrozenError+ at request time.\n      class Base\n        include Grape::Util::Translation\n\n        attr_reader :attrs\n\n        class << self\n          # Declares the default I18n message key used by +validation_error!+.\n          # Subclasses that only need a single fixed error message can declare it\n          # at the class level instead of overriding +initialize+:\n          #\n          #   class MyValidator < Grape::Validations::Validators::Base\n          #     default_message_key :my_error\n          #   end\n          #\n          # The key is resolved through +message+, so a per-option +:message+\n          # override still takes precedence.\n          def default_message_key(key = nil)\n            if key\n              @default_message_key = key\n            else\n              @default_message_key || (superclass.respond_to?(:default_message_key) ? superclass.default_message_key : nil)\n            end\n          end\n\n          def new(...)\n            super.freeze\n          end\n\n          def inherited(klass)\n            super\n            Validations.register(klass)\n          end\n        end\n\n        # Creates a new Validator from options specified\n        # by a +requires+ or +optional+ directive during\n        # parameter definition.\n        # @param attrs [Array] names of attributes to which the Validator applies\n        # @param options [Object] implementation-dependent Validator options; deep-frozen on assignment\n        # @param required [Boolean] attribute(s) are required or optional\n        # @param scope [ParamsScope] parent scope for this Validator\n        # @param opts [Hash] additional validation options\n        def initialize(attrs, options, required, scope, opts)\n          @attrs = Array(attrs).freeze\n          @options = Grape::Util::DeepFreeze.deep_freeze(options)\n          @option = @options # TODO: remove in next major release\n          @required = required\n          @scope = scope\n          @fail_fast, @allow_blank = opts.values_at(:fail_fast, :allow_blank)\n          @exception_message = message(self.class.default_message_key) if self.class.default_message_key\n        end\n\n        # Validates a given request.\n        # @note Override #validate! unless you need to access the entire request.\n        # @param request [Grape::Request] the request currently being handled\n        # @raise [Grape::Exceptions::Validation] if validation failed\n        # @return [void]\n        def validate(request)\n          return unless @scope.should_validate?(request.params)\n\n          validate!(request.params)\n        end\n\n        def fail_fast?\n          @fail_fast\n        end\n\n        # Validates a given parameter hash.\n        # @note Override #validate_param! for per-parameter validation,\n        #   or #validate if you need access to the entire request.\n        # @param params [Hash] parameters to validate\n        # @raise [Grape::Exceptions::Validation] if validation failed\n        # @return [void]\n        def validate!(params)\n          attributes = SingleAttributeIterator.new(@attrs, @scope, params)\n          # we collect errors inside array because\n          # there may be more than one error per field\n          array_errors = []\n\n          attributes.each do |val, attr_name, empty_val|\n            next if !@scope.required? && empty_val\n            next unless @scope.meets_dependency?(val, params)\n\n            validate_param!(attr_name, val) if @required || (hash_like?(val) && val.key?(attr_name))\n          rescue Grape::Exceptions::Validation => e\n            array_errors << e\n          end\n\n          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?\n        end\n\n        protected\n\n        # Validates a single attribute. Override in subclasses.\n        # @param attr_name [Symbol, String] the attribute name\n        # @param params [Hash] the parameter hash containing the attribute\n        # @raise [Grape::Exceptions::Validation] if validation failed\n        # @return [void]\n        def validate_param!(attr_name, params)\n          raise NotImplementedError\n        end\n\n        private\n\n        def validation_error!(attr_name_or_params, message = @exception_message)\n          params = attr_name_or_params.is_a?(Array) ? attr_name_or_params : @scope.full_name(attr_name_or_params)\n          raise Grape::Exceptions::Validation.new(params:, message:)\n        end\n\n        def hash_like?(obj)\n          obj.respond_to?(:key?)\n        end\n\n        def options_key?(key, options = nil)\n          current_options = options || @options\n          hash_like?(current_options) && current_options.key?(key) && !current_options[key].nil?\n        end\n\n        # Returns the effective message for a validation error.\n        # Prefers an explicit +:message+ option, then +default_key+.\n        # If both are nil, the block (if given) is called to compute a fallback —\n        # useful for validators that build a message Hash for deferred i18n interpolation.\n        # @example\n        #   @exception_message = message(:presence)             # symbol key or custom message\n        #   @exception_message = message { build_hash_message } # computed fallback\n        def message(default_key = nil)\n          key = options_key?(:message) ? @options[:message] : default_key\n          return key unless key.nil?\n\n          yield if block_given?\n        end\n\n        def option_value\n          options_key?(:value) ? @options[:value] : @options\n        end\n\n        def scrub(value)\n          return value unless value.respond_to?(:valid_encoding?) && !value.valid_encoding?\n\n          value.scrub\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "validate!", "signature": "def validate!(params)", "start_line": 87, "end_line": 103}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base"}, "task_id": 579}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/validators/default_validator.rb", "focal_code": "def initialize(attrs, options, required, scope, opts)\n          super\n          # !important, lazy call at runtime\n          @default_call =\n            if @options.is_a?(Proc)\n              @options.arity.zero? ? proc { @options.call } : @options\n            elsif @options.duplicable?\n              proc { @options.dup }\n            else\n              proc { @options }\n            end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Validators\n      class DefaultValidator < Base\n        def initialize(attrs, options, required, scope, opts)\n          super\n          # !important, lazy call at runtime\n          @default_call =\n            if @options.is_a?(Proc)\n              @options.arity.zero? ? proc { @options.call } : @options\n            elsif @options.duplicable?\n              proc { @options.dup }\n            else\n              proc { @options }\n            end\n        end\n\n        def validate!(params)\n          attrs = SingleAttributeIterator.new(@attrs, @scope, params)\n          attrs.each do |resource_params, attr_name|\n            next unless @scope.meets_dependency?(resource_params, params)\n\n            resource_params[attr_name] = @default_call.call(resource_params) if hash_like?(resource_params) && resource_params[attr_name].nil?\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(attrs, options, required, scope, opts)", "start_line": 7, "end_line": 18}, "metadata": {"module": "Grape", "class_name": "DefaultValidator", "class_signature": "class DefaultValidator < < Base"}, "task_id": 580}
{"function_name": "reject?", "file_path": "grape/lib/grape/validations/types/primitive_coercer.rb", "focal_code": "def reject?(val)\n          case val\n          when Array, Hash\n            type == String\n          when String\n            type == Hash\n          else\n            false\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # Coerces the given value to a type defined via a +type+ argument during\n      # initialization. When +strict+ is true, it doesn't coerce a value but check\n      # that it has the proper type.\n      class PrimitiveCoercer < DryTypeCoercer\n        def initialize(type, strict: false)\n          super\n\n          @coercer = cache_coercer[type]\n        end\n\n        def call(val)\n          return InvalidValue.new if reject?(val)\n          return nil if val.nil? || treat_as_nil?(val)\n\n          super\n        end\n\n        protected\n\n        attr_reader :type\n\n        # This method maintains logic which was defined by Virtus. For example,\n        # dry-types is ok to convert an array or a hash to a string, it is supported,\n        # but Virtus wouldn't accept it. So, this method only exists to not introduce\n        # breaking changes.\n        def reject?(val)\n          case val\n          when Array, Hash\n            type == String\n          when String\n            type == Hash\n          else\n            false\n          end\n        end\n\n        # Dry-Types treats an empty string as invalid. However, Grape considers an empty string as\n        # absence of a value and coerces it into nil. See a discussion there\n        # https://github.com/ruby-grape/grape/pull/2045\n        def treat_as_nil?(val)\n          val == '' && type != String\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "reject?", "signature": "def reject?(val)", "start_line": 31, "end_line": 40}, "metadata": {"module": "Grape", "class_name": "PrimitiveCoercer", "class_signature": "class PrimitiveCoercer < < DryTypeCoercer"}, "task_id": 581}
{"function_name": "initialize", "file_path": "grape/lib/grape/validations/types/multiple_type_coercer.rb", "focal_code": "def initialize(types, method = nil)\n          @method = method.respond_to?(:parse) ? method.method(:parse) : method\n\n          @type_coercers = types.map do |type|\n            if Types.multiple? type\n              VariantCollectionCoercer.new type, @method\n            else\n              Types.build_coercer type, strict: !@method.nil?\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # This class is intended for use with Grape endpoint parameters that\n      # have been declared to be of variant-type using the +:types+ option.\n      # +MultipleTypeCoercer+ will build a coercer for each type declared\n      # in the array passed to +:types+ using {Types.build_coercer}. It will\n      # apply these coercers to parameter values in the order given to\n      # +:types+, and will return the value returned by the first coercer\n      # to successfully coerce the parameter value. Therefore if +String+ is\n      # an allowed type it should be declared last, since it will always\n      # successfully \"coerce\" the value.\n      class MultipleTypeCoercer\n        # Construct a new coercer that will attempt to coerce\n        # values to the given list of types in the given order.\n        #\n        # @param types [Array<Class>] list of allowed types\n        # @param method [#call,#parse] method by which values should be\n        #   coerced. See class docs for default behaviour.\n        def initialize(types, method = nil)\n          @method = method.respond_to?(:parse) ? method.method(:parse) : method\n\n          @type_coercers = types.map do |type|\n            if Types.multiple? type\n              VariantCollectionCoercer.new type, @method\n            else\n              Types.build_coercer type, strict: !@method.nil?\n            end\n          end\n        end\n\n        # Coerces the given value.\n        #\n        # @param val [String] value to be coerced, in grape\n        #   this should always be a string.\n        # @return [Object,InvalidValue] the coerced result, or an instance\n        #   of {InvalidValue} if the value could not be coerced.\n        def call(val)\n          # once the value is coerced by the custom method, its type should be checked\n          val = @method.call(val) if @method\n\n          coerced_val = InvalidValue.new\n\n          @type_coercers.each do |coercer|\n            coerced_val = coercer.call(val)\n\n            return coerced_val unless coerced_val.is_a?(InvalidValue)\n          end\n\n          coerced_val\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(types, method = nil)", "start_line": 22, "end_line": 32}, "metadata": {"module": "Grape", "class_name": "MultipleTypeCoercer", "class_signature": "class MultipleTypeCoercer"}, "task_id": 582}
{"function_name": "collection_coercer_for", "file_path": "grape/lib/grape/validations/types/dry_type_coercer.rb", "focal_code": "def collection_coercer_for(type)\n            case type\n            when Array\n              ArrayCoercer\n            when Set\n              SetCoercer\n            else\n              raise ArgumentError, \"Unknown type: #{type}\"\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # A base class for classes which must identify a coercer to be used.\n      # If the +strict+ argument is true, it won't coerce the given value\n      # but check its type. More information there\n      # https://dry-rb.org/gems/dry-types/main/built-in-types/\n      class DryTypeCoercer\n        class << self\n          # Returns a collection coercer which corresponds to a given type.\n          # Example:\n          #\n          #    collection_coercer_for(Array)\n          #    #=> Grape::Validations::Types::ArrayCoercer\n          def collection_coercer_for(type)\n            case type\n            when Array\n              ArrayCoercer\n            when Set\n              SetCoercer\n            else\n              raise ArgumentError, \"Unknown type: #{type}\"\n            end\n          end\n\n          # Returns an instance of a coercer for a given type\n          def coercer_instance_for(type, strict: false)\n            klass = type.instance_of?(Class) ? PrimitiveCoercer : collection_coercer_for(type)\n            klass.new(type, strict:)\n          end\n        end\n\n        def initialize(type, strict: false)\n          @type = type\n          @strict = strict\n          @cache_coercer = strict ? DryTypes::StrictCache : DryTypes::ParamsCache\n        end\n\n        # Coerces the given value to a type which was specified during\n        # initialization as a type argument.\n        #\n        # @param val [Object]\n        def call(val)\n          return if val.nil?\n\n          @coercer[val]\n        rescue Dry::Types::CoercionError\n          InvalidValue.new\n        end\n\n        protected\n\n        attr_reader :type, :strict, :cache_coercer\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "collection_coercer_for", "signature": "def collection_coercer_for(type)", "start_line": 17, "end_line": 26}, "metadata": {"module": "Grape", "class_name": "DryTypeCoercer", "class_signature": "class DryTypeCoercer"}, "task_id": 583}
{"function_name": "infer_coercion_method", "file_path": "grape/lib/grape/validations/types/custom_type_coercer.rb", "focal_code": "def infer_coercion_method(type, method)\n          if method\n            if method.respond_to? :parse\n              method.method :parse\n            else\n              method\n            end\n          else\n            # Try to use parse() declared on the target type.\n            # This may raise an exception, but we are out of ideas anyway.\n            type.method :parse\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # This class will detect type classes that implement\n      # a class-level +parse+ method. The method should accept one\n      # +String+ argument and should return the value coerced to\n      # the appropriate type. The method may raise an exception if\n      # there are any problems parsing the string.\n      #\n      # Alternately an optional +method+ may be supplied (see the\n      # +coerce_with+ option of {Grape::Dsl::Parameters#requires}).\n      # This may be any class or object implementing +parse+ or +call+,\n      # with the same contract as described above.\n      #\n      # Type Checking\n      # -------------\n      #\n      # Calls to +coerced?+ will consult this class to check\n      # that the coerced value produced above is in fact of the\n      # expected type. By default this class performs a basic check\n      # against the type supplied, but this behaviour will be\n      # overridden if the class implements a class-level\n      # +coerced?+ or +parsed?+ method. This method\n      # will receive a single parameter that is the coerced value\n      # and should return +true+ if the value meets type expectations.\n      # Arbitrary assertions may be made here but the grape validation\n      # system should be preferred.\n      #\n      # Alternately a proc or other object responding to +call+ may be\n      # supplied in place of a type. This should implement the same\n      # contract as +coerced?+, and must be supplied with a coercion\n      # +method+.\n      class CustomTypeCoercer\n        # A new coercer for the given type specification\n        # and coercion method.\n        #\n        # @param type [Class,#coerced?,#parsed?,#call?]\n        #   specifier for the target type. See class docs.\n        # @param method [#parse,#call]\n        #   optional coercion method. See class docs.\n        def initialize(type, method = nil)\n          coercion_method = infer_coercion_method type, method\n          @method = enforce_symbolized_keys type, coercion_method\n          @type_check = infer_type_check(type)\n        end\n\n        # Coerces the given value.\n        #\n        # @param value [String] value to be coerced, in grape\n        #   this should always be a string.\n        # @return [Object] the coerced result\n        def call(val)\n          coerced_val = @method.call(val)\n\n          return coerced_val if coerced_val.is_a?(InvalidValue)\n          return InvalidValue.new unless coerced?(coerced_val)\n\n          coerced_val\n        end\n\n        def coerced?(val)\n          val.nil? || @type_check.call(val)\n        end\n\n        private\n\n        # Determine the coercion method we're expected to use\n        # based on the parameters given.\n        #\n        # @param type see #new\n        # @param method see #new\n        # @return [#call] coercion method\n        def infer_coercion_method(type, method)\n          if method\n            if method.respond_to? :parse\n              method.method :parse\n            else\n              method\n            end\n          else\n            # Try to use parse() declared on the target type.\n            # This may raise an exception, but we are out of ideas anyway.\n            type.method :parse\n          end\n        end\n\n        # Determine how the type validity of a coerced\n        # value should be decided.\n        #\n        # @param type see #new\n        # @return [#call] a procedure which accepts a single parameter\n        #   and returns +true+ if the passed object is of the correct type.\n        def infer_type_check(type)\n          # First check for special class methods\n          if type.respond_to? :coerced?\n            type.method :coerced?\n          elsif type.respond_to? :parsed?\n            type.method :parsed?\n          elsif type.respond_to? :call\n            # Arbitrary proc passed for type validation.\n            # Note that this will fail unless a method is also\n            # passed, or if the type also implements a parse() method.\n            type\n          elsif type.is_a?(Enumerable)\n            lambda do |value|\n              value.is_a?(Enumerable) && value.all? do |val|\n                recursive_type_check(type.first, val)\n              end\n            end\n          else\n            # By default, do a simple type check\n            ->(value) { value.is_a? type }\n          end\n        end\n\n        def recursive_type_check(type, value)\n          if type.is_a?(Enumerable) && value.is_a?(Enumerable)\n            value.all? { |val| recursive_type_check(type.first, val) }\n          else\n            !type.is_a?(Enumerable) && value.is_a?(type)\n          end\n        end\n\n        # Enforce symbolized keys for complex types\n        # by wrapping the coercion method such that\n        # any Hash objects in the immediate heirarchy\n        # have their keys recursively symbolized.\n        # This helps common libs such as JSON to work easily.\n        #\n        # @param type see #new\n        # @param method see #infer_coercion_method\n        # @return [#call] +method+ wrapped in an additional\n        #   key-conversion step, or just returns +method+\n        #   itself if no conversion is deemed to be\n        #   necessary.\n        def enforce_symbolized_keys(type, method)\n          # Collections have all values processed individually\n          if [Array, Set].include?(type)\n            lambda do |val|\n              method.call(val).tap do |new_val|\n                new_val.map do |item|\n                  item.is_a?(Hash) ? item.deep_symbolize_keys : item\n                end\n              end\n            end\n\n          # Hash objects are processed directly\n          elsif type == Hash\n            lambda do |val|\n              method.call(val).deep_symbolize_keys\n            end\n\n          # Simple types are not processed.\n          # This includes Array<primitive> types.\n          else\n            method\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "infer_coercion_method", "signature": "def infer_coercion_method(type, method)", "start_line": 75, "end_line": 87}, "metadata": {"module": "Grape", "class_name": "CustomTypeCoercer", "class_signature": "class CustomTypeCoercer"}, "task_id": 584}
{"function_name": "infer_type_check", "file_path": "grape/lib/grape/validations/types/custom_type_coercer.rb", "focal_code": "def infer_type_check(type)\n          # First check for special class methods\n          if type.respond_to? :coerced?\n            type.method :coerced?\n          elsif type.respond_to? :parsed?\n            type.method :parsed?\n          elsif type.respond_to? :call\n            # Arbitrary proc passed for type validation.\n            # Note that this will fail unless a method is also\n            # passed, or if the type also implements a parse() method.\n            type\n          elsif type.is_a?(Enumerable)\n            lambda do |value|\n              value.is_a?(Enumerable) && value.all? do |val|\n                recursive_type_check(type.first, val)\n              end\n            end\n          else\n            # By default, do a simple type check\n            ->(value) { value.is_a? type }\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # This class will detect type classes that implement\n      # a class-level +parse+ method. The method should accept one\n      # +String+ argument and should return the value coerced to\n      # the appropriate type. The method may raise an exception if\n      # there are any problems parsing the string.\n      #\n      # Alternately an optional +method+ may be supplied (see the\n      # +coerce_with+ option of {Grape::Dsl::Parameters#requires}).\n      # This may be any class or object implementing +parse+ or +call+,\n      # with the same contract as described above.\n      #\n      # Type Checking\n      # -------------\n      #\n      # Calls to +coerced?+ will consult this class to check\n      # that the coerced value produced above is in fact of the\n      # expected type. By default this class performs a basic check\n      # against the type supplied, but this behaviour will be\n      # overridden if the class implements a class-level\n      # +coerced?+ or +parsed?+ method. This method\n      # will receive a single parameter that is the coerced value\n      # and should return +true+ if the value meets type expectations.\n      # Arbitrary assertions may be made here but the grape validation\n      # system should be preferred.\n      #\n      # Alternately a proc or other object responding to +call+ may be\n      # supplied in place of a type. This should implement the same\n      # contract as +coerced?+, and must be supplied with a coercion\n      # +method+.\n      class CustomTypeCoercer\n        # A new coercer for the given type specification\n        # and coercion method.\n        #\n        # @param type [Class,#coerced?,#parsed?,#call?]\n        #   specifier for the target type. See class docs.\n        # @param method [#parse,#call]\n        #   optional coercion method. See class docs.\n        def initialize(type, method = nil)\n          coercion_method = infer_coercion_method type, method\n          @method = enforce_symbolized_keys type, coercion_method\n          @type_check = infer_type_check(type)\n        end\n\n        # Coerces the given value.\n        #\n        # @param value [String] value to be coerced, in grape\n        #   this should always be a string.\n        # @return [Object] the coerced result\n        def call(val)\n          coerced_val = @method.call(val)\n\n          return coerced_val if coerced_val.is_a?(InvalidValue)\n          return InvalidValue.new unless coerced?(coerced_val)\n\n          coerced_val\n        end\n\n        def coerced?(val)\n          val.nil? || @type_check.call(val)\n        end\n\n        private\n\n        # Determine the coercion method we're expected to use\n        # based on the parameters given.\n        #\n        # @param type see #new\n        # @param method see #new\n        # @return [#call] coercion method\n        def infer_coercion_method(type, method)\n          if method\n            if method.respond_to? :parse\n              method.method :parse\n            else\n              method\n            end\n          else\n            # Try to use parse() declared on the target type.\n            # This may raise an exception, but we are out of ideas anyway.\n            type.method :parse\n          end\n        end\n\n        # Determine how the type validity of a coerced\n        # value should be decided.\n        #\n        # @param type see #new\n        # @return [#call] a procedure which accepts a single parameter\n        #   and returns +true+ if the passed object is of the correct type.\n        def infer_type_check(type)\n          # First check for special class methods\n          if type.respond_to? :coerced?\n            type.method :coerced?\n          elsif type.respond_to? :parsed?\n            type.method :parsed?\n          elsif type.respond_to? :call\n            # Arbitrary proc passed for type validation.\n            # Note that this will fail unless a method is also\n            # passed, or if the type also implements a parse() method.\n            type\n          elsif type.is_a?(Enumerable)\n            lambda do |value|\n              value.is_a?(Enumerable) && value.all? do |val|\n                recursive_type_check(type.first, val)\n              end\n            end\n          else\n            # By default, do a simple type check\n            ->(value) { value.is_a? type }\n          end\n        end\n\n        def recursive_type_check(type, value)\n          if type.is_a?(Enumerable) && value.is_a?(Enumerable)\n            value.all? { |val| recursive_type_check(type.first, val) }\n          else\n            !type.is_a?(Enumerable) && value.is_a?(type)\n          end\n        end\n\n        # Enforce symbolized keys for complex types\n        # by wrapping the coercion method such that\n        # any Hash objects in the immediate heirarchy\n        # have their keys recursively symbolized.\n        # This helps common libs such as JSON to work easily.\n        #\n        # @param type see #new\n        # @param method see #infer_coercion_method\n        # @return [#call] +method+ wrapped in an additional\n        #   key-conversion step, or just returns +method+\n        #   itself if no conversion is deemed to be\n        #   necessary.\n        def enforce_symbolized_keys(type, method)\n          # Collections have all values processed individually\n          if [Array, Set].include?(type)\n            lambda do |val|\n              method.call(val).tap do |new_val|\n                new_val.map do |item|\n                  item.is_a?(Hash) ? item.deep_symbolize_keys : item\n                end\n              end\n            end\n\n          # Hash objects are processed directly\n          elsif type == Hash\n            lambda do |val|\n              method.call(val).deep_symbolize_keys\n            end\n\n          # Simple types are not processed.\n          # This includes Array<primitive> types.\n          else\n            method\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "infer_type_check", "signature": "def infer_type_check(type)", "start_line": 95, "end_line": 116}, "metadata": {"module": "Grape", "class_name": "CustomTypeCoercer", "class_signature": "class CustomTypeCoercer"}, "task_id": 585}
{"function_name": "enforce_symbolized_keys", "file_path": "grape/lib/grape/validations/types/custom_type_coercer.rb", "focal_code": "def enforce_symbolized_keys(type, method)\n          # Collections have all values processed individually\n          if [Array, Set].include?(type)\n            lambda do |val|\n              method.call(val).tap do |new_val|\n                new_val.map do |item|\n                  item.is_a?(Hash) ? item.deep_symbolize_keys : item\n                end\n              end\n            end\n\n          # Hash objects are processed directly\n          elsif type == Hash\n            lambda do |val|\n              method.call(val).deep_symbolize_keys\n            end\n\n          # Simple types are not processed.\n          # This includes Array<primitive> types.\n          else\n            method\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # This class will detect type classes that implement\n      # a class-level +parse+ method. The method should accept one\n      # +String+ argument and should return the value coerced to\n      # the appropriate type. The method may raise an exception if\n      # there are any problems parsing the string.\n      #\n      # Alternately an optional +method+ may be supplied (see the\n      # +coerce_with+ option of {Grape::Dsl::Parameters#requires}).\n      # This may be any class or object implementing +parse+ or +call+,\n      # with the same contract as described above.\n      #\n      # Type Checking\n      # -------------\n      #\n      # Calls to +coerced?+ will consult this class to check\n      # that the coerced value produced above is in fact of the\n      # expected type. By default this class performs a basic check\n      # against the type supplied, but this behaviour will be\n      # overridden if the class implements a class-level\n      # +coerced?+ or +parsed?+ method. This method\n      # will receive a single parameter that is the coerced value\n      # and should return +true+ if the value meets type expectations.\n      # Arbitrary assertions may be made here but the grape validation\n      # system should be preferred.\n      #\n      # Alternately a proc or other object responding to +call+ may be\n      # supplied in place of a type. This should implement the same\n      # contract as +coerced?+, and must be supplied with a coercion\n      # +method+.\n      class CustomTypeCoercer\n        # A new coercer for the given type specification\n        # and coercion method.\n        #\n        # @param type [Class,#coerced?,#parsed?,#call?]\n        #   specifier for the target type. See class docs.\n        # @param method [#parse,#call]\n        #   optional coercion method. See class docs.\n        def initialize(type, method = nil)\n          coercion_method = infer_coercion_method type, method\n          @method = enforce_symbolized_keys type, coercion_method\n          @type_check = infer_type_check(type)\n        end\n\n        # Coerces the given value.\n        #\n        # @param value [String] value to be coerced, in grape\n        #   this should always be a string.\n        # @return [Object] the coerced result\n        def call(val)\n          coerced_val = @method.call(val)\n\n          return coerced_val if coerced_val.is_a?(InvalidValue)\n          return InvalidValue.new unless coerced?(coerced_val)\n\n          coerced_val\n        end\n\n        def coerced?(val)\n          val.nil? || @type_check.call(val)\n        end\n\n        private\n\n        # Determine the coercion method we're expected to use\n        # based on the parameters given.\n        #\n        # @param type see #new\n        # @param method see #new\n        # @return [#call] coercion method\n        def infer_coercion_method(type, method)\n          if method\n            if method.respond_to? :parse\n              method.method :parse\n            else\n              method\n            end\n          else\n            # Try to use parse() declared on the target type.\n            # This may raise an exception, but we are out of ideas anyway.\n            type.method :parse\n          end\n        end\n\n        # Determine how the type validity of a coerced\n        # value should be decided.\n        #\n        # @param type see #new\n        # @return [#call] a procedure which accepts a single parameter\n        #   and returns +true+ if the passed object is of the correct type.\n        def infer_type_check(type)\n          # First check for special class methods\n          if type.respond_to? :coerced?\n            type.method :coerced?\n          elsif type.respond_to? :parsed?\n            type.method :parsed?\n          elsif type.respond_to? :call\n            # Arbitrary proc passed for type validation.\n            # Note that this will fail unless a method is also\n            # passed, or if the type also implements a parse() method.\n            type\n          elsif type.is_a?(Enumerable)\n            lambda do |value|\n              value.is_a?(Enumerable) && value.all? do |val|\n                recursive_type_check(type.first, val)\n              end\n            end\n          else\n            # By default, do a simple type check\n            ->(value) { value.is_a? type }\n          end\n        end\n\n        def recursive_type_check(type, value)\n          if type.is_a?(Enumerable) && value.is_a?(Enumerable)\n            value.all? { |val| recursive_type_check(type.first, val) }\n          else\n            !type.is_a?(Enumerable) && value.is_a?(type)\n          end\n        end\n\n        # Enforce symbolized keys for complex types\n        # by wrapping the coercion method such that\n        # any Hash objects in the immediate heirarchy\n        # have their keys recursively symbolized.\n        # This helps common libs such as JSON to work easily.\n        #\n        # @param type see #new\n        # @param method see #infer_coercion_method\n        # @return [#call] +method+ wrapped in an additional\n        #   key-conversion step, or just returns +method+\n        #   itself if no conversion is deemed to be\n        #   necessary.\n        def enforce_symbolized_keys(type, method)\n          # Collections have all values processed individually\n          if [Array, Set].include?(type)\n            lambda do |val|\n              method.call(val).tap do |new_val|\n                new_val.map do |item|\n                  item.is_a?(Hash) ? item.deep_symbolize_keys : item\n                end\n              end\n            end\n\n          # Hash objects are processed directly\n          elsif type == Hash\n            lambda do |val|\n              method.call(val).deep_symbolize_keys\n            end\n\n          # Simple types are not processed.\n          # This includes Array<primitive> types.\n          else\n            method\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "enforce_symbolized_keys", "signature": "def enforce_symbolized_keys(type, method)", "start_line": 138, "end_line": 160}, "metadata": {"module": "Grape", "class_name": "CustomTypeCoercer", "class_signature": "class CustomTypeCoercer"}, "task_id": 586}
{"function_name": "call", "file_path": "grape/lib/grape/validations/types/variant_collection_coercer.rb", "focal_code": "def call(value)\n          return unless value.is_a? Array\n\n          value =\n            if @method\n              @method.call(value)\n            else\n              value.map { |v| @member_coercer.call(v) }\n            end\n          return Set.new value if @types.is_a? Set\n\n          value\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # This class wraps {MultipleTypeCoercer}, for use with collections\n      # that allow members of more than one type.\n      class VariantCollectionCoercer\n        # Construct a new coercer that will attempt to coerce\n        # a list of values such that all members are of one of\n        # the given types. The container may also optionally be\n        # coerced to a +Set+. An arbitrary coercion +method+ may\n        # be supplied, which will be passed the entire collection\n        # as a parameter and should return a new collection, or\n        # may return the same one if no coercion was required.\n        #\n        # @param types [Array<Class>,Set<Class>] list of allowed types,\n        #   also specifying the container type\n        # @param method [#call,#parse] method by which values should be coerced\n        def initialize(types, method = nil)\n          @types = types\n          @method = method.respond_to?(:parse) ? method.method(:parse) : method\n\n          # If we have a coercion method, pass it in here to save\n          # building another one, even though we call it directly.\n          @member_coercer = MultipleTypeCoercer.new types, method\n        end\n\n        # Coerce the given value.\n        #\n        # @param value [Array<String>] collection of values to be coerced\n        # @return [Array<Object>,Set<Object>,InvalidValue]\n        #   the coerced result, or an instance\n        #   of {InvalidValue} if the value could not be coerced.\n        def call(value)\n          return unless value.is_a? Array\n\n          value =\n            if @method\n              @method.call(value)\n            else\n              value.map { |v| @member_coercer.call(v) }\n            end\n          return Set.new value if @types.is_a? Set\n\n          value\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(value)", "start_line": 35, "end_line": 47}, "metadata": {"module": "Grape", "class_name": "VariantCollectionCoercer", "class_signature": "class VariantCollectionCoercer"}, "task_id": 587}
{"function_name": "coerce_elements", "file_path": "grape/lib/grape/validations/types/array_coercer.rb", "focal_code": "def coerce_elements(collection)\n          return if collection.nil?\n\n          collection.each_with_index do |elem, index|\n            return InvalidValue.new if reject?(elem)\n\n            coerced_elem = elem_coercer.call(elem)\n\n            return coerced_elem if coerced_elem.is_a?(InvalidValue)\n\n            collection[index] = coerced_elem\n          end\n\n          collection\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Validations\n    module Types\n      # Coerces elements in an array. It might be an array of strings or integers or\n      # an array of arrays of integers.\n      #\n      # It could've been possible to use an +of+\n      # method (https://dry-rb.org/gems/dry-types/main/array-with-member/)\n      # provided by dry-types. Unfortunately, it doesn't work for Grape because of\n      # behavior of Virtus which was used earlier, a `Grape::Validations::Types::PrimitiveCoercer`\n      # maintains Virtus behavior in coercing.\n      class ArrayCoercer < DryTypeCoercer\n        def initialize(type, strict: false)\n          super\n          @coercer = strict ? DryTypes::Strict::Array : DryTypes::Params::Array\n          @subtype = type.first\n        end\n\n        def call(_val)\n          collection = super\n          return collection if collection.is_a?(InvalidValue)\n\n          coerce_elements collection\n        end\n\n        protected\n\n        attr_reader :subtype\n\n        def coerce_elements(collection)\n          return if collection.nil?\n\n          collection.each_with_index do |elem, index|\n            return InvalidValue.new if reject?(elem)\n\n            coerced_elem = elem_coercer.call(elem)\n\n            return coerced_elem if coerced_elem.is_a?(InvalidValue)\n\n            collection[index] = coerced_elem\n          end\n\n          collection\n        end\n\n        # This method maintains logic which was defined by Virtus for arrays.\n        # Virtus doesn't allow nil in arrays.\n        def reject?(val)\n          val.nil?\n        end\n\n        def elem_coercer\n          @elem_coercer ||= DryTypeCoercer.coercer_instance_for(subtype, strict:)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "coerce_elements", "signature": "def coerce_elements(collection)", "start_line": 32, "end_line": 46}, "metadata": {"module": "Grape", "class_name": "ArrayCoercer", "class_signature": "class ArrayCoercer < < DryTypeCoercer"}, "task_id": 588}
{"function_name": "build_available_media_types", "file_path": "grape/lib/grape/middleware/versioner/base.rb", "focal_code": "def build_available_media_types\n          media_types = []\n          base_media_type = \"application/vnd.#{vendor}\"\n          content_types.each_key do |extension|\n            versions&.reverse_each do |version|\n              media_types << \"#{base_media_type}-#{version}+#{extension}\"\n              media_types << \"#{base_media_type}-#{version}\"\n            end\n            media_types << \"#{base_media_type}+#{extension}\"\n          end\n\n          media_types << base_media_type\n          media_types.concat(content_types.values.flatten)\n          media_types\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    module Versioner\n      class Base < Grape::Middleware::Base\n        include Grape::Middleware::PrecomputedContentTypes\n\n        DEFAULT_OPTIONS = {\n          pattern: /.*/i,\n          prefix: nil,\n          mount_path: nil,\n          version_options: {\n            strict: false,\n            cascade: true,\n            parameter: 'apiver',\n            vendor: nil\n          }.freeze\n        }.freeze\n\n        CASCADE_PASS_HEADER = { 'X-Cascade' => 'pass' }.freeze\n\n        DEFAULT_OPTIONS.each_key do |key|\n          define_method key do\n            options[key]\n          end\n        end\n\n        DEFAULT_OPTIONS[:version_options].each_key do |key|\n          define_method key do\n            options[:version_options][key]\n          end\n        end\n\n        def self.inherited(klass)\n          super\n          Versioner.register(klass)\n        end\n\n        attr_reader :error_headers, :versions, :available_media_types\n\n        def initialize(app, **options)\n          super\n          @error_headers = cascade ? CASCADE_PASS_HEADER : {}\n          @versions = options[:versions]&.map(&:to_s) # making sure versions are strings to ease potential match\n          @available_media_types = build_available_media_types\n        end\n\n        def potential_version_match?(potential_version)\n          versions.blank? || versions.include?(potential_version)\n        end\n\n        def version_not_found!\n          throw :error, status: 404, message: '404 API Version Not Found', headers: CASCADE_PASS_HEADER\n        end\n\n        private\n\n        def build_available_media_types\n          media_types = []\n          base_media_type = \"application/vnd.#{vendor}\"\n          content_types.each_key do |extension|\n            versions&.reverse_each do |version|\n              media_types << \"#{base_media_type}-#{version}+#{extension}\"\n              media_types << \"#{base_media_type}-#{version}\"\n            end\n            media_types << \"#{base_media_type}+#{extension}\"\n          end\n\n          media_types << base_media_type\n          media_types.concat(content_types.values.flatten)\n          media_types\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_available_media_types", "signature": "def build_available_media_types media_types = []", "start_line": 59, "end_line": 73}, "metadata": {"module": "Grape", "class_name": "Base", "class_signature": "class Base < < Grape::Middleware::Base"}, "task_id": 589}
{"function_name": "before", "file_path": "grape/lib/grape/middleware/versioner/path.rb", "focal_code": "def before\n          path_info = Grape::Router.normalize_path(env[Rack::PATH_INFO])\n          return if path_info == '/'\n\n          path_info = @prefixes.reduce(path_info) do |pi, path|\n            pi.start_with?(path) ? pi.delete_prefix(path) : pi\n          end\n\n          slash_position = path_info.index('/', 1) # omit the first one\n          return unless slash_position\n\n          potential_version = path_info[1..(slash_position - 1)]\n          return unless potential_version.match?(pattern)\n\n          version_not_found! unless potential_version_match?(potential_version)\n          env[Grape::Env::API_VERSION] = potential_version\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    module Versioner\n      # This middleware sets various version related rack environment variables\n      # based on the uri path and removes the version substring from the uri\n      # path. If the version substring does not match any potential initialized\n      # versions, a 404 error is thrown.\n      #\n      # Example: For a uri path\n      #   /v1/resource\n      #\n      # The following rack env variables are set and path is rewritten to\n      # '/resource':\n      #\n      #   env['api.version'] => 'v1'\n      #\n      class Path < Base\n        def initialize(app, **options)\n          super\n          @prefixes = [mount_path, Grape::Router.normalize_path(prefix)].select { |p| p.present? && p != '/' }.freeze\n        end\n\n        def before\n          path_info = Grape::Router.normalize_path(env[Rack::PATH_INFO])\n          return if path_info == '/'\n\n          path_info = @prefixes.reduce(path_info) do |pi, path|\n            pi.start_with?(path) ? pi.delete_prefix(path) : pi\n          end\n\n          slash_position = path_info.index('/', 1) # omit the first one\n          return unless slash_position\n\n          potential_version = path_info[1..(slash_position - 1)]\n          return unless potential_version.match?(pattern)\n\n          version_not_found! unless potential_version_match?(potential_version)\n          env[Grape::Env::API_VERSION] = potential_version\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "before", "signature": "def before path_info = Grape::Router.normalize_path(env[Rack::PATH_INFO])", "start_line": 25, "end_line": 41}, "metadata": {"module": "Grape", "class_name": "Path", "class_signature": "class Path < < Base"}, "task_id": 590}
{"function_name": "before", "file_path": "grape/lib/grape/middleware/versioner/header.rb", "focal_code": "def before\n          match_best_quality_media_type! do |media_type|\n            env.update(\n              Grape::Env::API_TYPE => media_type.type,\n              Grape::Env::API_SUBTYPE => media_type.subtype,\n              Grape::Env::API_VENDOR => media_type.vendor,\n              Grape::Env::API_VERSION => media_type.version,\n              Grape::Env::API_FORMAT => media_type.format\n            )\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    module Versioner\n      # This middleware sets various version related rack environment variables\n      # based on the HTTP Accept header with the pattern:\n      # application/vnd.:vendor-:version+:format\n      #\n      # Example: For request header\n      #    Accept: application/vnd.mycompany.a-cool-resource-v1+json\n      #\n      # The following rack env variables are set:\n      #\n      #    env['api.type']    => 'application'\n      #    env['api.subtype'] => 'vnd.mycompany.a-cool-resource-v1+json'\n      #    env['api.vendor]   => 'mycompany.a-cool-resource'\n      #    env['api.version]  => 'v1'\n      #    env['api.format]   => 'json'\n      #\n      # If version does not match this route, then a 406 is raised with\n      # X-Cascade header to alert Grape::Router to attempt the next matched\n      # route.\n      class Header < Base\n        def before\n          match_best_quality_media_type! do |media_type|\n            env.update(\n              Grape::Env::API_TYPE => media_type.type,\n              Grape::Env::API_SUBTYPE => media_type.subtype,\n              Grape::Env::API_VENDOR => media_type.vendor,\n              Grape::Env::API_VERSION => media_type.version,\n              Grape::Env::API_FORMAT => media_type.format\n            )\n          end\n        end\n\n        private\n\n        def match_best_quality_media_type!\n          return unless vendor\n\n          strict_header_checks!\n          media_type = Grape::Util::MediaType.best_quality(accept_header, available_media_types)\n          if media_type\n            yield media_type\n          else\n            fail!\n          end\n        end\n\n        def accept_header\n          env['HTTP_ACCEPT']\n        end\n\n        def strict_header_checks!\n          return unless strict\n\n          accept_header_check!\n          version_and_vendor_check!\n        end\n\n        def accept_header_check!\n          return if accept_header.present?\n\n          invalid_accept_header!('Accept header must be set.')\n        end\n\n        def version_and_vendor_check!\n          return if versions.blank? || version_and_vendor?\n\n          invalid_accept_header!('API vendor or version not found.')\n        end\n\n        def q_values_mime_types\n          @q_values_mime_types ||= Rack::Utils.q_values(accept_header).map(&:first)\n        end\n\n        def version_and_vendor?\n          q_values_mime_types.any? { |mime_type| Grape::Util::MediaType.match?(mime_type) }\n        end\n\n        def invalid_accept_header!(message)\n          raise Grape::Exceptions::InvalidAcceptHeader.new(message, error_headers)\n        end\n\n        def invalid_version_header!(message)\n          raise Grape::Exceptions::InvalidVersionHeader.new(message, error_headers)\n        end\n\n        def fail!\n          return if env[Grape::Env::GRAPE_ALLOWED_METHODS].present?\n\n          media_types = q_values_mime_types.map { |mime_type| Grape::Util::MediaType.parse(mime_type) }\n          vendor_not_found!(media_types) || version_not_found!(media_types)\n        end\n\n        def vendor_not_found!(media_types)\n          return unless media_types.all? { |media_type| media_type&.vendor && media_type.vendor != vendor }\n\n          invalid_accept_header!('API vendor not found.')\n        end\n\n        def version_not_found!(media_types)\n          return unless media_types.all? { |media_type| media_type&.version && versions && !versions.include?(media_type.version) }\n\n          invalid_version_header!('API version not found.')\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "before", "signature": "def before match_best_quality_media_type! do |media_type|", "start_line": 25, "end_line": 35}, "metadata": {"module": "Grape", "class_name": "Header", "class_signature": "class Header < < Base"}, "task_id": 591}
{"function_name": "match_best_quality_media_type!", "file_path": "grape/lib/grape/middleware/versioner/header.rb", "focal_code": "def match_best_quality_media_type!\n          return unless vendor\n\n          strict_header_checks!\n          media_type = Grape::Util::MediaType.best_quality(accept_header, available_media_types)\n          if media_type\n            yield media_type\n          else\n            fail!\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Middleware\n    module Versioner\n      # This middleware sets various version related rack environment variables\n      # based on the HTTP Accept header with the pattern:\n      # application/vnd.:vendor-:version+:format\n      #\n      # Example: For request header\n      #    Accept: application/vnd.mycompany.a-cool-resource-v1+json\n      #\n      # The following rack env variables are set:\n      #\n      #    env['api.type']    => 'application'\n      #    env['api.subtype'] => 'vnd.mycompany.a-cool-resource-v1+json'\n      #    env['api.vendor]   => 'mycompany.a-cool-resource'\n      #    env['api.version]  => 'v1'\n      #    env['api.format]   => 'json'\n      #\n      # If version does not match this route, then a 406 is raised with\n      # X-Cascade header to alert Grape::Router to attempt the next matched\n      # route.\n      class Header < Base\n        def before\n          match_best_quality_media_type! do |media_type|\n            env.update(\n              Grape::Env::API_TYPE => media_type.type,\n              Grape::Env::API_SUBTYPE => media_type.subtype,\n              Grape::Env::API_VENDOR => media_type.vendor,\n              Grape::Env::API_VERSION => media_type.version,\n              Grape::Env::API_FORMAT => media_type.format\n            )\n          end\n        end\n\n        private\n\n        def match_best_quality_media_type!\n          return unless vendor\n\n          strict_header_checks!\n          media_type = Grape::Util::MediaType.best_quality(accept_header, available_media_types)\n          if media_type\n            yield media_type\n          else\n            fail!\n          end\n        end\n\n        def accept_header\n          env['HTTP_ACCEPT']\n        end\n\n        def strict_header_checks!\n          return unless strict\n\n          accept_header_check!\n          version_and_vendor_check!\n        end\n\n        def accept_header_check!\n          return if accept_header.present?\n\n          invalid_accept_header!('Accept header must be set.')\n        end\n\n        def version_and_vendor_check!\n          return if versions.blank? || version_and_vendor?\n\n          invalid_accept_header!('API vendor or version not found.')\n        end\n\n        def q_values_mime_types\n          @q_values_mime_types ||= Rack::Utils.q_values(accept_header).map(&:first)\n        end\n\n        def version_and_vendor?\n          q_values_mime_types.any? { |mime_type| Grape::Util::MediaType.match?(mime_type) }\n        end\n\n        def invalid_accept_header!(message)\n          raise Grape::Exceptions::InvalidAcceptHeader.new(message, error_headers)\n        end\n\n        def invalid_version_header!(message)\n          raise Grape::Exceptions::InvalidVersionHeader.new(message, error_headers)\n        end\n\n        def fail!\n          return if env[Grape::Env::GRAPE_ALLOWED_METHODS].present?\n\n          media_types = q_values_mime_types.map { |mime_type| Grape::Util::MediaType.parse(mime_type) }\n          vendor_not_found!(media_types) || version_not_found!(media_types)\n        end\n\n        def vendor_not_found!(media_types)\n          return unless media_types.all? { |media_type| media_type&.vendor && media_type.vendor != vendor }\n\n          invalid_accept_header!('API vendor not found.')\n        end\n\n        def version_not_found!(media_types)\n          return unless media_types.all? { |media_type| media_type&.version && versions && !versions.include?(media_type.version) }\n\n          invalid_version_header!('API version not found.')\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "match_best_quality_media_type!", "signature": "def match_best_quality_media_type! return unless vendor", "start_line": 39, "end_line": 49}, "metadata": {"module": "Grape", "class_name": "Header", "class_signature": "class Header < < Base"}, "task_id": 592}
{"function_name": "[]=", "file_path": "grape/lib/grape/util/lazy/value_enumerable.rb", "focal_code": "def []=(key, value)\n          @value_hash[key] = case value\n                             when Hash\n                               ValueHash.new(value)\n                             when Array\n                               ValueArray.new(value)\n                             else\n                               Value.new(value)\n                             end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Grape\n  module Util\n    module Lazy\n      class ValueEnumerable < Value\n        def [](key)\n          if @value_hash[key].nil?\n            Value.new(nil).reached_by(access_keys, key)\n          else\n            @value_hash[key].reached_by(access_keys, key)\n          end\n        end\n\n        def fetch(access_keys)\n          fetched_keys = access_keys.dup\n          value = self[fetched_keys.shift]\n          fetched_keys.any? ? value.fetch(fetched_keys) : value\n        end\n\n        def []=(key, value)\n          @value_hash[key] = case value\n                             when Hash\n                               ValueHash.new(value)\n                             when Array\n                               ValueArray.new(value)\n                             else\n                               Value.new(value)\n                             end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "[]=", "signature": "def []", "start_line": 21, "end_line": 30}, "metadata": {"module": "Grape", "class_name": "ValueEnumerable", "class_signature": "class ValueEnumerable < < Value"}, "task_id": 593}
{"function_name": "loader", "file_path": "hanami/lib/hanami.rb", "focal_code": "def self.loader\n    @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|\n      loader.inflector.inflect \"db\" => \"DB\"\n      loader.inflector.inflect \"db_logging\" => \"DBLogging\"\n      loader.inflector.inflect \"slice_configured_db_operation\" => \"SliceConfiguredDBOperation\"\n      loader.inflector.inflect \"sql_adapter\" => \"SQLAdapter\"\n      loader.inflector.inflect \"sql_logger\" => \"SQLLogger\"\n      loader.inflector.inflect \"sql_formatter\" => \"SQLFormatter\"\n\n      gem_lib = loader.dirs.first\n      loader.ignore(\n        \"#{gem_lib}/hanami/{constants,boot,errors,extensions/router/errors,prepare,rake_tasks,setup}.rb\",\n        # Ignore conditionally-loaded classes dependent on gems that may not be included in the\n        # user's Gemfile\n        \"#{gem_lib}/hanami/config/{assets,router,views}.rb\",\n        \"#{gem_lib}/hanami/slice/router.rb\",\n        \"#{gem_lib}/hanami/slice/routing/resolver.rb\",\n        \"#{gem_lib}/hanami/slice/routing/middleware/stack.rb\",\n        \"#{gem_lib}/hanami/extensions/**/*\"\n      )\n\n      unless Hanami.bundled?(\"hanami-router\")\n        loader.ignore(\"#{gem_lib}/hanami/routes.rb\")\n      end\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire \"pathname\"\nrequire \"zeitwerk\"\nrequire_relative \"hanami/constants\"\n\n# A complete web framework for Ruby\n#\n# @since 0.1.0\n#\n# @see http://hanamirb.org\nmodule Hanami\n  @_mutex = Mutex.new\n  @_bundled = {}\n\n  # @api private\n  # @since 2.0.0\n  def self.loader\n    @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|\n      loader.inflector.inflect \"db\" => \"DB\"\n      loader.inflector.inflect \"db_logging\" => \"DBLogging\"\n      loader.inflector.inflect \"slice_configured_db_operation\" => \"SliceConfiguredDBOperation\"\n      loader.inflector.inflect \"sql_adapter\" => \"SQLAdapter\"\n      loader.inflector.inflect \"sql_logger\" => \"SQLLogger\"\n      loader.inflector.inflect \"sql_formatter\" => \"SQLFormatter\"\n\n      gem_lib = loader.dirs.first\n      loader.ignore(\n        \"#{gem_lib}/hanami/{constants,boot,errors,extensions/router/errors,prepare,rake_tasks,setup}.rb\",\n        # Ignore conditionally-loaded classes dependent on gems that may not be included in the\n        # user's Gemfile\n        \"#{gem_lib}/hanami/config/{assets,router,views}.rb\",\n        \"#{gem_lib}/hanami/slice/router.rb\",\n        \"#{gem_lib}/hanami/slice/routing/resolver.rb\",\n        \"#{gem_lib}/hanami/slice/routing/middleware/stack.rb\",\n        \"#{gem_lib}/hanami/extensions/**/*\"\n      )\n\n      unless Hanami.bundled?(\"hanami-router\")\n        loader.ignore(\"#{gem_lib}/hanami/routes.rb\")\n      end\n    end\n  end\n\n  # Finds and loads the Hanami app file (`config/app.rb`).\n  #\n  # Raises an exception if the app file cannot be found.\n  #\n  # @return [app] the loaded app class\n  #\n  # @api public\n  # @since 2.0.0\n  def self.setup(raise_exception: true)\n    return app if app?\n\n    app_path = self.app_path\n\n    if app_path\n      prepare_load_path\n      require(app_path.to_s)\n      app\n    elsif raise_exception\n      raise(\n        AppLoadError,\n        \"Could not locate your Hanami app file.\\n\\n\" \\\n        \"Your app file should be at `config/app.rb` in your project's root directory.\"\n      )\n    end\n  end\n\n  # Prepare the load path as early as possible (based on the default root inferred from the location\n  # of `config/app.rb`), so `require` can work at the top of `config/app.rb`. This may be useful\n  # when external classes are needed for configuring certain aspects of the app.\n  #\n  # @api private\n  # @since 2.0.0\n  private_class_method def self.prepare_load_path\n    lib_path = app_path&.join(\"..\", \"..\", LIB_DIR)\n\n    if lib_path&.directory?\n      path = lib_path.realpath.to_s\n      $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n    end\n\n    lib_path\n  end\n\n  # Returns the Hamami app class.\n  #\n  # To ensure your Hanami app is loaded, run {.setup} (or `require \"hanami/setup\"`) first.\n  #\n  # @return [Hanami::App] the app class\n  #\n  # @raise [AppLoadError] if the app has not been loaded\n  #\n  # @see .setup\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app\n    @_mutex.synchronize do\n      unless defined?(@_app)\n        raise AppLoadError,\n              \"Hanami.app is not yet configured. \" \\\n              \"You may need to `require \\\"hanami/setup\\\"` to load your config/app.rb file.\"\n      end\n\n      @_app\n    end\n  end\n\n  # Returns true if the Hanami app class has been loaded.\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app?\n    instance_variable_defined?(:@_app)\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.app=(klass)\n    @_mutex.synchronize do\n      if instance_variable_defined?(:@_app)\n        raise AppLoadError, \"Hanami.app is already configured.\"\n      end\n\n      @_app = klass unless klass.name.nil?\n    end\n  end\n\n  # Finds and returns the absolute path for the Hanami app file (`config/app.rb`).\n  #\n  # Searches within the given directory, then searches upwards through parent directories until the\n  # app file can be found.\n  #\n  # @param dir [String, Pathname] The directory from which to start searching. Defaults to the\n  #   current directory.\n  #\n  # @return [Pathname, nil] the app file path, or nil if not found.\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app_path(dir = Dir.pwd)\n    dir = Pathname(dir).expand_path\n    path = dir.join(APP_PATH)\n\n    if path.file?\n      path\n    elsif !dir.root?\n      app_path(dir.parent)\n    end\n  end\n\n  # Returns the Hanami app environment as determined from the environment.\n  #\n  # Checks the following environment variables in order:\n  #\n  # - `HANAMI_ENV`\n  # - `APP_ENV`\n  # - `RACK_ENV`\n  #\n  # Defaults to `:development` if no environment variable is set.\n  #\n  # @example\n  #   Hanami.env # => :development\n  #\n  # @return [Symbol] the environment name\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env(e: ENV)\n    (e[\"HANAMI_ENV\"] || e[\"APP_ENV\"] || e[\"RACK_ENV\"] || :development).to_sym\n  end\n\n  # Returns true if {.env} matches any of the given names\n  #\n  # @example\n  #   Hanami.env # => :development\n  #   Hanami.env?(:development, :test) # => true\n  #\n  # @param names [Array<Symbol>] the environment names to check\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env?(*names)\n    names.map(&:to_sym).include?(env)\n  end\n\n  # Returns the app's logger.\n  #\n  # Direct global access to the logger via this method is not recommended. Instead, consider\n  # accessing the logger via the app or slice container, in most cases as an dependency using the\n  # `Deps` mixin.\n  #\n  # @example\n  #   # app/my_component.rb\n  #\n  #   module MyApp\n  #     class MyComponent\n  #       include Deps[\"logger\"]\n  #\n  #       def some_method\n  #         logger.info(\"hello\")\n  #       end\n  #     end\n  #   end\n  #\n  # @return [Dry::Logger::Dispatcher]\n  #\n  # @api public\n  # @since 1.0.0\n  def self.logger\n    app[:logger]\n  end\n\n  # Prepares the Hanami app.\n  #\n  # @see App::ClassMethods#prepare\n  #\n  # @api public\n  # @since 2.0.0\n  def self.prepare\n    app.prepare\n  end\n\n  # Boots the Hanami app.\n  #\n  # @see App::ClassMethods#boot\n  #\n  # @api public\n  # @since 2.0.0\n  def self.boot\n    app.boot\n  end\n\n  # Shuts down the Hanami app.\n  #\n  # @see App::ClassMethods#shutdown\n  #\n  # @api public\n  # @since 2.0.0\n  def self.shutdown\n    app.shutdown\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.bundled?(gem_name)\n    @_mutex.synchronize do\n      @_bundled[gem_name] ||= begin\n        gem(gem_name)\n      rescue Gem::LoadError\n        false\n      end\n    end\n  end\n\n  # Returns an array of bundler group names to be eagerly loaded by hanami-cli and other CLI\n  # extensions.\n  #\n  # @api private\n  # @since 2.0.0\n  def self.bundler_groups\n    [:plugins]\n  end\n\n  loader.setup\n\n  require_relative \"hanami/errors\"\n  require_relative \"hanami/extensions\"\nend\n", "language": "ruby", "function_component": {"name": "loader", "signature": "def self.loader @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|", "start_line": 18, "end_line": 43}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 594}
{"function_name": "setup", "file_path": "hanami/lib/hanami.rb", "focal_code": "def self.setup(raise_exception: true)\n    return app if app?\n\n    app_path = self.app_path\n\n    if app_path\n      prepare_load_path\n      require(app_path.to_s)\n      app\n    elsif raise_exception\n      raise(\n        AppLoadError,\n        \"Could not locate your Hanami app file.\\n\\n\" \\\n        \"Your app file should be at `config/app.rb` in your project's root directory.\"\n      )\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire \"pathname\"\nrequire \"zeitwerk\"\nrequire_relative \"hanami/constants\"\n\n# A complete web framework for Ruby\n#\n# @since 0.1.0\n#\n# @see http://hanamirb.org\nmodule Hanami\n  @_mutex = Mutex.new\n  @_bundled = {}\n\n  # @api private\n  # @since 2.0.0\n  def self.loader\n    @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|\n      loader.inflector.inflect \"db\" => \"DB\"\n      loader.inflector.inflect \"db_logging\" => \"DBLogging\"\n      loader.inflector.inflect \"slice_configured_db_operation\" => \"SliceConfiguredDBOperation\"\n      loader.inflector.inflect \"sql_adapter\" => \"SQLAdapter\"\n      loader.inflector.inflect \"sql_logger\" => \"SQLLogger\"\n      loader.inflector.inflect \"sql_formatter\" => \"SQLFormatter\"\n\n      gem_lib = loader.dirs.first\n      loader.ignore(\n        \"#{gem_lib}/hanami/{constants,boot,errors,extensions/router/errors,prepare,rake_tasks,setup}.rb\",\n        # Ignore conditionally-loaded classes dependent on gems that may not be included in the\n        # user's Gemfile\n        \"#{gem_lib}/hanami/config/{assets,router,views}.rb\",\n        \"#{gem_lib}/hanami/slice/router.rb\",\n        \"#{gem_lib}/hanami/slice/routing/resolver.rb\",\n        \"#{gem_lib}/hanami/slice/routing/middleware/stack.rb\",\n        \"#{gem_lib}/hanami/extensions/**/*\"\n      )\n\n      unless Hanami.bundled?(\"hanami-router\")\n        loader.ignore(\"#{gem_lib}/hanami/routes.rb\")\n      end\n    end\n  end\n\n  # Finds and loads the Hanami app file (`config/app.rb`).\n  #\n  # Raises an exception if the app file cannot be found.\n  #\n  # @return [app] the loaded app class\n  #\n  # @api public\n  # @since 2.0.0\n  def self.setup(raise_exception: true)\n    return app if app?\n\n    app_path = self.app_path\n\n    if app_path\n      prepare_load_path\n      require(app_path.to_s)\n      app\n    elsif raise_exception\n      raise(\n        AppLoadError,\n        \"Could not locate your Hanami app file.\\n\\n\" \\\n        \"Your app file should be at `config/app.rb` in your project's root directory.\"\n      )\n    end\n  end\n\n  # Prepare the load path as early as possible (based on the default root inferred from the location\n  # of `config/app.rb`), so `require` can work at the top of `config/app.rb`. This may be useful\n  # when external classes are needed for configuring certain aspects of the app.\n  #\n  # @api private\n  # @since 2.0.0\n  private_class_method def self.prepare_load_path\n    lib_path = app_path&.join(\"..\", \"..\", LIB_DIR)\n\n    if lib_path&.directory?\n      path = lib_path.realpath.to_s\n      $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n    end\n\n    lib_path\n  end\n\n  # Returns the Hamami app class.\n  #\n  # To ensure your Hanami app is loaded, run {.setup} (or `require \"hanami/setup\"`) first.\n  #\n  # @return [Hanami::App] the app class\n  #\n  # @raise [AppLoadError] if the app has not been loaded\n  #\n  # @see .setup\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app\n    @_mutex.synchronize do\n      unless defined?(@_app)\n        raise AppLoadError,\n              \"Hanami.app is not yet configured. \" \\\n              \"You may need to `require \\\"hanami/setup\\\"` to load your config/app.rb file.\"\n      end\n\n      @_app\n    end\n  end\n\n  # Returns true if the Hanami app class has been loaded.\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app?\n    instance_variable_defined?(:@_app)\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.app=(klass)\n    @_mutex.synchronize do\n      if instance_variable_defined?(:@_app)\n        raise AppLoadError, \"Hanami.app is already configured.\"\n      end\n\n      @_app = klass unless klass.name.nil?\n    end\n  end\n\n  # Finds and returns the absolute path for the Hanami app file (`config/app.rb`).\n  #\n  # Searches within the given directory, then searches upwards through parent directories until the\n  # app file can be found.\n  #\n  # @param dir [String, Pathname] The directory from which to start searching. Defaults to the\n  #   current directory.\n  #\n  # @return [Pathname, nil] the app file path, or nil if not found.\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app_path(dir = Dir.pwd)\n    dir = Pathname(dir).expand_path\n    path = dir.join(APP_PATH)\n\n    if path.file?\n      path\n    elsif !dir.root?\n      app_path(dir.parent)\n    end\n  end\n\n  # Returns the Hanami app environment as determined from the environment.\n  #\n  # Checks the following environment variables in order:\n  #\n  # - `HANAMI_ENV`\n  # - `APP_ENV`\n  # - `RACK_ENV`\n  #\n  # Defaults to `:development` if no environment variable is set.\n  #\n  # @example\n  #   Hanami.env # => :development\n  #\n  # @return [Symbol] the environment name\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env(e: ENV)\n    (e[\"HANAMI_ENV\"] || e[\"APP_ENV\"] || e[\"RACK_ENV\"] || :development).to_sym\n  end\n\n  # Returns true if {.env} matches any of the given names\n  #\n  # @example\n  #   Hanami.env # => :development\n  #   Hanami.env?(:development, :test) # => true\n  #\n  # @param names [Array<Symbol>] the environment names to check\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env?(*names)\n    names.map(&:to_sym).include?(env)\n  end\n\n  # Returns the app's logger.\n  #\n  # Direct global access to the logger via this method is not recommended. Instead, consider\n  # accessing the logger via the app or slice container, in most cases as an dependency using the\n  # `Deps` mixin.\n  #\n  # @example\n  #   # app/my_component.rb\n  #\n  #   module MyApp\n  #     class MyComponent\n  #       include Deps[\"logger\"]\n  #\n  #       def some_method\n  #         logger.info(\"hello\")\n  #       end\n  #     end\n  #   end\n  #\n  # @return [Dry::Logger::Dispatcher]\n  #\n  # @api public\n  # @since 1.0.0\n  def self.logger\n    app[:logger]\n  end\n\n  # Prepares the Hanami app.\n  #\n  # @see App::ClassMethods#prepare\n  #\n  # @api public\n  # @since 2.0.0\n  def self.prepare\n    app.prepare\n  end\n\n  # Boots the Hanami app.\n  #\n  # @see App::ClassMethods#boot\n  #\n  # @api public\n  # @since 2.0.0\n  def self.boot\n    app.boot\n  end\n\n  # Shuts down the Hanami app.\n  #\n  # @see App::ClassMethods#shutdown\n  #\n  # @api public\n  # @since 2.0.0\n  def self.shutdown\n    app.shutdown\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.bundled?(gem_name)\n    @_mutex.synchronize do\n      @_bundled[gem_name] ||= begin\n        gem(gem_name)\n      rescue Gem::LoadError\n        false\n      end\n    end\n  end\n\n  # Returns an array of bundler group names to be eagerly loaded by hanami-cli and other CLI\n  # extensions.\n  #\n  # @api private\n  # @since 2.0.0\n  def self.bundler_groups\n    [:plugins]\n  end\n\n  loader.setup\n\n  require_relative \"hanami/errors\"\n  require_relative \"hanami/extensions\"\nend\n", "language": "ruby", "function_component": {"name": "setup", "signature": "def self.setup(raise_exception: true)", "start_line": 53, "end_line": 69}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 595}
{"function_name": "app", "file_path": "hanami/lib/hanami.rb", "focal_code": "def self.app\n    @_mutex.synchronize do\n      unless defined?(@_app)\n        raise AppLoadError,\n              \"Hanami.app is not yet configured. \" \\\n              \"You may need to `require \\\"hanami/setup\\\"` to load your config/app.rb file.\"\n      end\n\n      @_app\n    end\n  end", "file_content": "# frozen_string_literal: true\n\nrequire \"pathname\"\nrequire \"zeitwerk\"\nrequire_relative \"hanami/constants\"\n\n# A complete web framework for Ruby\n#\n# @since 0.1.0\n#\n# @see http://hanamirb.org\nmodule Hanami\n  @_mutex = Mutex.new\n  @_bundled = {}\n\n  # @api private\n  # @since 2.0.0\n  def self.loader\n    @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|\n      loader.inflector.inflect \"db\" => \"DB\"\n      loader.inflector.inflect \"db_logging\" => \"DBLogging\"\n      loader.inflector.inflect \"slice_configured_db_operation\" => \"SliceConfiguredDBOperation\"\n      loader.inflector.inflect \"sql_adapter\" => \"SQLAdapter\"\n      loader.inflector.inflect \"sql_logger\" => \"SQLLogger\"\n      loader.inflector.inflect \"sql_formatter\" => \"SQLFormatter\"\n\n      gem_lib = loader.dirs.first\n      loader.ignore(\n        \"#{gem_lib}/hanami/{constants,boot,errors,extensions/router/errors,prepare,rake_tasks,setup}.rb\",\n        # Ignore conditionally-loaded classes dependent on gems that may not be included in the\n        # user's Gemfile\n        \"#{gem_lib}/hanami/config/{assets,router,views}.rb\",\n        \"#{gem_lib}/hanami/slice/router.rb\",\n        \"#{gem_lib}/hanami/slice/routing/resolver.rb\",\n        \"#{gem_lib}/hanami/slice/routing/middleware/stack.rb\",\n        \"#{gem_lib}/hanami/extensions/**/*\"\n      )\n\n      unless Hanami.bundled?(\"hanami-router\")\n        loader.ignore(\"#{gem_lib}/hanami/routes.rb\")\n      end\n    end\n  end\n\n  # Finds and loads the Hanami app file (`config/app.rb`).\n  #\n  # Raises an exception if the app file cannot be found.\n  #\n  # @return [app] the loaded app class\n  #\n  # @api public\n  # @since 2.0.0\n  def self.setup(raise_exception: true)\n    return app if app?\n\n    app_path = self.app_path\n\n    if app_path\n      prepare_load_path\n      require(app_path.to_s)\n      app\n    elsif raise_exception\n      raise(\n        AppLoadError,\n        \"Could not locate your Hanami app file.\\n\\n\" \\\n        \"Your app file should be at `config/app.rb` in your project's root directory.\"\n      )\n    end\n  end\n\n  # Prepare the load path as early as possible (based on the default root inferred from the location\n  # of `config/app.rb`), so `require` can work at the top of `config/app.rb`. This may be useful\n  # when external classes are needed for configuring certain aspects of the app.\n  #\n  # @api private\n  # @since 2.0.0\n  private_class_method def self.prepare_load_path\n    lib_path = app_path&.join(\"..\", \"..\", LIB_DIR)\n\n    if lib_path&.directory?\n      path = lib_path.realpath.to_s\n      $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n    end\n\n    lib_path\n  end\n\n  # Returns the Hamami app class.\n  #\n  # To ensure your Hanami app is loaded, run {.setup} (or `require \"hanami/setup\"`) first.\n  #\n  # @return [Hanami::App] the app class\n  #\n  # @raise [AppLoadError] if the app has not been loaded\n  #\n  # @see .setup\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app\n    @_mutex.synchronize do\n      unless defined?(@_app)\n        raise AppLoadError,\n              \"Hanami.app is not yet configured. \" \\\n              \"You may need to `require \\\"hanami/setup\\\"` to load your config/app.rb file.\"\n      end\n\n      @_app\n    end\n  end\n\n  # Returns true if the Hanami app class has been loaded.\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app?\n    instance_variable_defined?(:@_app)\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.app=(klass)\n    @_mutex.synchronize do\n      if instance_variable_defined?(:@_app)\n        raise AppLoadError, \"Hanami.app is already configured.\"\n      end\n\n      @_app = klass unless klass.name.nil?\n    end\n  end\n\n  # Finds and returns the absolute path for the Hanami app file (`config/app.rb`).\n  #\n  # Searches within the given directory, then searches upwards through parent directories until the\n  # app file can be found.\n  #\n  # @param dir [String, Pathname] The directory from which to start searching. Defaults to the\n  #   current directory.\n  #\n  # @return [Pathname, nil] the app file path, or nil if not found.\n  #\n  # @api public\n  # @since 2.0.0\n  def self.app_path(dir = Dir.pwd)\n    dir = Pathname(dir).expand_path\n    path = dir.join(APP_PATH)\n\n    if path.file?\n      path\n    elsif !dir.root?\n      app_path(dir.parent)\n    end\n  end\n\n  # Returns the Hanami app environment as determined from the environment.\n  #\n  # Checks the following environment variables in order:\n  #\n  # - `HANAMI_ENV`\n  # - `APP_ENV`\n  # - `RACK_ENV`\n  #\n  # Defaults to `:development` if no environment variable is set.\n  #\n  # @example\n  #   Hanami.env # => :development\n  #\n  # @return [Symbol] the environment name\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env(e: ENV)\n    (e[\"HANAMI_ENV\"] || e[\"APP_ENV\"] || e[\"RACK_ENV\"] || :development).to_sym\n  end\n\n  # Returns true if {.env} matches any of the given names\n  #\n  # @example\n  #   Hanami.env # => :development\n  #   Hanami.env?(:development, :test) # => true\n  #\n  # @param names [Array<Symbol>] the environment names to check\n  #\n  # @return [Boolean]\n  #\n  # @api public\n  # @since 2.0.0\n  def self.env?(*names)\n    names.map(&:to_sym).include?(env)\n  end\n\n  # Returns the app's logger.\n  #\n  # Direct global access to the logger via this method is not recommended. Instead, consider\n  # accessing the logger via the app or slice container, in most cases as an dependency using the\n  # `Deps` mixin.\n  #\n  # @example\n  #   # app/my_component.rb\n  #\n  #   module MyApp\n  #     class MyComponent\n  #       include Deps[\"logger\"]\n  #\n  #       def some_method\n  #         logger.info(\"hello\")\n  #       end\n  #     end\n  #   end\n  #\n  # @return [Dry::Logger::Dispatcher]\n  #\n  # @api public\n  # @since 1.0.0\n  def self.logger\n    app[:logger]\n  end\n\n  # Prepares the Hanami app.\n  #\n  # @see App::ClassMethods#prepare\n  #\n  # @api public\n  # @since 2.0.0\n  def self.prepare\n    app.prepare\n  end\n\n  # Boots the Hanami app.\n  #\n  # @see App::ClassMethods#boot\n  #\n  # @api public\n  # @since 2.0.0\n  def self.boot\n    app.boot\n  end\n\n  # Shuts down the Hanami app.\n  #\n  # @see App::ClassMethods#shutdown\n  #\n  # @api public\n  # @since 2.0.0\n  def self.shutdown\n    app.shutdown\n  end\n\n  # @api private\n  # @since 2.0.0\n  def self.bundled?(gem_name)\n    @_mutex.synchronize do\n      @_bundled[gem_name] ||= begin\n        gem(gem_name)\n      rescue Gem::LoadError\n        false\n      end\n    end\n  end\n\n  # Returns an array of bundler group names to be eagerly loaded by hanami-cli and other CLI\n  # extensions.\n  #\n  # @api private\n  # @since 2.0.0\n  def self.bundler_groups\n    [:plugins]\n  end\n\n  loader.setup\n\n  require_relative \"hanami/errors\"\n  require_relative \"hanami/extensions\"\nend\n", "language": "ruby", "function_component": {"name": "app", "signature": "def self.app @_mutex.synchronize do", "start_line": 100, "end_line": 110}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 596}
{"function_name": "register", "file_path": "hanami/lib/hanami/slice_registrar.rb", "focal_code": "def register(name, slice_class = nil, &block)\n      unless name.to_s =~ VALID_SLICE_NAME_RE\n        raise ArgumentError, \"slice name #{name.inspect} must be lowercase alphanumeric text and underscores only\"\n      end\n\n      return unless filter_slice_names([name]).any?\n\n      if slices.key?(name.to_sym)\n        raise SliceLoadError, \"Slice '#{name}' is already registered\"\n      end\n\n      slice = slice_class || build_slice(name, &block)\n\n      configure_slice(name, slice)\n\n      slices[name.to_sym] = slice\n    end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\n\nmodule Hanami\n  # @api private\n  class SliceRegistrar\n    VALID_SLICE_NAME_RE = /^[a-z][a-z0-9_]*$/\n    SLICE_DELIMITER = CONTAINER_KEY_DELIMITER\n\n    attr_reader :parent, :slices\n    private :parent, :slices\n\n    def initialize(parent)\n      @parent = parent\n      @slices = {}\n    end\n\n    def register(name, slice_class = nil, &block)\n      unless name.to_s =~ VALID_SLICE_NAME_RE\n        raise ArgumentError, \"slice name #{name.inspect} must be lowercase alphanumeric text and underscores only\"\n      end\n\n      return unless filter_slice_names([name]).any?\n\n      if slices.key?(name.to_sym)\n        raise SliceLoadError, \"Slice '#{name}' is already registered\"\n      end\n\n      slice = slice_class || build_slice(name, &block)\n\n      configure_slice(name, slice)\n\n      slices[name.to_sym] = slice\n    end\n\n    def [](name)\n      slices.fetch(name) do\n        raise SliceLoadError, \"Slice '#{name}' not found\"\n      end\n    end\n\n    def freeze\n      slices.freeze\n      super\n    end\n\n    def load_slices\n      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")\n        .map { _1.basename(RB_EXT) }\n\n      slice_dirs = root.join(SLICES_DIR).glob(\"*\")\n        .select(&:directory?)\n        .map { _1.basename }\n\n      (slice_dirs + slice_configs).uniq.sort\n        .then { filter_slice_names(_1) }\n        .each(&method(:load_slice))\n\n      self\n    end\n\n    def each(&block)\n      slices.each_value(&block)\n    end\n\n    def keys\n      slices.keys\n    end\n\n    def to_a\n      slices.values\n    end\n\n    def with_nested\n      to_a.flat_map { |slice|\n        # Return nested slices first so that their more specific namespaces may be picked up first\n        # by SliceConfigurable#slice_for\n        slice.slices.with_nested + [slice]\n      }\n    end\n\n    private\n\n    def root\n      parent.root\n    end\n\n    def inflector\n      parent.inflector\n    end\n\n    def parent_slice_namespace\n      parent.eql?(parent.app) ? Object : parent.namespace\n    end\n\n    # Runs when a slice file has been found inside the app at `config/slices/[slice_name].rb`,\n    # or when a slice directory exists at `slices/[slice_name]`.\n    #\n    # If a slice definition file is found by `find_slice_require_path`, then `load_slice` will\n    # require the file before registering the slice class.\n    #\n    # If a slice class is not found, registering the slice will generate the slice class.\n    def load_slice(slice_name)\n      slice_require_path = find_slice_require_path(slice_name)\n      require slice_require_path if slice_require_path\n\n      slice_class =\n        begin\n          inflector.constantize(\"#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice\")\n        rescue NameError => exception\n          raise exception unless exception.name.to_s == inflector.camelize(slice_name) || exception.name.to_s == :Slice\n        end\n\n      register(slice_name, slice_class)\n    end\n\n    # Finds the path to the slice's definition file, if it exists, in the following order:\n    #\n    # 1. `config/slices/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb` (unless parent is the app)\n    # 3. `slices/[slice_name]/config/slice.rb`\n    #\n    # If the slice is nested under another slice then it will look in the following order:\n    #\n    # 1. `config/slices/[parent_slice_name]/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb`\n    # 3. `slices/[parent_slice_name]/[slice_name]/config/slice.rb`\n    def find_slice_require_path(slice_name)\n      app_slice_file_path = [slice_name]\n      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)\n      ancestors = [\n        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),\n        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),\n        root.join(SLICES_DIR, slice_name, CONFIG_DIR, \"slice\")\n      ]\n\n      ancestors\n        .uniq\n        .find { _1.sub_ext(RB_EXT).file? }\n        &.to_s\n    end\n\n    def build_slice(slice_name, &block)\n      slice_module =\n        begin\n          inflector.constantize(slice_module_name(slice_name))\n        rescue NameError\n          parent_slice_namespace.const_set(inflector.camelize(slice_name), Module.new)\n        end\n\n      slice_module.const_set(:Slice, Class.new(Hanami::Slice, &block))\n    end\n\n    def slice_module_name(slice_name)\n      inflector.camelize(\"#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}\")\n    end\n\n    def configure_slice(slice_name, slice)\n      slice.instance_variable_set(:@parent, parent)\n\n      # Slices require a root, so provide a sensible default based on the slice's parent\n      slice.config.root ||= root.join(SLICES_DIR, slice_name.to_s)\n\n      slice.config.slices = child_slice_names(slice_name, parent.config.slices)\n    end\n\n    # Returns a filtered array of slice names based on the parent's `config.slices`\n    #\n    # This works with both singular slice names (e.g. `\"admin\"`) as well as dot-delimited nested\n    # slice names (e.g. `\"admin.shop\"`).\n    #\n    # It will consider only the base names of the slices (since in this case, a parent slice must be\n    # loaded in order for its children to be loaded).\n    #\n    # @example\n    #   parent.config.slices # => [\"admin.shop\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    #\n    #   parent.config.slices # => [\"admin\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    def filter_slice_names(slice_names)\n      slice_names = slice_names.map(&:to_s)\n\n      if parent.config.slices\n        slice_names & parent.config.slices.map { base_slice_name(_1) }\n      else\n        slice_names\n      end\n    end\n\n    # Returns the base slice name from an (optionally) dot-delimited nested slice name.\n    #\n    # @example\n    #   base_slice_name(\"admin\") # => \"admin\"\n    #   base_slice_name(\"admin.users\") # => \"admin\"\n    def base_slice_name(name)\n      name.to_s.split(SLICE_DELIMITER).first\n    end\n\n    # Returns an array of slice names specific to the given child slice.\n    #\n    # @example\n    #   child_local_slice_names(\"admin\", [\"main\", \"admin.users\"]) # => [\"users\"]\n    def child_slice_names(parent_slice_name, slice_names)\n      slice_names\n        &.select { |name|\n          name.include?(SLICE_DELIMITER) && name.split(SLICE_DELIMITER)[0] == parent_slice_name.to_s\n        }\n        &.map { |name|\n          name.split(SLICE_DELIMITER)[1..].join(SLICE_DELIMITER) # which version of Ruby supports this?\n        }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "register", "signature": "def register(name, slice_class = nil, &block)", "start_line": 19, "end_line": 35}, "metadata": {"module": "Hanami", "class_name": "SliceRegistrar", "class_signature": "class SliceRegistrar"}, "task_id": 597}
{"function_name": "load_slices", "file_path": "hanami/lib/hanami/slice_registrar.rb", "focal_code": "def load_slices\n      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")\n        .map { _1.basename(RB_EXT) }\n\n      slice_dirs = root.join(SLICES_DIR).glob(\"*\")\n        .select(&:directory?)\n        .map { _1.basename }\n\n      (slice_dirs + slice_configs).uniq.sort\n        .then { filter_slice_names(_1) }\n        .each(&method(:load_slice))\n\n      self\n    end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\n\nmodule Hanami\n  # @api private\n  class SliceRegistrar\n    VALID_SLICE_NAME_RE = /^[a-z][a-z0-9_]*$/\n    SLICE_DELIMITER = CONTAINER_KEY_DELIMITER\n\n    attr_reader :parent, :slices\n    private :parent, :slices\n\n    def initialize(parent)\n      @parent = parent\n      @slices = {}\n    end\n\n    def register(name, slice_class = nil, &block)\n      unless name.to_s =~ VALID_SLICE_NAME_RE\n        raise ArgumentError, \"slice name #{name.inspect} must be lowercase alphanumeric text and underscores only\"\n      end\n\n      return unless filter_slice_names([name]).any?\n\n      if slices.key?(name.to_sym)\n        raise SliceLoadError, \"Slice '#{name}' is already registered\"\n      end\n\n      slice = slice_class || build_slice(name, &block)\n\n      configure_slice(name, slice)\n\n      slices[name.to_sym] = slice\n    end\n\n    def [](name)\n      slices.fetch(name) do\n        raise SliceLoadError, \"Slice '#{name}' not found\"\n      end\n    end\n\n    def freeze\n      slices.freeze\n      super\n    end\n\n    def load_slices\n      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")\n        .map { _1.basename(RB_EXT) }\n\n      slice_dirs = root.join(SLICES_DIR).glob(\"*\")\n        .select(&:directory?)\n        .map { _1.basename }\n\n      (slice_dirs + slice_configs).uniq.sort\n        .then { filter_slice_names(_1) }\n        .each(&method(:load_slice))\n\n      self\n    end\n\n    def each(&block)\n      slices.each_value(&block)\n    end\n\n    def keys\n      slices.keys\n    end\n\n    def to_a\n      slices.values\n    end\n\n    def with_nested\n      to_a.flat_map { |slice|\n        # Return nested slices first so that their more specific namespaces may be picked up first\n        # by SliceConfigurable#slice_for\n        slice.slices.with_nested + [slice]\n      }\n    end\n\n    private\n\n    def root\n      parent.root\n    end\n\n    def inflector\n      parent.inflector\n    end\n\n    def parent_slice_namespace\n      parent.eql?(parent.app) ? Object : parent.namespace\n    end\n\n    # Runs when a slice file has been found inside the app at `config/slices/[slice_name].rb`,\n    # or when a slice directory exists at `slices/[slice_name]`.\n    #\n    # If a slice definition file is found by `find_slice_require_path`, then `load_slice` will\n    # require the file before registering the slice class.\n    #\n    # If a slice class is not found, registering the slice will generate the slice class.\n    def load_slice(slice_name)\n      slice_require_path = find_slice_require_path(slice_name)\n      require slice_require_path if slice_require_path\n\n      slice_class =\n        begin\n          inflector.constantize(\"#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice\")\n        rescue NameError => exception\n          raise exception unless exception.name.to_s == inflector.camelize(slice_name) || exception.name.to_s == :Slice\n        end\n\n      register(slice_name, slice_class)\n    end\n\n    # Finds the path to the slice's definition file, if it exists, in the following order:\n    #\n    # 1. `config/slices/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb` (unless parent is the app)\n    # 3. `slices/[slice_name]/config/slice.rb`\n    #\n    # If the slice is nested under another slice then it will look in the following order:\n    #\n    # 1. `config/slices/[parent_slice_name]/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb`\n    # 3. `slices/[parent_slice_name]/[slice_name]/config/slice.rb`\n    def find_slice_require_path(slice_name)\n      app_slice_file_path = [slice_name]\n      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)\n      ancestors = [\n        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),\n        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),\n        root.join(SLICES_DIR, slice_name, CONFIG_DIR, \"slice\")\n      ]\n\n      ancestors\n        .uniq\n        .find { _1.sub_ext(RB_EXT).file? }\n        &.to_s\n    end\n\n    def build_slice(slice_name, &block)\n      slice_module =\n        begin\n          inflector.constantize(slice_module_name(slice_name))\n        rescue NameError\n          parent_slice_namespace.const_set(inflector.camelize(slice_name), Module.new)\n        end\n\n      slice_module.const_set(:Slice, Class.new(Hanami::Slice, &block))\n    end\n\n    def slice_module_name(slice_name)\n      inflector.camelize(\"#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}\")\n    end\n\n    def configure_slice(slice_name, slice)\n      slice.instance_variable_set(:@parent, parent)\n\n      # Slices require a root, so provide a sensible default based on the slice's parent\n      slice.config.root ||= root.join(SLICES_DIR, slice_name.to_s)\n\n      slice.config.slices = child_slice_names(slice_name, parent.config.slices)\n    end\n\n    # Returns a filtered array of slice names based on the parent's `config.slices`\n    #\n    # This works with both singular slice names (e.g. `\"admin\"`) as well as dot-delimited nested\n    # slice names (e.g. `\"admin.shop\"`).\n    #\n    # It will consider only the base names of the slices (since in this case, a parent slice must be\n    # loaded in order for its children to be loaded).\n    #\n    # @example\n    #   parent.config.slices # => [\"admin.shop\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    #\n    #   parent.config.slices # => [\"admin\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    def filter_slice_names(slice_names)\n      slice_names = slice_names.map(&:to_s)\n\n      if parent.config.slices\n        slice_names & parent.config.slices.map { base_slice_name(_1) }\n      else\n        slice_names\n      end\n    end\n\n    # Returns the base slice name from an (optionally) dot-delimited nested slice name.\n    #\n    # @example\n    #   base_slice_name(\"admin\") # => \"admin\"\n    #   base_slice_name(\"admin.users\") # => \"admin\"\n    def base_slice_name(name)\n      name.to_s.split(SLICE_DELIMITER).first\n    end\n\n    # Returns an array of slice names specific to the given child slice.\n    #\n    # @example\n    #   child_local_slice_names(\"admin\", [\"main\", \"admin.users\"]) # => [\"users\"]\n    def child_slice_names(parent_slice_name, slice_names)\n      slice_names\n        &.select { |name|\n          name.include?(SLICE_DELIMITER) && name.split(SLICE_DELIMITER)[0] == parent_slice_name.to_s\n        }\n        &.map { |name|\n          name.split(SLICE_DELIMITER)[1..].join(SLICE_DELIMITER) # which version of Ruby supports this?\n        }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_slices", "signature": "def load_slices slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")", "start_line": 48, "end_line": 61}, "metadata": {"module": "Hanami", "class_name": "SliceRegistrar", "class_signature": "class SliceRegistrar"}, "task_id": 598}
{"function_name": "load_slice", "file_path": "hanami/lib/hanami/slice_registrar.rb", "focal_code": "def load_slice(slice_name)\n      slice_require_path = find_slice_require_path(slice_name)\n      require slice_require_path if slice_require_path\n\n      slice_class =\n        begin\n          inflector.constantize(\"#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice\")\n        rescue NameError => exception\n          raise exception unless exception.name.to_s == inflector.camelize(slice_name) || exception.name.to_s == :Slice\n        end\n\n      register(slice_name, slice_class)\n    end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\n\nmodule Hanami\n  # @api private\n  class SliceRegistrar\n    VALID_SLICE_NAME_RE = /^[a-z][a-z0-9_]*$/\n    SLICE_DELIMITER = CONTAINER_KEY_DELIMITER\n\n    attr_reader :parent, :slices\n    private :parent, :slices\n\n    def initialize(parent)\n      @parent = parent\n      @slices = {}\n    end\n\n    def register(name, slice_class = nil, &block)\n      unless name.to_s =~ VALID_SLICE_NAME_RE\n        raise ArgumentError, \"slice name #{name.inspect} must be lowercase alphanumeric text and underscores only\"\n      end\n\n      return unless filter_slice_names([name]).any?\n\n      if slices.key?(name.to_sym)\n        raise SliceLoadError, \"Slice '#{name}' is already registered\"\n      end\n\n      slice = slice_class || build_slice(name, &block)\n\n      configure_slice(name, slice)\n\n      slices[name.to_sym] = slice\n    end\n\n    def [](name)\n      slices.fetch(name) do\n        raise SliceLoadError, \"Slice '#{name}' not found\"\n      end\n    end\n\n    def freeze\n      slices.freeze\n      super\n    end\n\n    def load_slices\n      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")\n        .map { _1.basename(RB_EXT) }\n\n      slice_dirs = root.join(SLICES_DIR).glob(\"*\")\n        .select(&:directory?)\n        .map { _1.basename }\n\n      (slice_dirs + slice_configs).uniq.sort\n        .then { filter_slice_names(_1) }\n        .each(&method(:load_slice))\n\n      self\n    end\n\n    def each(&block)\n      slices.each_value(&block)\n    end\n\n    def keys\n      slices.keys\n    end\n\n    def to_a\n      slices.values\n    end\n\n    def with_nested\n      to_a.flat_map { |slice|\n        # Return nested slices first so that their more specific namespaces may be picked up first\n        # by SliceConfigurable#slice_for\n        slice.slices.with_nested + [slice]\n      }\n    end\n\n    private\n\n    def root\n      parent.root\n    end\n\n    def inflector\n      parent.inflector\n    end\n\n    def parent_slice_namespace\n      parent.eql?(parent.app) ? Object : parent.namespace\n    end\n\n    # Runs when a slice file has been found inside the app at `config/slices/[slice_name].rb`,\n    # or when a slice directory exists at `slices/[slice_name]`.\n    #\n    # If a slice definition file is found by `find_slice_require_path`, then `load_slice` will\n    # require the file before registering the slice class.\n    #\n    # If a slice class is not found, registering the slice will generate the slice class.\n    def load_slice(slice_name)\n      slice_require_path = find_slice_require_path(slice_name)\n      require slice_require_path if slice_require_path\n\n      slice_class =\n        begin\n          inflector.constantize(\"#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice\")\n        rescue NameError => exception\n          raise exception unless exception.name.to_s == inflector.camelize(slice_name) || exception.name.to_s == :Slice\n        end\n\n      register(slice_name, slice_class)\n    end\n\n    # Finds the path to the slice's definition file, if it exists, in the following order:\n    #\n    # 1. `config/slices/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb` (unless parent is the app)\n    # 3. `slices/[slice_name]/config/slice.rb`\n    #\n    # If the slice is nested under another slice then it will look in the following order:\n    #\n    # 1. `config/slices/[parent_slice_name]/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb`\n    # 3. `slices/[parent_slice_name]/[slice_name]/config/slice.rb`\n    def find_slice_require_path(slice_name)\n      app_slice_file_path = [slice_name]\n      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)\n      ancestors = [\n        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),\n        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),\n        root.join(SLICES_DIR, slice_name, CONFIG_DIR, \"slice\")\n      ]\n\n      ancestors\n        .uniq\n        .find { _1.sub_ext(RB_EXT).file? }\n        &.to_s\n    end\n\n    def build_slice(slice_name, &block)\n      slice_module =\n        begin\n          inflector.constantize(slice_module_name(slice_name))\n        rescue NameError\n          parent_slice_namespace.const_set(inflector.camelize(slice_name), Module.new)\n        end\n\n      slice_module.const_set(:Slice, Class.new(Hanami::Slice, &block))\n    end\n\n    def slice_module_name(slice_name)\n      inflector.camelize(\"#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}\")\n    end\n\n    def configure_slice(slice_name, slice)\n      slice.instance_variable_set(:@parent, parent)\n\n      # Slices require a root, so provide a sensible default based on the slice's parent\n      slice.config.root ||= root.join(SLICES_DIR, slice_name.to_s)\n\n      slice.config.slices = child_slice_names(slice_name, parent.config.slices)\n    end\n\n    # Returns a filtered array of slice names based on the parent's `config.slices`\n    #\n    # This works with both singular slice names (e.g. `\"admin\"`) as well as dot-delimited nested\n    # slice names (e.g. `\"admin.shop\"`).\n    #\n    # It will consider only the base names of the slices (since in this case, a parent slice must be\n    # loaded in order for its children to be loaded).\n    #\n    # @example\n    #   parent.config.slices # => [\"admin.shop\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    #\n    #   parent.config.slices # => [\"admin\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    def filter_slice_names(slice_names)\n      slice_names = slice_names.map(&:to_s)\n\n      if parent.config.slices\n        slice_names & parent.config.slices.map { base_slice_name(_1) }\n      else\n        slice_names\n      end\n    end\n\n    # Returns the base slice name from an (optionally) dot-delimited nested slice name.\n    #\n    # @example\n    #   base_slice_name(\"admin\") # => \"admin\"\n    #   base_slice_name(\"admin.users\") # => \"admin\"\n    def base_slice_name(name)\n      name.to_s.split(SLICE_DELIMITER).first\n    end\n\n    # Returns an array of slice names specific to the given child slice.\n    #\n    # @example\n    #   child_local_slice_names(\"admin\", [\"main\", \"admin.users\"]) # => [\"users\"]\n    def child_slice_names(parent_slice_name, slice_names)\n      slice_names\n        &.select { |name|\n          name.include?(SLICE_DELIMITER) && name.split(SLICE_DELIMITER)[0] == parent_slice_name.to_s\n        }\n        &.map { |name|\n          name.split(SLICE_DELIMITER)[1..].join(SLICE_DELIMITER) # which version of Ruby supports this?\n        }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_slice", "signature": "def load_slice(slice_name)", "start_line": 104, "end_line": 116}, "metadata": {"module": "Hanami", "class_name": "SliceRegistrar", "class_signature": "class SliceRegistrar"}, "task_id": 599}
{"function_name": "find_slice_require_path", "file_path": "hanami/lib/hanami/slice_registrar.rb", "focal_code": "def find_slice_require_path(slice_name)\n      app_slice_file_path = [slice_name]\n      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)\n      ancestors = [\n        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),\n        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),\n        root.join(SLICES_DIR, slice_name, CONFIG_DIR, \"slice\")\n      ]\n\n      ancestors\n        .uniq\n        .find { _1.sub_ext(RB_EXT).file? }\n        &.to_s\n    end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\n\nmodule Hanami\n  # @api private\n  class SliceRegistrar\n    VALID_SLICE_NAME_RE = /^[a-z][a-z0-9_]*$/\n    SLICE_DELIMITER = CONTAINER_KEY_DELIMITER\n\n    attr_reader :parent, :slices\n    private :parent, :slices\n\n    def initialize(parent)\n      @parent = parent\n      @slices = {}\n    end\n\n    def register(name, slice_class = nil, &block)\n      unless name.to_s =~ VALID_SLICE_NAME_RE\n        raise ArgumentError, \"slice name #{name.inspect} must be lowercase alphanumeric text and underscores only\"\n      end\n\n      return unless filter_slice_names([name]).any?\n\n      if slices.key?(name.to_sym)\n        raise SliceLoadError, \"Slice '#{name}' is already registered\"\n      end\n\n      slice = slice_class || build_slice(name, &block)\n\n      configure_slice(name, slice)\n\n      slices[name.to_sym] = slice\n    end\n\n    def [](name)\n      slices.fetch(name) do\n        raise SliceLoadError, \"Slice '#{name}' not found\"\n      end\n    end\n\n    def freeze\n      slices.freeze\n      super\n    end\n\n    def load_slices\n      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob(\"*#{RB_EXT}\")\n        .map { _1.basename(RB_EXT) }\n\n      slice_dirs = root.join(SLICES_DIR).glob(\"*\")\n        .select(&:directory?)\n        .map { _1.basename }\n\n      (slice_dirs + slice_configs).uniq.sort\n        .then { filter_slice_names(_1) }\n        .each(&method(:load_slice))\n\n      self\n    end\n\n    def each(&block)\n      slices.each_value(&block)\n    end\n\n    def keys\n      slices.keys\n    end\n\n    def to_a\n      slices.values\n    end\n\n    def with_nested\n      to_a.flat_map { |slice|\n        # Return nested slices first so that their more specific namespaces may be picked up first\n        # by SliceConfigurable#slice_for\n        slice.slices.with_nested + [slice]\n      }\n    end\n\n    private\n\n    def root\n      parent.root\n    end\n\n    def inflector\n      parent.inflector\n    end\n\n    def parent_slice_namespace\n      parent.eql?(parent.app) ? Object : parent.namespace\n    end\n\n    # Runs when a slice file has been found inside the app at `config/slices/[slice_name].rb`,\n    # or when a slice directory exists at `slices/[slice_name]`.\n    #\n    # If a slice definition file is found by `find_slice_require_path`, then `load_slice` will\n    # require the file before registering the slice class.\n    #\n    # If a slice class is not found, registering the slice will generate the slice class.\n    def load_slice(slice_name)\n      slice_require_path = find_slice_require_path(slice_name)\n      require slice_require_path if slice_require_path\n\n      slice_class =\n        begin\n          inflector.constantize(\"#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice\")\n        rescue NameError => exception\n          raise exception unless exception.name.to_s == inflector.camelize(slice_name) || exception.name.to_s == :Slice\n        end\n\n      register(slice_name, slice_class)\n    end\n\n    # Finds the path to the slice's definition file, if it exists, in the following order:\n    #\n    # 1. `config/slices/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb` (unless parent is the app)\n    # 3. `slices/[slice_name]/config/slice.rb`\n    #\n    # If the slice is nested under another slice then it will look in the following order:\n    #\n    # 1. `config/slices/[parent_slice_name]/[slice_name].rb`\n    # 2. `slices/[parent_slice_name]/config/[slice_name].rb`\n    # 3. `slices/[parent_slice_name]/[slice_name]/config/slice.rb`\n    def find_slice_require_path(slice_name)\n      app_slice_file_path = [slice_name]\n      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)\n      ancestors = [\n        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),\n        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),\n        root.join(SLICES_DIR, slice_name, CONFIG_DIR, \"slice\")\n      ]\n\n      ancestors\n        .uniq\n        .find { _1.sub_ext(RB_EXT).file? }\n        &.to_s\n    end\n\n    def build_slice(slice_name, &block)\n      slice_module =\n        begin\n          inflector.constantize(slice_module_name(slice_name))\n        rescue NameError\n          parent_slice_namespace.const_set(inflector.camelize(slice_name), Module.new)\n        end\n\n      slice_module.const_set(:Slice, Class.new(Hanami::Slice, &block))\n    end\n\n    def slice_module_name(slice_name)\n      inflector.camelize(\"#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}\")\n    end\n\n    def configure_slice(slice_name, slice)\n      slice.instance_variable_set(:@parent, parent)\n\n      # Slices require a root, so provide a sensible default based on the slice's parent\n      slice.config.root ||= root.join(SLICES_DIR, slice_name.to_s)\n\n      slice.config.slices = child_slice_names(slice_name, parent.config.slices)\n    end\n\n    # Returns a filtered array of slice names based on the parent's `config.slices`\n    #\n    # This works with both singular slice names (e.g. `\"admin\"`) as well as dot-delimited nested\n    # slice names (e.g. `\"admin.shop\"`).\n    #\n    # It will consider only the base names of the slices (since in this case, a parent slice must be\n    # loaded in order for its children to be loaded).\n    #\n    # @example\n    #   parent.config.slices # => [\"admin.shop\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    #\n    #   parent.config.slices # => [\"admin\"]\n    #   filter_slice_names([\"admin\", \"main\"]) # => [\"admin\"]\n    def filter_slice_names(slice_names)\n      slice_names = slice_names.map(&:to_s)\n\n      if parent.config.slices\n        slice_names & parent.config.slices.map { base_slice_name(_1) }\n      else\n        slice_names\n      end\n    end\n\n    # Returns the base slice name from an (optionally) dot-delimited nested slice name.\n    #\n    # @example\n    #   base_slice_name(\"admin\") # => \"admin\"\n    #   base_slice_name(\"admin.users\") # => \"admin\"\n    def base_slice_name(name)\n      name.to_s.split(SLICE_DELIMITER).first\n    end\n\n    # Returns an array of slice names specific to the given child slice.\n    #\n    # @example\n    #   child_local_slice_names(\"admin\", [\"main\", \"admin.users\"]) # => [\"users\"]\n    def child_slice_names(parent_slice_name, slice_names)\n      slice_names\n        &.select { |name|\n          name.include?(SLICE_DELIMITER) && name.split(SLICE_DELIMITER)[0] == parent_slice_name.to_s\n        }\n        &.map { |name|\n          name.split(SLICE_DELIMITER)[1..].join(SLICE_DELIMITER) # which version of Ruby supports this?\n        }\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "find_slice_require_path", "signature": "def find_slice_require_path(slice_name)", "start_line": 129, "end_line": 142}, "metadata": {"module": "Hanami", "class_name": "SliceRegistrar", "class_signature": "class SliceRegistrar"}, "task_id": 600}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/routes.rb", "focal_code": "def initialize(action_key, slice)\n        action_path = action_key.gsub(CONTAINER_KEY_DELIMITER, PATH_DELIMITER)\n        action_constant = slice.inflector.camelize(\n          slice.inflector.underscore(slice.namespace.to_s) + PATH_DELIMITER + action_path\n        )\n        action_file_path = slice.relative_source_path.join(action_path).to_s.concat(RB_EXT)\n\n        super(<<~MSG)\n          Could not find action with key #{action_key.inspect} in #{slice}\n\n          To fix this, define the action class #{action_constant} in #{action_file_path}\n        MSG\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\nrequire_relative \"slice/router\"\n\nmodule Hanami\n  # App routes\n  #\n  # Users are expected to inherit from this class to define their app\n  # routes.\n  #\n  # @example\n  #   # config/routes.rb\n  #   # frozen_string_literal: true\n  #\n  #   require \"hanami/routes\"\n  #\n  #   module MyApp\n  #     class Routes < Hanami::Routes\n  #       root to: \"home.show\"\n  #     end\n  #   end\n  #\n  #   See {Hanami::Slice::Router} for the syntax allowed within the `define` block.\n  #\n  # @see Hanami::Slice::Router\n  # @since 2.0.0\n  class Routes\n    # Error raised when no action could be found in an app or slice container for the key given in a\n    # routes file.\n    #\n    # @api public\n    # @since 2.0.0\n    class MissingActionError < Hanami::Error\n      # @api private\n      def initialize(action_key, slice)\n        action_path = action_key.gsub(CONTAINER_KEY_DELIMITER, PATH_DELIMITER)\n        action_constant = slice.inflector.camelize(\n          slice.inflector.underscore(slice.namespace.to_s) + PATH_DELIMITER + action_path\n        )\n        action_file_path = slice.relative_source_path.join(action_path).to_s.concat(RB_EXT)\n\n        super(<<~MSG)\n          Could not find action with key #{action_key.inspect} in #{slice}\n\n          To fix this, define the action class #{action_constant} in #{action_file_path}\n        MSG\n      end\n    end\n\n    # Error raised when a given routes endpoint does not implement the `#call` interface required\n    # for Rack.\n    #\n    # @api public\n    # @since 2.0.0\n    class NotCallableEndpointError < Hanami::Error\n      # @api private\n      def initialize(endpoint)\n        super(\"#{endpoint.inspect} is not compatible with Rack. Please make sure it implements #call.\")\n      end\n    end\n\n    # Wrapper class for the (otherwise opaque) proc returned from {.routes}, adding an `#empty?`\n    # method that returns true if no routes were defined.\n    #\n    # This is useful when needing to determine behaviour based on the presence of user-defined\n    # routes, such as determining whether to show the Hanami welcome page in {Slice#load_router}.\n    #\n    # @api private\n    # @since 2.1.0\n    class RoutesProc < DelegateClass(Proc)\n      # @api private\n      # @since 2.1.0\n      def self.empty\n        new(proc {}, empty: true)\n      end\n\n      # @api private\n      # @since 2.1.0\n      def initialize(proc, empty: false)\n        @empty = empty\n        super(proc)\n      end\n\n      # @api private\n      # @since 2.1.0\n      def empty?\n        !!@empty\n      end\n    end\n\n    # @api private\n    def self.routes\n      @routes ||= build_routes\n    end\n\n    class << self\n      # @api private\n      def build_routes(definitions = self.definitions)\n        return RoutesProc.empty if definitions.empty?\n\n        routes_proc = proc do\n          definitions.each do |(name, args, kwargs, block)|\n            if block\n              public_send(name, *args, **kwargs, &block)\n            else\n              public_send(name, *args, **kwargs)\n            end\n          end\n        end\n\n        RoutesProc.new(routes_proc)\n      end\n\n      # @api private\n      def definitions\n        @definitions ||= []\n      end\n\n      private\n\n      # @api private\n      def supported_methods\n        @supported_methods ||= Slice::Router.public_instance_methods\n      end\n\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        supported_methods.include?(name) || super\n      end\n\n      # Capture all method calls that are supported by the router DSL\n      # so that it can be evaluated lazily during configuration/boot\n      # process\n      #\n      # @api private\n      def method_missing(name, *args, **kwargs, &block)\n        return super unless respond_to?(name)\n\n        definitions << [name, args, kwargs, block]\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(action_key, slice)", "start_line": 37, "end_line": 49}, "metadata": {"module": "Hanami", "class_name": "Routes", "class_signature": "class Routes"}, "task_id": 601}
{"function_name": "build_routes", "file_path": "hanami/lib/hanami/routes.rb", "focal_code": "def build_routes(definitions = self.definitions)\n        return RoutesProc.empty if definitions.empty?\n\n        routes_proc = proc do\n          definitions.each do |(name, args, kwargs, block)|\n            if block\n              public_send(name, *args, **kwargs, &block)\n            else\n              public_send(name, *args, **kwargs)\n            end\n          end\n        end\n\n        RoutesProc.new(routes_proc)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\nrequire_relative \"slice/router\"\n\nmodule Hanami\n  # App routes\n  #\n  # Users are expected to inherit from this class to define their app\n  # routes.\n  #\n  # @example\n  #   # config/routes.rb\n  #   # frozen_string_literal: true\n  #\n  #   require \"hanami/routes\"\n  #\n  #   module MyApp\n  #     class Routes < Hanami::Routes\n  #       root to: \"home.show\"\n  #     end\n  #   end\n  #\n  #   See {Hanami::Slice::Router} for the syntax allowed within the `define` block.\n  #\n  # @see Hanami::Slice::Router\n  # @since 2.0.0\n  class Routes\n    # Error raised when no action could be found in an app or slice container for the key given in a\n    # routes file.\n    #\n    # @api public\n    # @since 2.0.0\n    class MissingActionError < Hanami::Error\n      # @api private\n      def initialize(action_key, slice)\n        action_path = action_key.gsub(CONTAINER_KEY_DELIMITER, PATH_DELIMITER)\n        action_constant = slice.inflector.camelize(\n          slice.inflector.underscore(slice.namespace.to_s) + PATH_DELIMITER + action_path\n        )\n        action_file_path = slice.relative_source_path.join(action_path).to_s.concat(RB_EXT)\n\n        super(<<~MSG)\n          Could not find action with key #{action_key.inspect} in #{slice}\n\n          To fix this, define the action class #{action_constant} in #{action_file_path}\n        MSG\n      end\n    end\n\n    # Error raised when a given routes endpoint does not implement the `#call` interface required\n    # for Rack.\n    #\n    # @api public\n    # @since 2.0.0\n    class NotCallableEndpointError < Hanami::Error\n      # @api private\n      def initialize(endpoint)\n        super(\"#{endpoint.inspect} is not compatible with Rack. Please make sure it implements #call.\")\n      end\n    end\n\n    # Wrapper class for the (otherwise opaque) proc returned from {.routes}, adding an `#empty?`\n    # method that returns true if no routes were defined.\n    #\n    # This is useful when needing to determine behaviour based on the presence of user-defined\n    # routes, such as determining whether to show the Hanami welcome page in {Slice#load_router}.\n    #\n    # @api private\n    # @since 2.1.0\n    class RoutesProc < DelegateClass(Proc)\n      # @api private\n      # @since 2.1.0\n      def self.empty\n        new(proc {}, empty: true)\n      end\n\n      # @api private\n      # @since 2.1.0\n      def initialize(proc, empty: false)\n        @empty = empty\n        super(proc)\n      end\n\n      # @api private\n      # @since 2.1.0\n      def empty?\n        !!@empty\n      end\n    end\n\n    # @api private\n    def self.routes\n      @routes ||= build_routes\n    end\n\n    class << self\n      # @api private\n      def build_routes(definitions = self.definitions)\n        return RoutesProc.empty if definitions.empty?\n\n        routes_proc = proc do\n          definitions.each do |(name, args, kwargs, block)|\n            if block\n              public_send(name, *args, **kwargs, &block)\n            else\n              public_send(name, *args, **kwargs)\n            end\n          end\n        end\n\n        RoutesProc.new(routes_proc)\n      end\n\n      # @api private\n      def definitions\n        @definitions ||= []\n      end\n\n      private\n\n      # @api private\n      def supported_methods\n        @supported_methods ||= Slice::Router.public_instance_methods\n      end\n\n      # @api private\n      def respond_to_missing?(name, include_private = false)\n        supported_methods.include?(name) || super\n      end\n\n      # Capture all method calls that are supported by the router DSL\n      # so that it can be evaluated lazily during configuration/boot\n      # process\n      #\n      # @api private\n      def method_missing(name, *args, **kwargs, &block)\n        return super unless respond_to?(name)\n\n        definitions << [name, args, kwargs, block]\n        self\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_routes", "signature": "def build_routes(definitions = self.definitions)", "start_line": 100, "end_line": 114}, "metadata": {"module": "Hanami", "class_name": "Routes", "class_signature": "class Routes"}, "task_id": 602}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/settings.rb", "focal_code": "def initialize(store = EMPTY_STORE)\n      errors = config._settings.map(&:name).each_with_object({}) do |name, errs|\n        value = store.fetch(name, Undefined)\n\n        if value.eql?(Undefined)\n          # When a key is missing entirely from the store, _read_ its value from the config instead.\n          # This ensures its setting constructor runs (with a `nil` argument given) and raises any\n          # necessary errors.\n          public_send(name)\n        else\n          public_send(\"#{name}=\", value)\n        end\n      rescue => exception # rubocop:disable Style/RescueStandardError\n        errs[name] = exception\n      end\n\n      raise InvalidSettingsError, errors if errors.any?\n\n      config.finalize!\n    end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/core/constants\"\nrequire \"dry/configurable\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # Provides user-defined settings for an Hanami app or slice.\n  #\n  # Define your own settings by inheriting from this class in `config/settings.rb` within an app or\n  # slice. Your settings will be loaded from matching ENV vars (with upper-cased names) and be\n  # registered as a component as part of the Hanami app {Hanami::Slice::ClassMethods#prepare\n  # prepare} step.\n  #\n  # The settings instance is registered in your app and slice containers as a `\"settings\"`\n  # component. You can use the `Deps` mixin to inject this dependency and make settings available to\n  # your other components as required.\n  #\n  # @example\n  #   # config/settings.rb\n  #   # frozen_string_literal: true\n  #\n  #   module MyApp\n  #     class Settings < Hanami::Settings\n  #       Secret = Types::String.constrained(min_size: 20)\n  #\n  #       setting :database_url, constructor: Types::String\n  #       setting :session_secret, constructor: Secret\n  #       setting :some_flag, default: false, constructor: Types::Params::Bool\n  #     end\n  #   end\n  #\n  # Settings are defined with [dry-configurable][dry-c]'s `setting` method. You may likely want to\n  # provide `default:` and `constructor:` options for your settings.\n  #\n  # If you have [dry-types][dry-t] bundled, then a nested `Types` module will be available for type\n  # checking your setting values. Pass type objects to the setting `constructor:` options to ensure\n  # their values meet your type expectations. You can use dry-types' default type objects or define\n  # your own.\n  #\n  # When the settings are initialized, all type errors will be collected and presented together for\n  # correction. Settings are loaded early, as part of the Hanami app's\n  # {Hanami::Slice::ClassMethods#prepare prepare} step, to ensure that the app boots only when valid\n  # settings are present.\n  #\n  # Setting values are loaded from a configurable store, which defaults to\n  # {Hanami::Settings::EnvStore}, which fetches the values from equivalent upper-cased keys in\n  # `ENV`. You can configure an alternative store via {Hanami::Config#settings_store}. Setting stores\n  # must implement a `#fetch` method with the same signature as `Hash#fetch`.\n  #\n  # [dry-c]: https://dry-rb.org/gems/dry-configurable/\n  # [dry-t]: https://dry-rb.org/gems/dry-types/\n  #\n  # @see Hanami::Settings::DotenvStore\n  #\n  # @api public\n  # @since 2.0.0\n  class Settings\n    # Error raised when setting values do not meet their type expectations.\n    #\n    # Its message collects all the individual errors that can be raised for each setting.\n    #\n    # @api public\n    # @since 2.0.0\n    class InvalidSettingsError < Hanami::Error\n      # @api private\n      def initialize(errors)\n        super()\n        @errors = errors\n      end\n\n      # Returns the exception's message.\n      #\n      # @return [String]\n      #\n      # @api public\n      # @since 2.0.0\n      def to_s\n        <<~STR.strip\n          Could not initialize settings. The following settings were invalid:\n\n          #{@errors.map { |setting, message| \"#{setting}: #{message}\" }.join(\"\\n\")}\n        STR\n      end\n    end\n\n    class << self\n      # Defines a nested `Types` constant in `Settings` subclasses if dry-types is bundled.\n      #\n      # @see https://dry-rb.org/gems/dry-types\n      #\n      # @api private\n      def inherited(subclass)\n        super\n\n        if Hanami.bundled?(\"dry-types\")\n          require \"dry/types\"\n          subclass.const_set(:Types, Dry.Types())\n        end\n      end\n\n      # Loads the settings for a slice.\n      #\n      # Returns nil if no settings class is defined.\n      #\n      # @return [Settings, nil]\n      #\n      # @api private\n      def load_for_slice(slice)\n        return unless settings_defined?(slice)\n\n        require_slice_settings(slice) unless slice_settings_class?(slice)\n\n        slice_settings_class(slice).new(slice.config.settings_store)\n      end\n\n      private\n\n      # Returns true if settings are defined for the slice.\n      #\n      # Settings are considered defined if a `Settings` class is already defined in the slice\n      # namespace, or a `config/settings.rb` exists under the slice root.\n      def settings_defined?(slice)\n        slice.namespace.const_defined?(SETTINGS_CLASS_NAME) ||\n          slice.root.join(\"#{SETTINGS_PATH}#{RB_EXT}\").file?\n      end\n\n      def slice_settings_class?(slice)\n        slice.namespace.const_defined?(SETTINGS_CLASS_NAME)\n      end\n\n      def slice_settings_class(slice)\n        slice.namespace.const_get(SETTINGS_CLASS_NAME)\n      end\n\n      def require_slice_settings(slice)\n        require \"hanami/settings\"\n\n        slice_settings_require_path = File.join(slice.root, SETTINGS_PATH)\n\n        begin\n          require slice_settings_require_path\n        rescue LoadError => exception\n          raise exception unless exception.path == slice_settings_require_path\n        end\n      end\n    end\n\n    # @api private\n    Undefined = Dry::Core::Constants::Undefined\n\n    # @api private\n    EMPTY_STORE = Dry::Core::Constants::EMPTY_HASH\n\n    include Dry::Configurable\n\n    # @api private\n    def initialize(store = EMPTY_STORE)\n      errors = config._settings.map(&:name).each_with_object({}) do |name, errs|\n        value = store.fetch(name, Undefined)\n\n        if value.eql?(Undefined)\n          # When a key is missing entirely from the store, _read_ its value from the config instead.\n          # This ensures its setting constructor runs (with a `nil` argument given) and raises any\n          # necessary errors.\n          public_send(name)\n        else\n          public_send(\"#{name}=\", value)\n        end\n      rescue => exception # rubocop:disable Style/RescueStandardError\n        errs[name] = exception\n      end\n\n      raise InvalidSettingsError, errors if errors.any?\n\n      config.finalize!\n    end\n\n    # Returns a string containing a human-readable representation of the settings.\n    #\n    # This includes setting names only, not any values, to ensure that sensitive values do not\n    # inadvertently leak.\n    #\n    # Use {#inspect_values} to inspect settings with their values.\n    #\n    # @example\n    #   settings.inspect\n    #   # => #<MyApp::Settings [database_url, session_secret, some_flag]>\n    #\n    # @return [String]\n    #\n    # @see #inspect_values\n    #\n    # @api public\n    # @since 2.0.0\n    def inspect\n      \"#<#{self.class} [#{config._settings.map(&:name).join(\", \")}]>\"\n    end\n\n    # rubocop:disable Layout/LineLength\n\n    # Returns a string containing a human-readable representation of the settings and their values.\n    #\n    # @example\n    #   settings.inspect_values\n    #   # => #<MyApp::Settings database_url=\"postgres://localhost/my_db\", session_secret=\"xxx\", some_flag=true]>\n    #\n    # @return [String]\n    #\n    # @see #inspect\n    #\n    # @api public\n    # @since 2.0.0\n    def inspect_values\n      \"#<#{self.class} #{config._settings.map { |setting| \"#{setting.name}=#{config[setting.name].inspect}\" }.join(\" \")}>\"\n    end\n\n    # rubocop:enable Layout/LineLength\n\n    private\n\n    def method_missing(name, *args, &block)\n      if config.respond_to?(name)\n        config.send(name, *args, &block)\n      else\n        super\n      end\n    end\n\n    def respond_to_missing?(name, _include_all = false)\n      config.respond_to?(name) || super\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(store = EMPTY_STORE)", "start_line": 158, "end_line": 177}, "metadata": {"module": "Hanami", "class_name": "Settings", "class_signature": "class Settings"}, "task_id": 603}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/config.rb", "focal_code": "def initialize(app_name:, env:)\n      @app_name = app_name\n      @env = env\n\n      # Apply default values that are only knowable at initialize-time (vs require-time)\n      self.root = Dir.pwd\n      self.render_errors = (env == :production)\n      self.render_detailed_errors = (env == :development)\n      load_from_env\n\n      @actions = load_dependent_config(\"hanami-action\") {\n        require_relative \"config/actions\"\n        Actions.new\n      }\n\n      @assets = load_dependent_config(\"hanami-assets\") {\n        require_relative \"config/assets\"\n        Hanami::Config::Assets.new\n      }\n\n      @db = load_dependent_config(\"hanami-db\") { DB.new }\n\n      @i18n = load_dependent_config(\"i18n\") {\n        require_relative \"config/i18n\"\n        I18n.new\n      }\n\n      @logger = Config::Logger.new(env: env, app_name: app_name)\n\n      @middleware = load_dependent_config(\"hanami-router\") {\n        require_relative \"slice/routing/middleware/stack\"\n        Slice::Routing::Middleware::Stack.new\n      }\n\n      @router = load_dependent_config(\"hanami-router\") {\n        require_relative \"config/router\"\n        Router.new(self)\n      }\n\n      @views = load_dependent_config(\"hanami-view\") {\n        require_relative \"config/views\"\n        Views.new\n      }\n\n      yield self if block_given?\n    end", "file_content": "# frozen_string_literal: true\n\nrequire \"uri\"\nrequire \"pathname\"\nrequire \"dry/configurable\"\nrequire \"dry/inflector\"\n\nrequire_relative \"constants\"\nrequire_relative \"universal_logger\"\n\nmodule Hanami\n  # Hanami app config\n  #\n  # @since 2.0.0\n  class Config\n    include Dry::Configurable\n\n    # @!attribute [rw] root\n    #   Sets the root for the app or slice.\n    #\n    #   For the app, this defaults to `Dir.pwd`. For slices detected in `slices/` `config/slices/`,\n    #   this defaults to `slices/[slice_name]/`.\n    #\n    #   Accepts a string path and will return a `Pathname`.\n    #\n    #   @return [Pathname]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :root, constructor: ->(path) { Pathname(path) if path }\n\n    # @!attribute [rw] inflector\n    #   Sets the app's inflector.\n    #\n    #   This expects a `Dry::Inflector` (or compatible) inflector instance.\n    #\n    #   To configure custom inflection rules without having to assign a whole inflector, see\n    #   {#inflections}.\n    #\n    #   @return [Dry::Inflector]\n    #\n    #   @see #inflections\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :inflector, default: Dry::Inflector.new\n\n    # @!attribute [rw] settings_store\n    #   Sets the store used to retrieve {Hanami::Settings} values.\n    #\n    #   Defaults to an instance of {Hanami::Settings::EnvStore}.\n    #\n    #   @return [#fetch]\n    #\n    #   @see Hanami::Settings\n    #   @see Hanami::Settings::EnvStore#fetch\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :settings_store, default: Hanami::Settings::EnvStore.new\n\n    # @!attribute [rw] slices\n    #   Sets the slices to load when the app is preared or booted.\n    #\n    #   Defaults to `nil`, which will load all slices. Set this to an array of slice names to load\n    #   only those slices.\n    #\n    #   This attribute is also populated from the `HANAMI_SLICES` environment variable.\n    #\n    #   @example\n    #     config.slices = [\"admin\", \"search\"]\n    #\n    #   @example\n    #     ENV[\"HANAMI_SLICES\"] # => \"admin,search\"\n    #     config.slices # => [\"admin\", \"search\"]\n    #\n    #   @return [Array<String>, nil]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :slices\n\n    # @!attribute [rw] shared_app_component_keys\n    #   Sets the keys for the components to be imported from the app into all other slices.\n    #\n    #   You should append items to this array, since the default shared components are essential for\n    #   slices to operate within the app.\n    #\n    #   @example\n    #     config.shared_app_component_keys += [\"shared_component_a\", \"shared_component_b\"]\n    #\n    #   @return [Array<String>]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :shared_app_component_keys, default: %w[\n      inflector\n      logger\n      notifications\n      rack.monitor\n      routes\n      settings\n    ]\n\n    # @!attribute [rw] no_auto_register_paths\n    #   Sets the paths to skip from container auto-registration.\n    #\n    #   Paths are relative to `/app` or a slice root.\n    #\n    #   Defaults to `[\"db\", \"entities\", \"relations\", \"structs\"]`.\n    #\n    #   @return [Array<String>] array of relative paths\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :no_auto_register_paths, default: [\n      \"db\",\n      \"entities\",\n      \"relations\",\n      \"structs\"\n    ]\n\n    # @!attribute [rw] base_url\n    #   Sets the base URL for app's web server.\n    #\n    #   This is passed to the {Slice::ClassMethods#router router} and used for generating links.\n    #\n    #   Defaults to `\"http://0.0.0.0:2300\"`. String values passed are turned into `URI` instances.\n    #\n    #   @return [URI]\n    #\n    #   @see Slice::ClassMethods#router\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :base_url, default: \"http://0.0.0.0:2300\", constructor: ->(url) { URI(url) }\n\n    # @!attribute [rw] render_errors\n    #   Sets whether to catch exceptions and render error pages.\n    #\n    #   For HTML responses, these error pages are in `public/{404,500}.html`.\n    #\n    #   Defaults to `true` in production mode, `false` in all others.\n    #\n    #   @return [Boolean]\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_errors, default: false\n\n    # @!attribute [rw] render_detailed_errors\n    #   Sets whether to catch exceptions and render detailed, interactive error pages.\n    #\n    #   Requires the hanami-webconsole gem to be available.\n    #\n    #   Defaults to `false` in production mode, `true` in all others.\n    #\n    #   @return [Boolean]\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_detailed_errors, default: false\n\n    # @!attribute [rw] render_error_responses\n    #   Sets a mapping of exception class names (as strings) to symbolic response status codes used\n    #   for rendering error responses.\n    #\n    #   The response status codes will be passed to `Rack::Utils.status_code`.\n    #\n    #   In ordinary usage, you should not replace this hash. Instead, add keys and values for the\n    #   errors you want handled.\n    #\n    #   @example\n    #     config.render_error_responses\n    #     # => {\"Hanami::Router::NotFoundError\" => :not_found}\n    #\n    #     config.render_error_responses[\"MyNotFoundError\"] = :not_found\n    #\n    #   @return [Hash{String => Symbol}]\n    #\n    #   @see #render_errors\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_error_responses, default: Hash.new(:internal_server_error).merge!(\n      \"Hanami::Router::NotAllowedError\" => :not_found,\n      \"Hanami::Router::NotFoundError\" => :not_found\n    )\n\n    # @!attribute [rw] console\n    #   Returns the app's console config\n    #\n    #   @example\n    #     config.console.engine # => :irb\n    #\n    #   @return [Hanami::Config::Console]\n    #\n    #   @api public\n    #   @since 2.3.0\n    setting :console, default: Hanami::Config::Console.new\n\n    # Returns the app or slice's {Hanami::SliceName slice_name}.\n    #\n    # This is useful for default config values that depend on this name.\n    #\n    # @return [Hanami::SliceName]\n    #\n    # @api private\n    # @since 2.0.0\n    attr_reader :app_name\n\n    # Returns the app's environment.\n    #\n    # @example\n    #   config.env # => :development\n    #\n    # @return [Symbol]\n    #\n    # @see #environment\n    #\n    # @api private\n    # @since 2.0.0\n    attr_reader :env\n\n    # Returns the app's actions config, or a null config if hanami-action is not bundled.\n    #\n    # @example When hanami-action is bundled\n    #   config.actions.default_request_format # => :html\n    #\n    # @example When hanami-action is not bundled\n    #   config.actions.default_request_format # => NoMethodError\n    #\n    # @return [Hanami::Config::Actions, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :actions\n\n    # Returns the app's db config, or a null config if hanami-db is not bundled.\n    #\n    # @example When hanami-db is bundled\n    #   config.db.import_from_parent # => false\n    #\n    # @example When hanami-db is not bundle\n    #   config.db.import_from_parent # => NoMethodError\n    #\n    # @return [Hanami::Config::DB, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.2.0\n    attr_reader :db\n\n    # Returns the app's i18n config, or a null config if i18n is not bundled.\n    #\n    # @example When i18n is bundled\n    #   config.i18n.default_locale # => :en\n    #\n    # @example When i18n is not bundled\n    #   config.i18n.default_locale # => NoMethodError\n    #\n    # @return [Hanami::Config::I18n, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.2.0\n    attr_reader :i18n\n\n    # Returns the app's middleware stack, or nil if hanami-router is not bundled.\n    #\n    # Use this to configure middleware that should apply to all routes.\n    #\n    # @example\n    #   config.middleware.use :body_parser, :json\n    #   config.middleware.use MyCustomMiddleware\n    #\n    # @return [Hanami::Slice::Routing::Middleware::Stack, nil]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :middleware\n\n    # @api private\n    # @since 2.0.0\n    alias_method :middleware_stack, :middleware\n\n    # Returns the app's router config, or a null config if hanami-router is not bundled.\n    #\n    # @example When hanami-router is bundled\n    #   config.router.resolver # => Hanami::Slice::Routing::Resolver\n    #\n    # @example When hanami-router is not bundled\n    #   config.router.resolver # => NoMethodError\n    #\n    # @return [Hanami::Config::Router, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :router\n\n    # Returns the app's views config, or a null config if hanami-view is not bundled.\n    #\n    # @example When hanami-view is bundled\n    #   config.views.paths # => [...]\n    #\n    # @example When hanami-view is not bundled\n    #   config.views.paths # => NoMethodError\n    #\n    # @return [Hanami::Config::Views, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.1.0\n    attr_reader :views\n\n    # Returns the app's views config, or a null config if hanami-view is not bundled.\n    #\n    # @example When hanami-view is bundled\n    #   config.views.paths # => [...]\n    #\n    # @example When hanami-view is not bundled\n    #   config.views.paths # => NoMethodError\n    #\n    # @return [Hanami::Config::Assets, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.1.0\n    attr_reader :assets\n\n    # @api private\n    # rubocop:disable Metrics/AbcSize\n    def initialize(app_name:, env:)\n      @app_name = app_name\n      @env = env\n\n      # Apply default values that are only knowable at initialize-time (vs require-time)\n      self.root = Dir.pwd\n      self.render_errors = (env == :production)\n      self.render_detailed_errors = (env == :development)\n      load_from_env\n\n      @actions = load_dependent_config(\"hanami-action\") {\n        require_relative \"config/actions\"\n        Actions.new\n      }\n\n      @assets = load_dependent_config(\"hanami-assets\") {\n        require_relative \"config/assets\"\n        Hanami::Config::Assets.new\n      }\n\n      @db = load_dependent_config(\"hanami-db\") { DB.new }\n\n      @i18n = load_dependent_config(\"i18n\") {\n        require_relative \"config/i18n\"\n        I18n.new\n      }\n\n      @logger = Config::Logger.new(env: env, app_name: app_name)\n\n      @middleware = load_dependent_config(\"hanami-router\") {\n        require_relative \"slice/routing/middleware/stack\"\n        Slice::Routing::Middleware::Stack.new\n      }\n\n      @router = load_dependent_config(\"hanami-router\") {\n        require_relative \"config/router\"\n        Router.new(self)\n      }\n\n      @views = load_dependent_config(\"hanami-view\") {\n        require_relative \"config/views\"\n        Views.new\n      }\n\n      yield self if block_given?\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # @api private\n    def initialize_copy(source)\n      super\n\n      @app_name = app_name.dup\n\n      @actions = source.actions.dup\n      @assets = source.assets.dup\n      @db = source.db.dup\n      @i18n = source.i18n.dup\n      @logger = source.logger.dup\n      @middleware = source.middleware.dup\n      @router = source.router.dup.tap do |router|\n        router.instance_variable_set(:@base_config, self)\n      end\n      @views = source.views.dup\n    end\n    private :initialize_copy\n\n    # Finalizes the config.\n    #\n    # This is called when the app or slice is prepared. After this, no further changes to config can\n    # be made.\n    #\n    # @api private\n    def finalize!\n      # Finalize nested configs\n      assets.finalize!\n      actions.finalize!(self)\n      views.finalize!\n      logger.finalize!\n      router.finalize!\n\n      super\n    end\n\n    # Configures the app's custom inflections.\n    #\n    # You should call this one time only. Subsequent calls will override previously configured\n    # inflections.\n    #\n    # @example\n    #   config.inflections do |inflections|\n    #     inflections.acronym \"WNBA\"\n    #   end\n    #\n    # @see https://dry-rb.org/gems/dry-inflector\n    #\n    # @return [Dry::Inflector] the configured inflector\n    #\n    # @api public\n    # @since 2.0.0\n    def inflections(&block)\n      self.inflector = Dry::Inflector.new(&block)\n    end\n\n    # Disabling this to permit distinct documentation for `#logger` vs `#logger=`\n    #\n    # rubocop:disable Style/TrivialAccessors\n\n    # Returns the logger config.\n    #\n    # Use this to configure various options for the default `Dry::Logger::Dispatcher` logger instance.\n    #\n    # @example\n    #   config.logger.level = :debug\n    #\n    # @return [Hanami::Config::Logger]\n    #\n    # @see Hanami::Config::Logger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger\n      @logger\n    end\n\n    # Sets the app's logger instance.\n    #\n    # This entirely replaces the default `Dry::Logger::Dispatcher` instance that would have been\n    # configured via {#logger}.\n    #\n    # The provided logger will be wrapped with {Hanami::UniversalLogger} if it doesn't support both\n    # keyword arguments and `#tagged` logging, ensuring compatibility with Hanami's logging\n    # interface.\n    #\n    # @see #logger_instance\n    # @see Hanami::UniversalLogger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger=(logger_instance)\n      @logger_instance = Hanami::UniversalLogger[logger_instance]\n    end\n\n    # rubocop:enable Style/TrivialAccessors\n\n    # Returns the configured logger instance.\n    #\n    # Unless you've replaced the logger with {#logger=}, this returns a `Dry::Logger::Dispatcher` configured\n    # with the options configured through {#logger}.\n    #\n    # This configured logger is registered in all app and slice containers as `\"logger\"`. For\n    # typical usage, you should access the logger via this component, not directly from config.\n    #\n    # @example Accessing the logger component\n    #   Hanami.app[\"logger\"] # => #<Dry::Logger::Dispatcher>\n    #\n    # @example Injecting the logger as a dependency\n    #   module MyApp\n    #     class MyClass\n    #       include Deps[\"logger\"]\n    #\n    #       def my_method\n    #         logger.info(\"hello\")\n    #       end\n    #     end\n    #   end\n    #\n    # @return [Dry::Logger::Dispatcher]\n    #\n    # @see #logger\n    # @see Hanami::Config::Logger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger_instance\n      @logger_instance || logger.instance\n    end\n\n    private\n\n    def load_from_env\n      self.slices = ENV[\"HANAMI_SLICES\"]&.split(\",\")&.map(&:strip)\n    end\n\n    def load_dependent_config(gem_name)\n      if Hanami.bundled?(gem_name)\n        yield\n      else\n        require_relative \"config/null_config\"\n        NullConfig.new\n      end\n    end\n\n    def method_missing(name, *args, &block)\n      if config.respond_to?(name)\n        config.public_send(name, *args, &block)\n      else\n        super\n      end\n    end\n\n    def respond_to_missing?(name, _include_all = false)\n      config.respond_to?(name) || super\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(app_name:, env:)", "start_line": 329, "end_line": 374}, "metadata": {"module": "Hanami", "class_name": "Config", "class_signature": "class Config"}, "task_id": 604}
{"function_name": "initialize_copy", "file_path": "hanami/lib/hanami/config.rb", "focal_code": "def initialize_copy(source)\n      super\n\n      @app_name = app_name.dup\n\n      @actions = source.actions.dup\n      @assets = source.assets.dup\n      @db = source.db.dup\n      @i18n = source.i18n.dup\n      @logger = source.logger.dup\n      @middleware = source.middleware.dup\n      @router = source.router.dup.tap do |router|\n        router.instance_variable_set(:@base_config, self)\n      end\n      @views = source.views.dup\n    end", "file_content": "# frozen_string_literal: true\n\nrequire \"uri\"\nrequire \"pathname\"\nrequire \"dry/configurable\"\nrequire \"dry/inflector\"\n\nrequire_relative \"constants\"\nrequire_relative \"universal_logger\"\n\nmodule Hanami\n  # Hanami app config\n  #\n  # @since 2.0.0\n  class Config\n    include Dry::Configurable\n\n    # @!attribute [rw] root\n    #   Sets the root for the app or slice.\n    #\n    #   For the app, this defaults to `Dir.pwd`. For slices detected in `slices/` `config/slices/`,\n    #   this defaults to `slices/[slice_name]/`.\n    #\n    #   Accepts a string path and will return a `Pathname`.\n    #\n    #   @return [Pathname]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :root, constructor: ->(path) { Pathname(path) if path }\n\n    # @!attribute [rw] inflector\n    #   Sets the app's inflector.\n    #\n    #   This expects a `Dry::Inflector` (or compatible) inflector instance.\n    #\n    #   To configure custom inflection rules without having to assign a whole inflector, see\n    #   {#inflections}.\n    #\n    #   @return [Dry::Inflector]\n    #\n    #   @see #inflections\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :inflector, default: Dry::Inflector.new\n\n    # @!attribute [rw] settings_store\n    #   Sets the store used to retrieve {Hanami::Settings} values.\n    #\n    #   Defaults to an instance of {Hanami::Settings::EnvStore}.\n    #\n    #   @return [#fetch]\n    #\n    #   @see Hanami::Settings\n    #   @see Hanami::Settings::EnvStore#fetch\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :settings_store, default: Hanami::Settings::EnvStore.new\n\n    # @!attribute [rw] slices\n    #   Sets the slices to load when the app is preared or booted.\n    #\n    #   Defaults to `nil`, which will load all slices. Set this to an array of slice names to load\n    #   only those slices.\n    #\n    #   This attribute is also populated from the `HANAMI_SLICES` environment variable.\n    #\n    #   @example\n    #     config.slices = [\"admin\", \"search\"]\n    #\n    #   @example\n    #     ENV[\"HANAMI_SLICES\"] # => \"admin,search\"\n    #     config.slices # => [\"admin\", \"search\"]\n    #\n    #   @return [Array<String>, nil]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :slices\n\n    # @!attribute [rw] shared_app_component_keys\n    #   Sets the keys for the components to be imported from the app into all other slices.\n    #\n    #   You should append items to this array, since the default shared components are essential for\n    #   slices to operate within the app.\n    #\n    #   @example\n    #     config.shared_app_component_keys += [\"shared_component_a\", \"shared_component_b\"]\n    #\n    #   @return [Array<String>]\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :shared_app_component_keys, default: %w[\n      inflector\n      logger\n      notifications\n      rack.monitor\n      routes\n      settings\n    ]\n\n    # @!attribute [rw] no_auto_register_paths\n    #   Sets the paths to skip from container auto-registration.\n    #\n    #   Paths are relative to `/app` or a slice root.\n    #\n    #   Defaults to `[\"db\", \"entities\", \"relations\", \"structs\"]`.\n    #\n    #   @return [Array<String>] array of relative paths\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :no_auto_register_paths, default: [\n      \"db\",\n      \"entities\",\n      \"relations\",\n      \"structs\"\n    ]\n\n    # @!attribute [rw] base_url\n    #   Sets the base URL for app's web server.\n    #\n    #   This is passed to the {Slice::ClassMethods#router router} and used for generating links.\n    #\n    #   Defaults to `\"http://0.0.0.0:2300\"`. String values passed are turned into `URI` instances.\n    #\n    #   @return [URI]\n    #\n    #   @see Slice::ClassMethods#router\n    #\n    #   @api public\n    #   @since 2.0.0\n    setting :base_url, default: \"http://0.0.0.0:2300\", constructor: ->(url) { URI(url) }\n\n    # @!attribute [rw] render_errors\n    #   Sets whether to catch exceptions and render error pages.\n    #\n    #   For HTML responses, these error pages are in `public/{404,500}.html`.\n    #\n    #   Defaults to `true` in production mode, `false` in all others.\n    #\n    #   @return [Boolean]\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_errors, default: false\n\n    # @!attribute [rw] render_detailed_errors\n    #   Sets whether to catch exceptions and render detailed, interactive error pages.\n    #\n    #   Requires the hanami-webconsole gem to be available.\n    #\n    #   Defaults to `false` in production mode, `true` in all others.\n    #\n    #   @return [Boolean]\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_detailed_errors, default: false\n\n    # @!attribute [rw] render_error_responses\n    #   Sets a mapping of exception class names (as strings) to symbolic response status codes used\n    #   for rendering error responses.\n    #\n    #   The response status codes will be passed to `Rack::Utils.status_code`.\n    #\n    #   In ordinary usage, you should not replace this hash. Instead, add keys and values for the\n    #   errors you want handled.\n    #\n    #   @example\n    #     config.render_error_responses\n    #     # => {\"Hanami::Router::NotFoundError\" => :not_found}\n    #\n    #     config.render_error_responses[\"MyNotFoundError\"] = :not_found\n    #\n    #   @return [Hash{String => Symbol}]\n    #\n    #   @see #render_errors\n    #\n    #   @api public\n    #   @since 2.1.0\n    setting :render_error_responses, default: Hash.new(:internal_server_error).merge!(\n      \"Hanami::Router::NotAllowedError\" => :not_found,\n      \"Hanami::Router::NotFoundError\" => :not_found\n    )\n\n    # @!attribute [rw] console\n    #   Returns the app's console config\n    #\n    #   @example\n    #     config.console.engine # => :irb\n    #\n    #   @return [Hanami::Config::Console]\n    #\n    #   @api public\n    #   @since 2.3.0\n    setting :console, default: Hanami::Config::Console.new\n\n    # Returns the app or slice's {Hanami::SliceName slice_name}.\n    #\n    # This is useful for default config values that depend on this name.\n    #\n    # @return [Hanami::SliceName]\n    #\n    # @api private\n    # @since 2.0.0\n    attr_reader :app_name\n\n    # Returns the app's environment.\n    #\n    # @example\n    #   config.env # => :development\n    #\n    # @return [Symbol]\n    #\n    # @see #environment\n    #\n    # @api private\n    # @since 2.0.0\n    attr_reader :env\n\n    # Returns the app's actions config, or a null config if hanami-action is not bundled.\n    #\n    # @example When hanami-action is bundled\n    #   config.actions.default_request_format # => :html\n    #\n    # @example When hanami-action is not bundled\n    #   config.actions.default_request_format # => NoMethodError\n    #\n    # @return [Hanami::Config::Actions, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :actions\n\n    # Returns the app's db config, or a null config if hanami-db is not bundled.\n    #\n    # @example When hanami-db is bundled\n    #   config.db.import_from_parent # => false\n    #\n    # @example When hanami-db is not bundle\n    #   config.db.import_from_parent # => NoMethodError\n    #\n    # @return [Hanami::Config::DB, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.2.0\n    attr_reader :db\n\n    # Returns the app's i18n config, or a null config if i18n is not bundled.\n    #\n    # @example When i18n is bundled\n    #   config.i18n.default_locale # => :en\n    #\n    # @example When i18n is not bundled\n    #   config.i18n.default_locale # => NoMethodError\n    #\n    # @return [Hanami::Config::I18n, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.2.0\n    attr_reader :i18n\n\n    # Returns the app's middleware stack, or nil if hanami-router is not bundled.\n    #\n    # Use this to configure middleware that should apply to all routes.\n    #\n    # @example\n    #   config.middleware.use :body_parser, :json\n    #   config.middleware.use MyCustomMiddleware\n    #\n    # @return [Hanami::Slice::Routing::Middleware::Stack, nil]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :middleware\n\n    # @api private\n    # @since 2.0.0\n    alias_method :middleware_stack, :middleware\n\n    # Returns the app's router config, or a null config if hanami-router is not bundled.\n    #\n    # @example When hanami-router is bundled\n    #   config.router.resolver # => Hanami::Slice::Routing::Resolver\n    #\n    # @example When hanami-router is not bundled\n    #   config.router.resolver # => NoMethodError\n    #\n    # @return [Hanami::Config::Router, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.0.0\n    attr_reader :router\n\n    # Returns the app's views config, or a null config if hanami-view is not bundled.\n    #\n    # @example When hanami-view is bundled\n    #   config.views.paths # => [...]\n    #\n    # @example When hanami-view is not bundled\n    #   config.views.paths # => NoMethodError\n    #\n    # @return [Hanami::Config::Views, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.1.0\n    attr_reader :views\n\n    # Returns the app's views config, or a null config if hanami-view is not bundled.\n    #\n    # @example When hanami-view is bundled\n    #   config.views.paths # => [...]\n    #\n    # @example When hanami-view is not bundled\n    #   config.views.paths # => NoMethodError\n    #\n    # @return [Hanami::Config::Assets, Hanami::Config::NullConfig]\n    #\n    # @api public\n    # @since 2.1.0\n    attr_reader :assets\n\n    # @api private\n    # rubocop:disable Metrics/AbcSize\n    def initialize(app_name:, env:)\n      @app_name = app_name\n      @env = env\n\n      # Apply default values that are only knowable at initialize-time (vs require-time)\n      self.root = Dir.pwd\n      self.render_errors = (env == :production)\n      self.render_detailed_errors = (env == :development)\n      load_from_env\n\n      @actions = load_dependent_config(\"hanami-action\") {\n        require_relative \"config/actions\"\n        Actions.new\n      }\n\n      @assets = load_dependent_config(\"hanami-assets\") {\n        require_relative \"config/assets\"\n        Hanami::Config::Assets.new\n      }\n\n      @db = load_dependent_config(\"hanami-db\") { DB.new }\n\n      @i18n = load_dependent_config(\"i18n\") {\n        require_relative \"config/i18n\"\n        I18n.new\n      }\n\n      @logger = Config::Logger.new(env: env, app_name: app_name)\n\n      @middleware = load_dependent_config(\"hanami-router\") {\n        require_relative \"slice/routing/middleware/stack\"\n        Slice::Routing::Middleware::Stack.new\n      }\n\n      @router = load_dependent_config(\"hanami-router\") {\n        require_relative \"config/router\"\n        Router.new(self)\n      }\n\n      @views = load_dependent_config(\"hanami-view\") {\n        require_relative \"config/views\"\n        Views.new\n      }\n\n      yield self if block_given?\n    end\n    # rubocop:enable Metrics/AbcSize\n\n    # @api private\n    def initialize_copy(source)\n      super\n\n      @app_name = app_name.dup\n\n      @actions = source.actions.dup\n      @assets = source.assets.dup\n      @db = source.db.dup\n      @i18n = source.i18n.dup\n      @logger = source.logger.dup\n      @middleware = source.middleware.dup\n      @router = source.router.dup.tap do |router|\n        router.instance_variable_set(:@base_config, self)\n      end\n      @views = source.views.dup\n    end\n    private :initialize_copy\n\n    # Finalizes the config.\n    #\n    # This is called when the app or slice is prepared. After this, no further changes to config can\n    # be made.\n    #\n    # @api private\n    def finalize!\n      # Finalize nested configs\n      assets.finalize!\n      actions.finalize!(self)\n      views.finalize!\n      logger.finalize!\n      router.finalize!\n\n      super\n    end\n\n    # Configures the app's custom inflections.\n    #\n    # You should call this one time only. Subsequent calls will override previously configured\n    # inflections.\n    #\n    # @example\n    #   config.inflections do |inflections|\n    #     inflections.acronym \"WNBA\"\n    #   end\n    #\n    # @see https://dry-rb.org/gems/dry-inflector\n    #\n    # @return [Dry::Inflector] the configured inflector\n    #\n    # @api public\n    # @since 2.0.0\n    def inflections(&block)\n      self.inflector = Dry::Inflector.new(&block)\n    end\n\n    # Disabling this to permit distinct documentation for `#logger` vs `#logger=`\n    #\n    # rubocop:disable Style/TrivialAccessors\n\n    # Returns the logger config.\n    #\n    # Use this to configure various options for the default `Dry::Logger::Dispatcher` logger instance.\n    #\n    # @example\n    #   config.logger.level = :debug\n    #\n    # @return [Hanami::Config::Logger]\n    #\n    # @see Hanami::Config::Logger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger\n      @logger\n    end\n\n    # Sets the app's logger instance.\n    #\n    # This entirely replaces the default `Dry::Logger::Dispatcher` instance that would have been\n    # configured via {#logger}.\n    #\n    # The provided logger will be wrapped with {Hanami::UniversalLogger} if it doesn't support both\n    # keyword arguments and `#tagged` logging, ensuring compatibility with Hanami's logging\n    # interface.\n    #\n    # @see #logger_instance\n    # @see Hanami::UniversalLogger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger=(logger_instance)\n      @logger_instance = Hanami::UniversalLogger[logger_instance]\n    end\n\n    # rubocop:enable Style/TrivialAccessors\n\n    # Returns the configured logger instance.\n    #\n    # Unless you've replaced the logger with {#logger=}, this returns a `Dry::Logger::Dispatcher` configured\n    # with the options configured through {#logger}.\n    #\n    # This configured logger is registered in all app and slice containers as `\"logger\"`. For\n    # typical usage, you should access the logger via this component, not directly from config.\n    #\n    # @example Accessing the logger component\n    #   Hanami.app[\"logger\"] # => #<Dry::Logger::Dispatcher>\n    #\n    # @example Injecting the logger as a dependency\n    #   module MyApp\n    #     class MyClass\n    #       include Deps[\"logger\"]\n    #\n    #       def my_method\n    #         logger.info(\"hello\")\n    #       end\n    #     end\n    #   end\n    #\n    # @return [Dry::Logger::Dispatcher]\n    #\n    # @see #logger\n    # @see Hanami::Config::Logger\n    #\n    # @api public\n    # @since 2.0.0\n    def logger_instance\n      @logger_instance || logger.instance\n    end\n\n    private\n\n    def load_from_env\n      self.slices = ENV[\"HANAMI_SLICES\"]&.split(\",\")&.map(&:strip)\n    end\n\n    def load_dependent_config(gem_name)\n      if Hanami.bundled?(gem_name)\n        yield\n      else\n        require_relative \"config/null_config\"\n        NullConfig.new\n      end\n    end\n\n    def method_missing(name, *args, &block)\n      if config.respond_to?(name)\n        config.public_send(name, *args, &block)\n      else\n        super\n      end\n    end\n\n    def respond_to_missing?(name, _include_all = false)\n      config.respond_to?(name) || super\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize_copy", "signature": "def initialize_copy(source)", "start_line": 378, "end_line": 393}, "metadata": {"module": "Hanami", "class_name": "Config", "class_signature": "class Config"}, "task_id": 605}
{"function_name": "inherited", "file_path": "hanami/lib/hanami/app.rb", "focal_code": "def self.inherited(subclass)\n      super\n\n      Hanami.app = subclass\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)\n          Hanami::Env.load\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"env\"\n\nmodule Hanami\n  # The Hanami app is a singular slice tasked with managing the core components of the app and\n  # coordinating overall app boot.\n  #\n  # For smaller apps, the app may be the only slice present, whereas larger apps may consist of many\n  # slices, with the app reserved for holding a small number of shared components only.\n  #\n  # @see Slice\n  #\n  # @api public\n  # @since 2.0.0\n  class App < Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    # @since 2.0.0\n    def self.inherited(subclass)\n      super\n\n      Hanami.app = subclass\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)\n          Hanami::Env.load\n        end\n      end\n    end\n\n    # App class interface\n    module ClassMethods\n      # Returns the app's config.\n      #\n      # @return [Hanami::Config]\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :config\n\n      # Returns the app's {SliceName}.\n      #\n      # @return [Hanami::SliceName]\n      #\n      # @see Slice::ClassMethods#slice_name\n      #\n      # @api public\n      # @since 2.0.0\n      def app_name\n        slice_name\n      end\n\n      # Prepares the $LOAD_PATH based on the app's configured root, prepending the `lib/` directory\n      # if it exists. If the lib directory is already added, this will do nothing.\n      #\n      # In ordinary circumstances, you should never have to call this method: this method is called\n      # immediately upon subclassing {Hanami::App}, as a convenicence to put lib/ (under the default\n      # root of `Dir.pwd`) on the load path automatically. This is helpful if you need to require\n      # files inside the subclass body for performing certain app configuration steps.\n      #\n      # If you change your app's `config.root` and you need to require files from its `lib/`\n      # directory within your {App} subclass body, you should call {.prepare_load_path} explicitly\n      # after setting the new root.\n      #\n      # Otherwise, this method is called again as part of the app {.prepare} step, so if you've\n      # changed your app's root and do _not_ need to require files within your {App} subclass body,\n      # then you don't need to call this method.\n      #\n      # @example\n      #   module MyApp\n      #     class App < Hanami::App\n      #       config.root = Pathname(__dir__).join(\"../src\")\n      #       prepare_load_path\n      #\n      #       # You can make requires for your files here\n      #     end\n      #   end\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_load_path\n        if (lib_path = root.join(LIB_DIR)).directory?\n          path = lib_path.realpath.to_s\n          $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n        end\n\n        self\n      end\n\n      private\n\n      def prepare_all\n        prepare_load_path\n\n        # Make app-wide notifications available as early as possible\n        container.use(:notifications)\n\n        # Ensure all basic slice preparation is complete before we make adjustments below (which\n        # rely on the basic prepare steps having already run)\n        super\n\n        # Run specific prepare steps for the app slice. Note also that some standard steps have been\n        # skipped via the empty method overrides below.\n        prepare_app_component_dirs\n        prepare_app_providers\n      end\n\n      # Skip standard slice prepare steps that do not apply to the app\n      def prepare_container_component_dirs; end\n      def prepare_container_imports; end\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_app_component_dirs\n        # Component files in both `app/` and `app/lib/` define classes in the\n        # app's namespace\n\n        if root.join(APP_DIR, LIB_DIR).directory?\n          container.config.component_dirs.add(File.join(APP_DIR, LIB_DIR)) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n          end\n        end\n\n        # When auto-registering components in `app/`, ignore files in `app/lib/` (these will be\n        # auto-registered as above), as well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        if root.join(APP_DIR).directory?\n          container.config.component_dirs.add(APP_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n            dir.auto_register = -> component {\n              relative_path = component.file_path.relative_path_from(root.join(APP_DIR)).to_s\n              !relative_path.start_with?(*no_auto_register_paths)\n            }\n          end\n        end\n      end\n\n      def prepare_app_providers\n        require_relative \"providers/inflector\"\n        register_provider(:inflector, source: Hanami::Providers::Inflector)\n\n        # Allow logger to be replaced by users with a manual provider, for advanced cases\n        unless container.providers[:logger]\n          require_relative \"providers/logger\"\n          register_provider(:logger, source: Hanami::Providers::Logger)\n        end\n\n        if Hanami.bundled?(\"rack\")\n          require_relative \"providers/rack\"\n          register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          register_provider(:db_logging, source: Hanami::Providers::DBLogging)\n        end\n      end\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.app.#{slice_name.name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Autoload classes from `lib/[app_namespace]/`\n        if root.join(LIB_DIR, app_name.name).directory?\n          autoloader.push_dir(root.join(LIB_DIR, app_name.name), namespace: namespace)\n        end\n\n        autoloader.setup\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "inherited", "signature": "def self.inherited(subclass)", "start_line": 22, "end_line": 35}, "metadata": {"module": "Hanami", "class_name": "App", "class_signature": "class App < < Slice"}, "task_id": 606}
{"function_name": "prepare_app_component_dirs", "file_path": "hanami/lib/hanami/app.rb", "focal_code": "def prepare_app_component_dirs\n        # Component files in both `app/` and `app/lib/` define classes in the\n        # app's namespace\n\n        if root.join(APP_DIR, LIB_DIR).directory?\n          container.config.component_dirs.add(File.join(APP_DIR, LIB_DIR)) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n          end\n        end\n\n        # When auto-registering components in `app/`, ignore files in `app/lib/` (these will be\n        # auto-registered as above), as well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        if root.join(APP_DIR).directory?\n          container.config.component_dirs.add(APP_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n            dir.auto_register = -> component {\n              relative_path = component.file_path.relative_path_from(root.join(APP_DIR)).to_s\n              !relative_path.start_with?(*no_auto_register_paths)\n            }\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"env\"\n\nmodule Hanami\n  # The Hanami app is a singular slice tasked with managing the core components of the app and\n  # coordinating overall app boot.\n  #\n  # For smaller apps, the app may be the only slice present, whereas larger apps may consist of many\n  # slices, with the app reserved for holding a small number of shared components only.\n  #\n  # @see Slice\n  #\n  # @api public\n  # @since 2.0.0\n  class App < Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    # @since 2.0.0\n    def self.inherited(subclass)\n      super\n\n      Hanami.app = subclass\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)\n          Hanami::Env.load\n        end\n      end\n    end\n\n    # App class interface\n    module ClassMethods\n      # Returns the app's config.\n      #\n      # @return [Hanami::Config]\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :config\n\n      # Returns the app's {SliceName}.\n      #\n      # @return [Hanami::SliceName]\n      #\n      # @see Slice::ClassMethods#slice_name\n      #\n      # @api public\n      # @since 2.0.0\n      def app_name\n        slice_name\n      end\n\n      # Prepares the $LOAD_PATH based on the app's configured root, prepending the `lib/` directory\n      # if it exists. If the lib directory is already added, this will do nothing.\n      #\n      # In ordinary circumstances, you should never have to call this method: this method is called\n      # immediately upon subclassing {Hanami::App}, as a convenicence to put lib/ (under the default\n      # root of `Dir.pwd`) on the load path automatically. This is helpful if you need to require\n      # files inside the subclass body for performing certain app configuration steps.\n      #\n      # If you change your app's `config.root` and you need to require files from its `lib/`\n      # directory within your {App} subclass body, you should call {.prepare_load_path} explicitly\n      # after setting the new root.\n      #\n      # Otherwise, this method is called again as part of the app {.prepare} step, so if you've\n      # changed your app's root and do _not_ need to require files within your {App} subclass body,\n      # then you don't need to call this method.\n      #\n      # @example\n      #   module MyApp\n      #     class App < Hanami::App\n      #       config.root = Pathname(__dir__).join(\"../src\")\n      #       prepare_load_path\n      #\n      #       # You can make requires for your files here\n      #     end\n      #   end\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_load_path\n        if (lib_path = root.join(LIB_DIR)).directory?\n          path = lib_path.realpath.to_s\n          $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n        end\n\n        self\n      end\n\n      private\n\n      def prepare_all\n        prepare_load_path\n\n        # Make app-wide notifications available as early as possible\n        container.use(:notifications)\n\n        # Ensure all basic slice preparation is complete before we make adjustments below (which\n        # rely on the basic prepare steps having already run)\n        super\n\n        # Run specific prepare steps for the app slice. Note also that some standard steps have been\n        # skipped via the empty method overrides below.\n        prepare_app_component_dirs\n        prepare_app_providers\n      end\n\n      # Skip standard slice prepare steps that do not apply to the app\n      def prepare_container_component_dirs; end\n      def prepare_container_imports; end\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_app_component_dirs\n        # Component files in both `app/` and `app/lib/` define classes in the\n        # app's namespace\n\n        if root.join(APP_DIR, LIB_DIR).directory?\n          container.config.component_dirs.add(File.join(APP_DIR, LIB_DIR)) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n          end\n        end\n\n        # When auto-registering components in `app/`, ignore files in `app/lib/` (these will be\n        # auto-registered as above), as well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        if root.join(APP_DIR).directory?\n          container.config.component_dirs.add(APP_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n            dir.auto_register = -> component {\n              relative_path = component.file_path.relative_path_from(root.join(APP_DIR)).to_s\n              !relative_path.start_with?(*no_auto_register_paths)\n            }\n          end\n        end\n      end\n\n      def prepare_app_providers\n        require_relative \"providers/inflector\"\n        register_provider(:inflector, source: Hanami::Providers::Inflector)\n\n        # Allow logger to be replaced by users with a manual provider, for advanced cases\n        unless container.providers[:logger]\n          require_relative \"providers/logger\"\n          register_provider(:logger, source: Hanami::Providers::Logger)\n        end\n\n        if Hanami.bundled?(\"rack\")\n          require_relative \"providers/rack\"\n          register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          register_provider(:db_logging, source: Hanami::Providers::DBLogging)\n        end\n      end\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.app.#{slice_name.name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Autoload classes from `lib/[app_namespace]/`\n        if root.join(LIB_DIR, app_name.name).directory?\n          autoloader.push_dir(root.join(LIB_DIR, app_name.name), namespace: namespace)\n        end\n\n        autoloader.setup\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_app_component_dirs", "signature": "def prepare_app_component_dirs # Component files in both `app/` and `app/lib/` define classes in the", "start_line": 122, "end_line": 148}, "metadata": {"module": "Hanami", "class_name": "App", "class_signature": "class App < < Slice"}, "task_id": 607}
{"function_name": "prepare_app_providers", "file_path": "hanami/lib/hanami/app.rb", "focal_code": "def prepare_app_providers\n        require_relative \"providers/inflector\"\n        register_provider(:inflector, source: Hanami::Providers::Inflector)\n\n        # Allow logger to be replaced by users with a manual provider, for advanced cases\n        unless container.providers[:logger]\n          require_relative \"providers/logger\"\n          register_provider(:logger, source: Hanami::Providers::Logger)\n        end\n\n        if Hanami.bundled?(\"rack\")\n          require_relative \"providers/rack\"\n          register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          register_provider(:db_logging, source: Hanami::Providers::DBLogging)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"env\"\n\nmodule Hanami\n  # The Hanami app is a singular slice tasked with managing the core components of the app and\n  # coordinating overall app boot.\n  #\n  # For smaller apps, the app may be the only slice present, whereas larger apps may consist of many\n  # slices, with the app reserved for holding a small number of shared components only.\n  #\n  # @see Slice\n  #\n  # @api public\n  # @since 2.0.0\n  class App < Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    # @since 2.0.0\n    def self.inherited(subclass)\n      super\n\n      Hanami.app = subclass\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)\n          Hanami::Env.load\n        end\n      end\n    end\n\n    # App class interface\n    module ClassMethods\n      # Returns the app's config.\n      #\n      # @return [Hanami::Config]\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :config\n\n      # Returns the app's {SliceName}.\n      #\n      # @return [Hanami::SliceName]\n      #\n      # @see Slice::ClassMethods#slice_name\n      #\n      # @api public\n      # @since 2.0.0\n      def app_name\n        slice_name\n      end\n\n      # Prepares the $LOAD_PATH based on the app's configured root, prepending the `lib/` directory\n      # if it exists. If the lib directory is already added, this will do nothing.\n      #\n      # In ordinary circumstances, you should never have to call this method: this method is called\n      # immediately upon subclassing {Hanami::App}, as a convenicence to put lib/ (under the default\n      # root of `Dir.pwd`) on the load path automatically. This is helpful if you need to require\n      # files inside the subclass body for performing certain app configuration steps.\n      #\n      # If you change your app's `config.root` and you need to require files from its `lib/`\n      # directory within your {App} subclass body, you should call {.prepare_load_path} explicitly\n      # after setting the new root.\n      #\n      # Otherwise, this method is called again as part of the app {.prepare} step, so if you've\n      # changed your app's root and do _not_ need to require files within your {App} subclass body,\n      # then you don't need to call this method.\n      #\n      # @example\n      #   module MyApp\n      #     class App < Hanami::App\n      #       config.root = Pathname(__dir__).join(\"../src\")\n      #       prepare_load_path\n      #\n      #       # You can make requires for your files here\n      #     end\n      #   end\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_load_path\n        if (lib_path = root.join(LIB_DIR)).directory?\n          path = lib_path.realpath.to_s\n          $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)\n        end\n\n        self\n      end\n\n      private\n\n      def prepare_all\n        prepare_load_path\n\n        # Make app-wide notifications available as early as possible\n        container.use(:notifications)\n\n        # Ensure all basic slice preparation is complete before we make adjustments below (which\n        # rely on the basic prepare steps having already run)\n        super\n\n        # Run specific prepare steps for the app slice. Note also that some standard steps have been\n        # skipped via the empty method overrides below.\n        prepare_app_component_dirs\n        prepare_app_providers\n      end\n\n      # Skip standard slice prepare steps that do not apply to the app\n      def prepare_container_component_dirs; end\n      def prepare_container_imports; end\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_app_component_dirs\n        # Component files in both `app/` and `app/lib/` define classes in the\n        # app's namespace\n\n        if root.join(APP_DIR, LIB_DIR).directory?\n          container.config.component_dirs.add(File.join(APP_DIR, LIB_DIR)) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n          end\n        end\n\n        # When auto-registering components in `app/`, ignore files in `app/lib/` (these will be\n        # auto-registered as above), as well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        if root.join(APP_DIR).directory?\n          container.config.component_dirs.add(APP_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: app_name.name)\n            dir.auto_register = -> component {\n              relative_path = component.file_path.relative_path_from(root.join(APP_DIR)).to_s\n              !relative_path.start_with?(*no_auto_register_paths)\n            }\n          end\n        end\n      end\n\n      def prepare_app_providers\n        require_relative \"providers/inflector\"\n        register_provider(:inflector, source: Hanami::Providers::Inflector)\n\n        # Allow logger to be replaced by users with a manual provider, for advanced cases\n        unless container.providers[:logger]\n          require_relative \"providers/logger\"\n          register_provider(:logger, source: Hanami::Providers::Logger)\n        end\n\n        if Hanami.bundled?(\"rack\")\n          require_relative \"providers/rack\"\n          register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          register_provider(:db_logging, source: Hanami::Providers::DBLogging)\n        end\n      end\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.app.#{slice_name.name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Autoload classes from `lib/[app_namespace]/`\n        if root.join(LIB_DIR, app_name.name).directory?\n          autoloader.push_dir(root.join(LIB_DIR, app_name.name), namespace: namespace)\n        end\n\n        autoloader.setup\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_app_providers", "signature": "def prepare_app_providers require_relative \"providers/inflector\"", "start_line": 150, "end_line": 168}, "metadata": {"module": "Hanami", "class_name": "App", "class_signature": "class App < < Slice"}, "task_id": 608}
{"function_name": "extended", "file_path": "hanami/lib/hanami/slice_configurable.rb", "focal_code": "def extended(klass)\n        slice_for = method(:slice_for)\n\n        inherited_mod = Module.new do\n          define_method(:inherited) do |subclass|\n            unless Hanami.app?\n              raise ComponentLoadError, \"Class #{klass} must be defined within an Hanami app\"\n            end\n\n            super(subclass)\n\n            subclass.instance_variable_set(:@configured_for_slices, configured_for_slices.dup)\n\n            slice = slice_for.(subclass)\n            return unless slice\n\n            unless subclass.configured_for_slice?(slice)\n              subclass.configure_for_slice(slice) if subclass.respond_to?(:configure_for_slice)\n              subclass.configured_for_slices << slice\n            end\n          end\n        end\n\n        klass.singleton_class.prepend(inherited_mod)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # Calls `configure_for_slice(slice)` on the extended class whenever it is first\n  # subclassed within a module namespace corresponding to a slice.\n  #\n  # @example\n  #   class BaseClass\n  #     extend Hanami::SliceConfigurable\n  #   end\n  #\n  #   # slices/main/lib/my_class.rb\n  #   module Main\n  #     class MyClass < BaseClass\n  #       # Will be called with `Main::Slice`\n  #       def self.configure_for_slice(slice)\n  #         # ...\n  #       end\n  #     end\n  #   end\n  #\n  # @api private\n  # @since 2.0.0\n  module SliceConfigurable\n    class << self\n      def extended(klass)\n        slice_for = method(:slice_for)\n\n        inherited_mod = Module.new do\n          define_method(:inherited) do |subclass|\n            unless Hanami.app?\n              raise ComponentLoadError, \"Class #{klass} must be defined within an Hanami app\"\n            end\n\n            super(subclass)\n\n            subclass.instance_variable_set(:@configured_for_slices, configured_for_slices.dup)\n\n            slice = slice_for.(subclass)\n            return unless slice\n\n            unless subclass.configured_for_slice?(slice)\n              subclass.configure_for_slice(slice) if subclass.respond_to?(:configure_for_slice)\n              subclass.configured_for_slices << slice\n            end\n          end\n        end\n\n        klass.singleton_class.prepend(inherited_mod)\n      end\n\n      private\n\n      def slice_for(klass)\n        return unless klass.name\n\n        slices = Hanami.app.slices.with_nested + [Hanami.app]\n\n        slices.detect { |slice| klass.name.start_with?(\"#{slice.namespace}#{MODULE_DELIMITER}\") }\n      end\n    end\n\n    def configured_for_slice?(slice)\n      configured_for_slices.include?(slice)\n    end\n\n    def configured_for_slices\n      @configured_for_slices ||= []\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "extended", "signature": "def extended(klass)", "start_line": 29, "end_line": 53}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 609}
{"function_name": "inherited", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "inherited", "signature": "def self.inherited(subclass)", "start_line": 35, "end_line": 47}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 610}
{"function_name": "import", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "import", "signature": "def import(from:, **kwargs)", "start_line": 701, "end_line": 714}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 611}
{"function_name": "prepare_slice", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_slice", "signature": "def prepare_slice return self if prepared?", "start_line": 811, "end_line": 835}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 612}
{"function_name": "prepare_container_component_dirs", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_container_component_dirs", "signature": "def prepare_container_component_dirs return unless root.directory?", "start_line": 899, "end_line": 927}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 613}
{"function_name": "prepare_container_providers", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_container_providers", "signature": "def prepare_container_providers # Check here for the `routes` definition only, not `router` itself, because the", "start_line": 938, "end_line": 976}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 614}
{"function_name": "prepare_autoloader", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_autoloader", "signature": "def prepare_autoloader autoloader.tag = \"hanami.slices.#{slice_name}\"", "start_line": 979, "end_line": 997}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 615}
{"function_name": "load_routes", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_routes", "signature": "def load_routes return false unless Hanami.bundled?(\"hanami-router\")", "start_line": 1012, "end_line": 1032}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 616}
{"function_name": "load_router", "file_path": "hanami/lib/hanami/slice.rb", "focal_code": "def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"zeitwerk\"\nrequire \"dry/system\"\n\nrequire_relative \"constants\"\nrequire_relative \"errors\"\n\nmodule Hanami\n  # A slice represents any distinct area of concern within an Hanami app.\n  #\n  # For smaller apps, a slice may encompass the whole app itself (see\n  # {Hanami::App}), whereas larger apps may consist of many slices.\n  #\n  # Each slice corresponds a single module namespace and a single root directory of source\n  # files for loading as components into its container.\n  #\n  # Each slice has its own config, and may optionally have its own settings, routes, as well as\n  # other nested slices.\n  #\n  # Slices expect an Hanami app to be defined (which itself is a slice). They will initialize their\n  # config as a copy of the app's, and will also configure certain components\n  #\n  # Slices must be _prepared_ and optionally _booted_ before they can be used (see\n  # {ClassMethods.prepare} and {ClassMethods.boot}). A prepared slice will lazily load its\n  # components and nested slices (useful for minimising initial load time), whereas a\n  # booted slice will eagerly load all its components and nested slices, then freeze its\n  # container.\n  #\n  # @since 2.0.0\n  class Slice\n    @_mutex = Mutex.new\n\n    # @api private\n    def self.inherited(subclass)\n      super\n\n      subclass.extend(ClassMethods)\n\n      @_mutex.synchronize do\n        subclass.class_eval do\n          @_mutex = Mutex.new\n          @autoloader = Zeitwerk::Loader.new\n          @container = Class.new(Dry::System::Container)\n        end\n      end\n    end\n\n    module ClassMethods\n      # Returns the slice's parent.\n      #\n      # For top-level slices defined in `slices/` or `config/slices/`, this will be the Hanami app\n      # itself (`Hanami.app`). For nested slices, this will be the slice in which they were\n      # registered.\n      #\n      # @return [Hanami::Slice]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :parent\n\n      # Returns the slice's autoloader.\n      #\n      # Each slice has its own `Zeitwerk::Loader` autoloader instance, which is setup when the slice\n      # is {#prepare prepared}.\n      #\n      # @return [Zeitwerk::Loader]\n      #\n      # @see https://github.com/fxn/zeitwerk\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :autoloader\n\n      # Returns the slice's container.\n      #\n      # This is a `Dry::System::Container` that is already configured for the slice.\n      #\n      # In ordinary usage, you shouldn't need direct access the container at all, since the slice\n      # provides its own methods for interacting with the container (such as {#[]}, {#keys}, {#key?}\n      # {#register}, {#register_provider}, {#prepare}, {#start}, {#stop}).\n      #\n      # If you need to configure the container directly, use {#prepare_container}.\n      #\n      # @see https://dry-rb.org/gems/dry-system\n      #\n      # @api public\n      # @since 2.0.0\n      attr_reader :container\n\n      # Returns the Hanami app.\n      #\n      # @return [Hanami::App]\n      #\n      # @api public\n      # @since 2.0.0\n      def app\n        Hanami.app\n      end\n\n      # Returns true if the slice is Hanami.app\n      #\n      # @return [Boolean]\n      #\n      # @api public\n      # @since 2.2.0\n      def app?\n        eql?(app)\n      end\n\n      # Returns the slice's config.\n      #\n      # A slice's config is copied from the app config at time of first access.\n      #\n      # @return [Hanami::Config]\n      #\n      # @see App::ClassMethods.config\n      #\n      # @api public\n      # @since 2.0.0\n      def config\n        @config ||= app.config.dup.tap do |slice_config|\n          # Unset config from app that does not apply to ordinary slices\n          slice_config.root = nil\n        end\n      end\n\n      # Evaluates the block for a given app environment only.\n      #\n      # If the given `env_name` matches {Hanami.env}, then the block will be evaluated in the\n      # context of `self` (the slice) via `instance_eval`. The slice is also passed as the block's\n      # optional argument.\n      #\n      # If the env does not match, then the block is not evaluated at all.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       environment(:test) do\n      #         config.logger.level = :info\n      #       end\n      #     end\n      #   end\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #\n      # @overload environment(env_name)\n      #   @param env_name [Symbol] the environment name\n      #   @yieldparam slice [self] the slice\n      #\n      # @return [self]\n      #\n      # @see Hanami.env\n      #\n      # @api public\n      # @since 2.0.0\n      def environment(env_name, &block)\n        instance_eval(&block) if env_name == config.env\n        self\n      end\n\n      # Returns a {SliceName} for the slice, an object with methods returning the name of the slice\n      # in various formats.\n      #\n      # @return [SliceName]\n      #\n      # @api public\n      # @since 2.0.0\n      def slice_name\n        @slice_name ||= SliceName.new(self, inflector: method(:inflector))\n      end\n\n      # Returns the constant for the slice's module namespace.\n      #\n      # @example\n      #   MySlice::Slice.namespace # => MySlice\n      #\n      # @return [Module] the namespace module constant\n      #\n      # @see SliceName#namespace\n      #\n      # @api public\n      # @since 2.0.0\n      def namespace\n        slice_name.namespace\n      end\n\n      # Returns the slice's root, either the root as explicitly configured, or a default fallback of\n      # the slice's name within the app's `slices/` dir.\n      #\n      # @return [Pathname]\n      #\n      # @see Config#root\n      #\n      # @api public\n      # @since 2.0.0\n      def root\n        # Provides a best guess for a root when it is not yet configured.\n        #\n        # This is particularly useful for user-defined slice classes that access `settings` inside\n        # the class body (since the root needed to find the settings file). In this case,\n        # `configuration.root` may be nil when `settings` is called, since the root is configured by\n        # `SliceRegistrar#configure_slice` _after_ the class is loaded.\n        #\n        # In common cases, this best guess will be correct since most Hanami slices will be expected\n        # to live in the app SLICES_DIR. For advanced cases, the correct slice root should be\n        # explicitly configured at the beginning of the slice class body, before any calls to\n        # `settings`.\n        config.root || app.root.join(SLICES_DIR, slice_name.to_s)\n      end\n\n      # Returns the slice's root component directory, accounting for App as a special case.\n      #\n      # @return [Pathname]\n      #\n      # @api public\n      # @since 2.2.0\n      def source_path\n        app? ? root.join(APP_DIR) : root\n      end\n\n      # Returns the slice's root component directory, as a path relative to the app's root.\n      #\n      # @return [Pathname]\n      #\n      # @see #source_path\n      #\n      # @api public\n      # @since 2.3.0\n      def relative_source_path\n        source_path.relative_path_from(app.root)\n      end\n\n      # Returns the slice's configured inflector.\n      #\n      # Unless explicitly re-configured for the slice, this will be the app's inflector.\n      #\n      # @return [Dry::Inflector]\n      #\n      # @see Config#inflector\n      # @see Config#inflections\n      #\n      # @api public\n      # @since 2.0.0\n      def inflector\n        config.inflector\n      end\n\n      # @overload prepare\n      #   Prepares the slice.\n      #\n      #   This will define the slice's `Slice` and `Deps` constants, make all Ruby source files\n      #   inside the slice's root dir autoloadable, as well as lazily loadable as container\n      #   components.\n      #\n      #   Call `prepare` when you want to access particular components within the slice while still\n      #   minimizing load time. Preparing slices is the approach taken when loading the Hanami\n      #   console or when running tests.\n      #\n      #   @return [self]\n      #\n      #   @see #boot\n      #\n      #   @api public\n      #   @since 2.0.0\n      #\n      # @overload prepare(provider_name)\n      #   Prepares a provider.\n      #\n      #   This triggers the provider's `prepare` lifecycle step.\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [self]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def prepare(provider_name = nil)\n        if provider_name\n          container.prepare(provider_name)\n        else\n          prepare_slice\n        end\n\n        self\n      end\n\n      # Captures the given block to be called with the slice's container during the slice's\n      # `prepare` step, after the slice has already configured the container.\n      #\n      # This is intended for advanced usage only and should not be needed for ordinary slice\n      # configuration and usage.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       prepare_container do |container|\n      #         # ...\n      #       end\n      #     end\n      #   end\n      #\n      # @yieldparam container [Dry::System::Container] the slice's container\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepare_container(&block)\n        @prepare_container_block = block\n        self\n      end\n\n      # Boots the slice.\n      #\n      # This will prepare the slice (if not already prepared), start each of its providers, register\n      # all the slice's components from its Ruby source files, and import components from any other\n      # slices. It will also boot any of the slice's own registered nested slices. It will then\n      # freeze its container so no further components can be registered.\n      #\n      # Call `boot` if you want to fully load a slice and incur all load time up front, such as when\n      # preparing an app to serve web requests. Booting slices is the approach taken when running\n      # Hanami's standard Puma setup (see `config.ru`).\n      #\n      # @return [self]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def boot\n        return self if booted?\n\n        prepare\n\n        container.finalize!\n        slices.each(&:boot)\n\n        @booted = true\n\n        self\n      end\n\n      # Shuts down the slice's providers, as well as the providers in any nested slices.\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def shutdown\n        slices.each(&:shutdown)\n        container.shutdown!\n        self\n      end\n\n      # Returns true if the slice has been prepared.\n      #\n      # @return [Boolean]\n      #\n      # @see #prepare\n      #\n      # @api public\n      # @since 2.0.0\n      def prepared?\n        !!@prepared\n      end\n\n      # Returns true if the slice has been booted.\n      #\n      # @return [Boolean]\n      #\n      # @see #boot\n      #\n      # @api public\n      # @since 2.0.0\n      def booted?\n        !!@booted\n      end\n\n      # Returns the slice's collection of nested slices.\n      #\n      # @return [SliceRegistrar]\n      #\n      # @see #register_slice\n      #\n      # @api public\n      # @since 2.0.0\n      def slices\n        @slices ||= SliceRegistrar.new(self)\n      end\n\n      # @overload register_slice(name, &block)\n      #   Registers a nested slice with the given name.\n      #\n      #   This will define a new {Slice} subclass for the slice. If a block is given, it is passed\n      #   the class object, and will be evaluated in the context of the class like `class_eval`.\n      #\n      #   @example\n      #     MySlice::Slice.register_slice do\n      #       # Configure the slice or do other class-level things here\n      #     end\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @yieldparam slice [Hanami::Slice] the newly defined slice class\n      #\n      # @overload register_slice(name, slice_class)\n      #   Registers a nested slice with the given name.\n      #\n      #   The given `slice_class` will be registered as the slice. It must be a subclass of {Slice}.\n      #\n      #   @param name [Symbol] the identifier for the slice to be registered\n      #   @param slice_class [Hanami::Slice]\n      #\n      # @return [slices]\n      #\n      # @see SliceRegistrar#register\n      #\n      # @api public\n      # @since 2.0.0\n      def register_slice(...)\n        slices.register(...)\n      end\n\n      # Registers a component in the slice's container.\n      #\n      # @overload register(key, object)\n      #   Registers the given object as the component. This same object will be returned whenever\n      #   the component is resolved.\n      #\n      #   @param key [String] the component's key\n      #   @param object [Object] the object to register as the component\n      #\n      # @overload register(key, memoize: false, &block)\n      #   Registers the given block as the component. When the component is resolved, the return\n      #   value of the block will be returned.\n      #\n      #   Since the block is not called until resolution-time, this is a useful way to register\n      #   components that have dependencies on other components in the container, which as yet may\n      #   be unavailable at the time of registration.\n      #\n      #   All auto-registered components are registered in block form.\n      #\n      #   When `memoize` is true, the component will be memoized upon first resolution and the same\n      #   object returned on all subsequent resolutions, meaning the block is only called once.\n      #   Otherwise, the block will be called and a new object returned on every resolution.\n      #\n      #   @param key [String] the component's key\n      #   @param memoize [Boolean]\n      #   @yieldreturn [Object] the object to register as the component\n      #\n      # @overload register(key, call: true, &block)\n      #   Registers the given block as the component. When `call: false` is given, then the block\n      #   itself will become the component.\n      #\n      #   When such a component is resolved, the block will not be called, and instead the `Proc`\n      #   object for that block will be returned.\n      #\n      #   @param key [String] the component's key\n      #   @param call [Boolean]\n      #\n      # @return [container]\n      #\n      # @see #[]\n      # @see #resolve\n      #\n      # @api public\n      # @since 2.0.0\n      def register(...)\n        container.register(...)\n      end\n\n      # @overload register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)\n      #   Registers a provider and its lifecycle hooks.\n      #\n      #   In most cases, you should call this from a dedicated file for the provider in your app or\n      #   slice's `config/providers/` dir. This allows the provider to be loaded when individual\n      #   matching components are resolved (for prepared slices) or when slices are booted.\n      #\n      #   @example Simple provider\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       start do\n      #         require \"db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @example Provider with lifecycle steps, also using dependencies from the target container\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:db) do\n      #       prepare do\n      #         require \"db\"\n      #         db = DB.new(target_container[\"settings\"].database_url)\n      #         register(\"db\", db)\n      #       end\n      #\n      #       start do\n      #         container[\"db\"].establish_connection\n      #       end\n      #\n      #       stop do\n      #         container[\"db\"].close_connection\n      #       end\n      #     end\n      #\n      #   @example Probvider registration under a namespace\n      #     # config/providers/db.rb\n      #     Hanami.app.register_provider(:persistence, namespace: true) do\n      #       start do\n      #         require \"db\"\n      #\n      #         # Namespace option above means this will be registered as \"persistence.db\"\n      #         register(\"db\", DB.new)\n      #       end\n      #     end\n      #\n      #   @param name [Symbol] the unique name for the provider\n      #   @param namespace [Boolean, String, nil] register components from the provider with given\n      #     namespace. May be an explicit string, or `true` for the namespace to be the provider's\n      #     name\n      #   @param from [Symbol, nil] the group for an external provider source to use, with the\n      #     provider source name inferred from `name` or passed explicitly as `source:`\n      #   @param source [Symbol, nil] the name of the external provider source to use, if different\n      #     from the value provided as `name`\n      #   @param if [Boolean] a boolean-returning expression to determine whether to register the\n      #     provider\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def register_provider(...)\n        container.register_provider(...)\n      end\n\n      # @api public\n      # @since 2.1.0\n      def configure_provider(*args, **kwargs, &block)\n        container.register_provider(*args, **kwargs, from: :hanami, &block)\n      end\n\n      # @overload start(provider_name)\n      #   Starts a provider.\n      #\n      #   This triggers the provider's `prepare` and `start` lifecycle steps.\n      #\n      #   @example\n      #     MySlice::Slice.start(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def start(...)\n        container.start(...)\n      end\n\n      # @overload stop(provider_name)\n      #   Stops a provider.\n      #\n      #   This triggers the provider's `stop` lifecycle hook.\n      #\n      #   @example\n      #     MySlice::Slice.stop(:persistence)\n      #\n      #   @param provider_name [Symbol] the name of the provider to start\n      #\n      #   @return [container]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def stop(...)\n        container.stop(...)\n      end\n\n      # @overload key?(key)\n      #   Returns true if the component with the given key is registered in the container.\n      #\n      #   For a prepared slice, calling `key?` will also try to load the component if not loaded\n      #   already.\n      #\n      #   @param key [String, Symbol] the component key\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      def key?(...)\n        container.key?(...)\n      end\n\n      # Required for the slice to act as a provider target\n      # @api public\n      # @since 2.2.0\n      def registered?(...)\n        container.registered?(...)\n      end\n\n      # Returns an array of keys for all currently registered components in the container.\n      #\n      # For a prepared slice, this will be the set of components that have been previously resolved.\n      # For a booted slice, this will be all components available for the slice.\n      #\n      # @return [Array<String>]\n      #\n      # @api public\n      # @since 2.0.0\n      def keys\n        container.keys\n      end\n\n      # @overload [](key)\n      #   Resolves the component with the given key from the container.\n      #\n      #   For a prepared slice, this will attempt to load and register the matching component if it\n      #   is not loaded already. For a booted slice, this will return from already registered\n      #   components only.\n      #\n      #   @return [Object] the resolved component's object\n      #\n      #   @raise Dry::Container::KeyError if the component could not be found or loaded\n      #\n      #   @see #resolve\n      #\n      #   @api public\n      #   @since 2.0.0\n      def [](...)\n        container.[](...)\n      end\n\n      # @see #[]\n      #\n      # @api public\n      # @since 2.0.0\n      def resolve(...)\n        container.resolve(...)\n      end\n\n      # Specifies the components to export from the slice.\n      #\n      # Slices importing from this slice can import the specified components only.\n      #\n      # @example\n      #   module MySlice\n      #     class Slice < Hanami::Slice\n      #       export [\"search\", \"index_entity\"]\n      #     end\n      #   end\n      #\n      # @param keys [Array<String>] the component keys to export\n      #\n      # @return [self]\n      #\n      # @api public\n      # @since 2.0.0\n      def export(keys)\n        container.config.exports = keys\n        self\n      end\n\n      # @overload import(from:, as: nil, keys: nil)\n      #   Specifies components to import from another slice.\n      #\n      #   Booting a slice will register all imported components. For a prepared slice, these\n      #   components will be be imported automatically when resolved.\n      #\n      #   @example\n      #     module MySlice\n      #       class Slice < Hanami:Slice\n      #         # Component from Search::Slice will import as \"search.index_entity\"\n      #         import keys: [\"index_entity\"], from: :search\n      #       end\n      #     end\n      #\n      #   @example Other import variations\n      #     # Different key namespace: component will be \"search_backend.index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: \"search_backend\"\n      #\n      #     # Import to root key namespace: component will be \"index_entity\"\n      #     import keys: [\"index_entity\"], from: :search, as: nil\n      #\n      #     # Import all components\n      #     import from: :search\n      #\n      #   @param keys [Array<String>, nil] Array of component keys to import. To import all\n      #     available components, omit this argument.\n      #   @param from [Symbol] name of the slice to import from\n      #   @param as [Symbol, String, nil]\n      #\n      #   @see #export\n      #\n      #   @api public\n      #   @since 2.0.0\n      def import(from:, **kwargs)\n        slice = self\n\n        container.after(:configure) do\n          if from.is_a?(Symbol) || from.is_a?(String)\n            slice_name = from\n            from = slice.parent.slices[from.to_sym].container\n          end\n\n          as = kwargs[:as] || slice_name\n\n          import(from: from, as: as, **kwargs)\n        end\n      end\n\n      # Returns the slice's settings, or nil if no settings are defined.\n      #\n      # You can define your settings in `config/settings.rb`.\n      #\n      # @return [Hanami::Settings, nil]\n      #\n      # @see Hanami::Settings\n      #\n      # @api public\n      # @since 2.0.0\n      def settings\n        return @settings if instance_variable_defined?(:@settings)\n\n        @settings = Settings.load_for_slice(self)\n      end\n\n      # Returns the slice's routes, or nil if no routes are defined.\n      #\n      # You can define your routes in `config/routes.rb`.\n      #\n      # @return [Hanami::Routes, nil]\n      #\n      # @see Hanami::Routes\n      #\n      # @api public\n      # @since 2.0.0\n      def routes\n        return @routes if instance_variable_defined?(:@routes)\n\n        @routes = load_routes\n      end\n\n      # Returns the slice's router, if or nil if no routes are defined.\n      #\n      # An optional `inspector`, implementing the `Hanami::Router::Inspector` interface, may be\n      # provided at first call (the router is then memoized for subsequent accesses). An inspector\n      # is used by the `hanami routes` CLI comment to provide a list of available routes.\n      #\n      # The returned router is a {Slice::Router}, which provides all `Hanami::Router` functionality,\n      # with the addition of support for slice mounting with the {Slice::Router#slice}.\n      #\n      # @param inspector [Hanami::Router::Inspector, nil] an optional routes inspector\n      #\n      # @return [Hanami::Slice::Router, nil]\n      #\n      # @api public\n      # @since 2.0.0\n      def router(inspector: nil)\n        raise SliceLoadError, \"#{self} must be prepared before loading the router\" unless prepared?\n\n        @_mutex.synchronize do\n          @_router ||= load_router(inspector: inspector)\n        end\n      end\n\n      # Returns a [Rack][rack] app for the slice, or nil if no routes are defined.\n      #\n      # The rack app will be memoized on first access.\n      #\n      # [rack]: https://github.com/rack/rack\n      #\n      # @return [#call, nil] the rack app, or nil if no routes are defined\n      #\n      # @see #routes\n      # @see #router\n      #\n      # @api public\n      # @since 2.0.0\n      def rack_app\n        return unless router\n\n        @rack_app ||= router.to_rack_app\n      end\n\n      # @overload call(rack_env)\n      #   Calls the slice's [Rack][rack] app and returns a Rack-compatible response object\n      #\n      #   [rack]: https://github.com/rack/rack\n      #\n      #   @param rack_env [Hash] the Rack environment for the request\n      #\n      #   @return [Array] the three-element Rack response array\n      #\n      #   @see #rack_app\n      #\n      #   @api public\n      #   @since 2.0.0\n      def call(...)\n        rack_app.call(...)\n      end\n\n      private\n\n      # rubocop:disable Metrics/AbcSize\n\n      def prepare_slice\n        return self if prepared?\n\n        config.finalize!\n\n        ensure_slice_name\n        ensure_slice_consts\n        ensure_root\n\n        prepare_all\n\n        instance_exec(container, &@prepare_container_block) if @prepare_container_block\n        container.configured!\n\n        prepare_autoloader\n\n        # Load child slices last, ensuring their parent is fully prepared beforehand\n        # (useful e.g. for slices that may wish to access constants defined in the\n        # parent's autoloaded directories)\n        prepare_slices\n\n        @prepared = true\n\n        self\n      end\n\n      def ensure_slice_name\n        unless name\n          raise SliceLoadError, \"Slice must have a class name before it can be prepared\"\n        end\n      end\n\n      def ensure_slice_consts\n        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)\n          raise(\n            SliceLoadError,\n            \"#{namespace}::Container and #{namespace}::Deps constants must not already be defined\"\n          )\n        end\n      end\n\n      def ensure_root\n        unless config.root\n          raise SliceLoadError, \"Slice must have a `config.root` before it can be prepared\"\n        end\n      end\n\n      def prepare_all\n        prepare_settings\n        prepare_container_consts\n        prepare_container_plugins\n        prepare_container_base_config\n        prepare_container_component_dirs\n        prepare_container_imports\n        prepare_container_providers\n      end\n\n      def prepare_settings\n        container.register(:settings, settings) if settings\n      end\n\n      def prepare_container_consts\n        namespace.const_set :Container, container\n        namespace.const_set :Deps, container.injector\n      end\n\n      def prepare_container_plugins\n        container.use(:env, inferrer: -> { Hanami.env })\n\n        container.use(\n          :zeitwerk,\n          loader: autoloader,\n          run_setup: false,\n          eager_load: false\n        )\n      end\n\n      def prepare_container_base_config\n        container.config.name = slice_name.to_sym\n        container.config.root = root\n        container.config.provider_registrar = ProviderRegistrar.for_slice(self)\n        container.config.provider_dirs = [File.join(\"config\", \"providers\")]\n        container.config.registrations_dir = File.join(\"config\", \"registrations\")\n\n        container.config.env = config.env\n        container.config.inflector = config.inflector\n      end\n\n      def prepare_container_component_dirs\n        return unless root.directory?\n\n        # Component files in both the root and `lib/` define classes in the slice's\n        # namespace\n\n        if root.join(LIB_DIR)&.directory?\n          container.config.component_dirs.add(LIB_DIR) do |dir|\n            dir.namespaces.add_root(key: nil, const: slice_name.name)\n          end\n        end\n\n        # When auto-registering components in the root, ignore files in `config/` (this is\n        # for framework config only), `lib/` (these will be auto-registered as above), as\n        # well as the configured no_auto_register_paths\n        no_auto_register_paths = ([LIB_DIR, CONFIG_DIR] + config.no_auto_register_paths)\n          .map { |path|\n            path.end_with?(File::SEPARATOR) ? path : \"#{path}#{File::SEPARATOR}\"\n          }\n\n        # TODO: Change `\"\"` (signifying the root) once dry-rb/dry-system#238 is resolved\n        container.config.component_dirs.add(\"\") do |dir|\n          dir.namespaces.add_root(key: nil, const: slice_name.name)\n          dir.auto_register = -> component {\n            relative_path = component.file_path.relative_path_from(root).to_s\n            !relative_path.start_with?(*no_auto_register_paths)\n          }\n        end\n      end\n\n      def prepare_container_imports\n        import(\n          keys: config.shared_app_component_keys,\n          from: app.container,\n          as: nil\n        )\n      end\n\n      # rubocop:disable Metrics/PerceivedComplexity\n      def prepare_container_providers\n        # Check here for the `routes` definition only, not `router` itself, because the\n        # `router` requires the slice to be prepared before it can be loaded, and at this\n        # point we're still in the process of preparing.\n        if routes?\n          require_relative \"providers/routes\"\n          register_provider(:routes, source: Providers::Routes)\n        end\n\n        if assets_dir? && Hanami.bundled?(\"hanami-assets\")\n          require_relative \"providers/assets\"\n          register_provider(:assets, source: Providers::Assets)\n        end\n\n        if Hanami.bundled?(\"hanami-db\")\n          # Explicit require here to ensure the provider source registers itself, to allow the user\n          # to configure it within their own concrete provider file.\n          require_relative \"providers/db\"\n\n          if register_db_provider?\n            # Only register providers if the user hasn't provided their own\n            unless container.providers[:db]\n              register_provider(:db, namespace: true, source: Providers::DB)\n            end\n\n            unless container.providers[:relations]\n              register_provider(:relations, namespace: true, source: Providers::Relations)\n            end\n          end\n        end\n\n        if Hanami.bundled?(\"i18n\")\n          require_relative \"providers/i18n\"\n\n          if i18n_config_dir? && !container.providers[:i18n]\n            register_provider(:i18n, source: Providers::I18n)\n          end\n        end\n      end\n      # rubocop:enable Metrics/PerceivedComplexity\n\n      def prepare_autoloader\n        autoloader.tag = \"hanami.slices.#{slice_name}\"\n\n        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.\n        # This method adds other dirs that are not otherwise configured as component dirs.\n\n        # Everything in the slice root can be autoloaded except `config/` and `slices/`,\n        # which are framework-managed directories\n\n        if root.join(CONFIG_DIR)&.directory?\n          autoloader.ignore(root.join(CONFIG_DIR))\n        end\n\n        if root.join(SLICES_DIR)&.directory?\n          autoloader.ignore(root.join(SLICES_DIR))\n        end\n\n        autoloader.setup\n      end\n\n      def prepare_slices\n        slices.load_slices.each(&:prepare)\n        slices.freeze\n      end\n\n      def routes?\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        return true if namespace.const_defined?(ROUTES_CLASS_NAME)\n\n        root.join(\"#{ROUTES_PATH}#{RB_EXT}\").file?\n      end\n\n      def load_routes\n        return false unless Hanami.bundled?(\"hanami-router\")\n\n        if root.directory?\n          routes_require_path = root.join(ROUTES_PATH).to_s\n\n          begin\n            require_relative \"./routes\"\n            require routes_require_path\n          rescue LoadError => exception\n            raise exception unless exception.path == routes_require_path\n          end\n        end\n\n        begin\n          routes_class = namespace.const_get(ROUTES_CLASS_NAME)\n          routes_class.routes\n        rescue NameError => exception\n          raise exception unless exception.name == ROUTES_CLASS_NAME.to_sym\n        end\n      end\n\n      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n      def load_router(inspector:)\n        return unless routes\n\n        require_relative \"slice/router\"\n\n        slice = self\n        config = self.config\n        rack_monitor = self[\"rack.monitor\"]\n\n        show_welcome = Hanami.env?(:development) && routes.empty?\n        render_errors = render_errors?\n        render_detailed_errors = render_detailed_errors?\n\n        error_handlers = {}.tap do |hsh|\n          if render_errors || render_detailed_errors\n            hsh[:not_allowed] = ROUTER_NOT_ALLOWED_HANDLER\n            hsh[:not_found] = ROUTER_NOT_FOUND_HANDLER\n          end\n        end\n\n        Slice::Router.new(\n          inspector: inspector,\n          inflector: inflector,\n          routes: routes,\n          resolver: config.router.resolver.new(slice: self),\n          **error_handlers,\n          **config.router.options\n        ) do\n          use(rack_monitor)\n\n          use(Hanami::Web::Welcome) if show_welcome\n\n          use(\n            Hanami::Middleware::RenderErrors,\n            config,\n            Hanami::Middleware::PublicErrorsApp.new(slice.root.join(\"public\"))\n          )\n\n          if render_detailed_errors\n            require \"hanami/webconsole\"\n            use(Hanami::Webconsole::Middleware, config)\n          end\n\n          if Hanami.bundled?(\"hanami-action\")\n            if config.actions.method_override\n              require \"rack/method_override\"\n              use(Rack::MethodOverride)\n            end\n\n            if config.actions.sessions.enabled?\n              use(*config.actions.sessions.middleware)\n            end\n\n            if config.actions.content_security_policy && # rubocop:disable Style/SafeNavigation\n               config.actions.content_security_policy.nonce?\n              use(*config.actions.content_security_policy.middleware)\n            end\n          end\n\n          if Hanami.bundled?(\"hanami-assets\") && config.assets.serve\n            use(Hanami::Middleware::Assets)\n          end\n\n          middleware_stack.update(config.middleware_stack)\n        end\n      end\n      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n      def render_errors?\n        config.render_errors\n      end\n\n      def render_detailed_errors?\n        config.render_detailed_errors && Hanami.bundled?(\"hanami-webconsole\")\n      end\n\n      ROUTER_NOT_ALLOWED_HANDLER = -> env, allowed_http_methods {\n        raise Hanami::Router::NotAllowedError.new(env, allowed_http_methods)\n      }.freeze\n      private_constant :ROUTER_NOT_ALLOWED_HANDLER\n\n      ROUTER_NOT_FOUND_HANDLER = -> env {\n        raise Hanami::Router::NotFoundError.new(env)\n      }.freeze\n      private_constant :ROUTER_NOT_FOUND_HANDLER\n\n      def assets_dir?\n        source_path.join(\"assets\").directory?\n      end\n\n      def i18n_config_dir?\n        root.join(\"config\", \"i18n\").directory?\n      end\n\n      def register_db_provider?\n        concrete_db_provider? ||\n          db_config_dir? ||\n          relations_dir? ||\n          db_source_dir? ||\n          import_db_from_parent?\n      end\n\n      def concrete_db_provider?\n        root.join(CONFIG_DIR, \"providers\", \"db.rb\").exist?\n      end\n\n      def db_config_dir?\n        root.join(\"config\", \"db\").directory?\n      end\n\n      def relations_dir?\n        source_path.join(\"relations\").directory?\n      end\n\n      def db_source_dir?\n        source_path.join(\"db\").directory?\n      end\n\n      def import_db_from_parent?\n        parent &&\n          config.db.import_from_parent &&\n          parent.container.providers[:db]\n      end\n\n      # rubocop:enable Metrics/AbcSize\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_router", "signature": "def load_router(inspector:)", "start_line": 1035, "end_line": 1100}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 617}
{"function_name": "load", "file_path": "hanami/lib/hanami/env.rb", "focal_code": "def self.load(env = Hanami.env)\n      return unless Hanami.bundled?(\"dotenv\")\n      return if loaded?\n\n      dotenv_files = [\n        \".env.#{env}.local\",\n        (\".env.local\" unless env == :test),\n        \".env.#{env}\",\n        \".env\"\n      ].compact\n\n      require \"dotenv\"\n      Dotenv.load(*dotenv_files)\n\n      loaded!\n    end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Env\n    # @since 2.0.1\n    # @api private\n    @_loaded = false\n\n    # Uses [dotenv](https://github.com/bkeepers/dotenv) (if available) to populate `ENV` from\n    # various `.env` files.\n    #\n    # For a given `HANAMI_ENV` environment, the `.env` files are looked up in the following order:\n    #\n    # - .env.{environment}.local\n    # - .env.local (unless the environment is `test`)\n    # - .env.{environment}\n    # - .env\n    #\n    # If dotenv is unavailable, the method exits and does nothing.\n    #\n    # @since 2.0.1\n    # @api private\n    def self.load(env = Hanami.env)\n      return unless Hanami.bundled?(\"dotenv\")\n      return if loaded?\n\n      dotenv_files = [\n        \".env.#{env}.local\",\n        (\".env.local\" unless env == :test),\n        \".env.#{env}\",\n        \".env\"\n      ].compact\n\n      require \"dotenv\"\n      Dotenv.load(*dotenv_files)\n\n      loaded!\n    end\n\n    # @since 2.0.1\n    # @api private\n    def self.loaded?\n      @_loaded\n    end\n\n    # @since 2.0.1\n    # @api private\n    def self.loaded!\n      @_loaded = true\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load", "signature": "def self.load(env = Hanami.env)", "start_line": 23, "end_line": 38}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 618}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/config/logger.rb", "focal_code": "def initialize(env:, app_name:)\n        @app_name = app_name\n        @env = env\n\n        case env\n        when :development\n          config.level = :debug\n          config.options = {colorize: true}\n          config.logger_constructor = method(:development_logger)\n        when :test\n          config.level = :debug\n          config.stream = File.join(\"log\", \"#{env}.log\")\n          config.logger_constructor = method(:development_logger)\n        else\n          config.level = :info\n          config.formatter = :json\n          config.logger_constructor = method(:production_logger)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/logger\"\n\nmodule Hanami\n  class Config\n    # Hanami logger config\n    #\n    # @api public\n    # @since 2.0.0\n    class Logger\n      include Dry::Configurable\n\n      # @return [Hanami::SliceName]\n      #\n      # @api private\n      # @since 2.0.0\n      attr_reader :app_name\n\n      # @return [Symbol]\n      #\n      # @api private\n      # @since 2.0.0\n      attr_reader :env\n\n      # @!attribute [rw] level\n      #   Sets or returns the logger's level.\n      #\n      #   Defaults to `:info` for the production environment and `:debug` for all others.\n      #   Can be set via the `HANAMI_LOG_LEVEL` environment variable.\n      #\n      #   @return [Symbol]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :level\n\n      # @!attribute [rw] stream\n      #   Sets or returns the logger's stream.\n      #\n      #   This can be a file path or an `IO`-like object for the logger to write to.\n      #\n      #   Defaults to `\"log/test.log\"` for the test environment and `$stdout` for all others.\n      #\n      #   @return [String, #write]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :stream, default: $stdout\n\n      # @!attribute [rw] formatter\n      #   Sets or returns the logger's formatter.\n      #\n      #   This may be a name that matches a formatter registered with `Dry::Logger`, which includes\n      #   `:string`, `:rack` and `:json`.\n      #\n      #   This may also be an instance of Ruby's built-in `::Logger::Formatter` or any compatible\n      #   object.\n      #\n      #   Defaults to `:json` for the production environment, and `:rack` for all others.\n      #\n      #   @return [Symbol, ::Logger::Formatter]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :formatter, default: :string\n\n      # @!attribute [rw] template\n      #   Sets or returns log entry string template\n      #\n      #   Defaults to `false`.\n      #\n      #   @return [Boolean]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :template, default: :details\n\n      # @!attribute [rw] filters\n      #   Sets or returns an array of attribute names to filter from logs.\n      #\n      #   Defaults to `[\"_csrf\", \"password\", \"password_confirmation\"]`. If you want to preserve\n      #   these defaults, append to this array rather than reassigning it.\n      #\n      #   @return [Array<String>]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :filters, default: %w[_csrf password password_confirmation].freeze\n\n      # @!attribute [rw] logger_constructor\n      #   Sets or returns the constructor proc to use for the logger instantiation.\n      #\n      #   Defaults to either `Config#production_logger` or `Config#development_logger`\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :logger_constructor\n\n      # @!attribute [rw] options\n      #   Sets or returns a hash of options to pass to the {logger_constructor} when initializing\n      #   the logger.\n      #\n      #   Defaults to `{}`\n      #\n      #   @return [Hash]\n      #\n      #   @api public\n      #   @since 2.0.0\n      setting :options, default: {}\n\n      # Returns a new `Logger` config.\n      #\n      # You should not need to initialize this directly, instead use {Hanami::Config#logger}.\n      #\n      # @param env [Symbol] the Hanami env\n      # @param app_name [Hanami::SliceName]\n      #\n      # @api private\n      def initialize(env:, app_name:)\n        @app_name = app_name\n        @env = env\n\n        case env\n        when :development\n          config.level = :debug\n          config.options = {colorize: true}\n          config.logger_constructor = method(:development_logger)\n        when :test\n          config.level = :debug\n          config.stream = File.join(\"log\", \"#{env}.log\")\n          config.logger_constructor = method(:development_logger)\n        else\n          config.level = :info\n          config.formatter = :json\n          config.logger_constructor = method(:production_logger)\n        end\n      end\n\n      # Returns a new instance of the logger.\n      #\n      # @return [logger_class]\n      #\n      # @api public\n      # @since 2.0.0\n      def instance\n        logger_constructor.call(env, app_name.name, **logger_constructor_options)\n      end\n\n      # Build an instance of a development logger\n      #\n      # This logger is used in both development and test\n      #\n      # @return [Dry::Logger::Dispatcher]\n      # @since 2.0.0\n      # @api private\n      def development_logger(_env, app_name, **options)\n        Dry.Logger(app_name, **options) do |setup|\n          setup\n            .add_backend(log_if: -> entry { !entry.tag?(:rack) && !entry.tag?(:sql) })\n            .add_backend(log_if: -> entry { entry.tag?(:rack) }, formatter: Hanami::Logger::RackFormatter)\n            .add_backend(log_if: -> entry { entry.tag?(:sql) }, formatter: Hanami::Logger::SQLFormatter)\n        end\n      end\n\n      # Build an instance of a production logger\n      #\n      # This logger is used in both development and test\n      #\n      # @return [Dry::Logger::Dispatcher]\n      # @since 2.0.0\n      # @api private\n      def production_logger(_env, app_name, **options)\n        Dry.Logger(app_name, **options)\n      end\n\n      private\n\n      # @api private\n      def logger_constructor_options\n        {\n          stream: stream,\n          level: ENV[\"HANAMI_LOG_LEVEL\"]&.to_sym || level,\n          formatter: formatter,\n          filters: filters,\n          template: template,\n          **options\n        }\n      end\n\n      # @api private\n      def method_missing(name, *args, &block)\n        if config.respond_to?(name)\n          config.public_send(name, *args, &block)\n        else\n          super\n        end\n      end\n\n      # @api private\n      def respond_to_missing?(name, _include_all = false)\n        config.respond_to?(name) || super\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(env:, app_name:)", "start_line": 121, "end_line": 139}, "metadata": {"module": "Hanami", "class_name": "Config", "class_signature": "class Config"}, "task_id": 619}
{"function_name": "method_missing", "file_path": "hanami/lib/hanami/config/views.rb", "focal_code": "def method_missing(name, *args, &block)\n        return super if NON_FORWARDABLE_METHODS.include?(name)\n\n        if config.respond_to?(name)\n          config.public_send(name, *args, &block)\n        elsif base_config.respond_to?(name)\n          base_config.public_send(name, *args, &block)\n        else\n          super\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"hanami/view\"\n\nmodule Hanami\n  class Config\n    # Hanami views config\n    #\n    # This exposes all the settings from the standalone `Hanami::View` class, pre-configured with\n    # sensible defaults for actions within a full Hanami app. It also provides additional settings\n    # for further integration of views with other full stack app components.\n    #\n    # @since 2.1.0\n    # @api public\n    class Views\n      include Dry::Configurable\n\n      # @!attribute [rw] default_template_engine\n      #   Sets or returns the default template engine to use for generated views.\n      #\n      #   Used by generators when no explicit template engine is specified.\n      #   Supports `erb`, `haml`, and `slim`.\n      #\n      #   Defaults to `\"erb\"`.\n      #\n      # @example\n      #   config.views.default_template_engine = \"slim\"\n      #\n      # @return [String] the template engine name\n      #\n      # @api public\n      # @since 2.4.0\n      setting :default_template_engine, default: \"erb\"\n\n      # @api private\n      # @since 2.1.0\n      attr_reader :base_config\n      protected :base_config\n\n      # @api private\n      # @since 2.1.0\n      def initialize(*)\n        super\n\n        @base_config = Hanami::View.config.dup\n\n        configure_defaults\n      end\n\n      # @api private\n      # @since 2.1.0\n      def initialize_copy(source)\n        super\n        @base_config = source.base_config.dup\n      end\n      private :initialize_copy\n\n      # @api private\n      # @since 2.1.0\n      def finalize!\n        return self if frozen?\n\n        base_config.finalize!\n\n        super\n      end\n\n      private\n\n      def configure_defaults\n        self.layout = \"app\"\n      end\n\n      # An inflector for views is not configurable via `config.views.inflector` on an\n      # `Hanami::App`. The app-wide inflector is already configurable\n      # there as `config.inflector` and will be used as the default inflector for views.\n      #\n      # A custom inflector may still be provided in an `Hanami::View` subclass, via\n      # `config.inflector=`.\n      NON_FORWARDABLE_METHODS = %i[inflector inflector=].freeze\n      private_constant :NON_FORWARDABLE_METHODS\n\n      def method_missing(name, *args, &block)\n        return super if NON_FORWARDABLE_METHODS.include?(name)\n\n        if config.respond_to?(name)\n          config.public_send(name, *args, &block)\n        elsif base_config.respond_to?(name)\n          base_config.public_send(name, *args, &block)\n        else\n          super\n        end\n      end\n\n      def respond_to_missing?(name, _include_all = false)\n        return false if NON_FORWARDABLE_METHODS.include?(name)\n\n        config.respond_to?(name) || base_config.respond_to?(name) || super\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "method_missing", "signature": "def method_missing(name, *args, &block)", "start_line": 84, "end_line": 94}, "metadata": {"module": "Hanami", "class_name": "Config", "class_signature": "class Config"}, "task_id": 620}
{"function_name": "data", "file_path": "hanami/lib/hanami/web/rack_logger.rb", "focal_code": "def data(env, status:, elapsed:)\n        {\n          verb: env[REQUEST_METHOD],\n          status: status,\n          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],\n          path: \"#{env[SCRIPT_NAME]}#{env[PATH_INFO]}\",\n          length: extract_content_length(env),\n          params: env.fetch(ROUTER_PARAMS, EMPTY_PARAMS),\n          elapsed: elapsed,\n          elapsed_unit: MICROSECOND\n        }\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"delegate\"\nrequire \"json\"\n\nmodule Hanami\n  # @api private\n  module Web\n    # Rack logger for Hanami apps\n    #\n    # @api private\n    # @since 2.0.0\n    class RackLogger\n      EMPTY_PARAMS = {}.freeze\n      private_constant :EMPTY_PARAMS\n\n      REQUEST_METHOD = \"REQUEST_METHOD\"\n      private_constant :REQUEST_METHOD\n\n      HTTP_X_FORWARDED_FOR = \"HTTP_X_FORWARDED_FOR\"\n      private_constant :HTTP_X_FORWARDED_FOR\n\n      REMOTE_ADDR = \"REMOTE_ADDR\"\n      private_constant :REMOTE_ADDR\n\n      SCRIPT_NAME = \"SCRIPT_NAME\"\n      private_constant :SCRIPT_NAME\n\n      PATH_INFO = \"PATH_INFO\"\n      private_constant :PATH_INFO\n\n      ROUTER_PARAMS = \"router.params\"\n      private_constant :ROUTER_PARAMS\n\n      CONTENT_LENGTH = \"CONTENT_LENGTH\"\n      private_constant :CONTENT_LENGTH\n\n      MILLISECOND = \"ms\"\n      private_constant :MILLISECOND\n\n      MICROSECOND = \"µs\"\n      private_constant :MICROSECOND\n\n      # Dynamic extension used in development and test environments\n      # @api private\n      module Development\n        private\n\n        # @since 2.0.0\n        # @api private\n        def data(env, status:, elapsed:)\n          payload = super\n          payload.delete(:elapsed_unit)\n          payload[:elapsed] = elapsed > 1000 ? \"#{elapsed / 1000}ms\" : \"#{elapsed}#{MICROSECOND}\"\n          payload\n        end\n      end\n\n      # @api private\n      # @since 2.0.0\n      def initialize(logger, env: :development)\n        @logger = Hanami::UniversalLogger[logger]\n        extend(Development) if %i[development test].include?(env)\n      end\n\n      # @api private\n      # @since 2.0.0\n      def attach(rack_monitor)\n        rack_monitor.on :stop do |event|\n          log_request event[:env], event[:status], event[:time]\n        end\n\n        rack_monitor.on :error do |event|\n          # TODO: why we don't provide time on error?\n          log_exception event[:env], event[:exception], 500, 0\n        end\n      end\n\n      # @api private\n      # @since 2.0.0\n      def log_request(env, status, elapsed)\n        logger.tagged(:rack) do\n          logger.info do\n            data(env, status: status, elapsed: elapsed)\n          end\n        end\n      end\n\n      # @api private\n      # @since 2.0.0\n      def log_exception(env, exception, status, elapsed)\n        logger.tagged(:rack) do\n          logger.error(exception) do\n            data(env, status: status, elapsed: elapsed)\n          end\n        end\n      end\n\n      private\n\n      attr_reader :logger\n\n      # @api private\n      # @since 2.0.0\n      def data(env, status:, elapsed:)\n        {\n          verb: env[REQUEST_METHOD],\n          status: status,\n          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],\n          path: \"#{env[SCRIPT_NAME]}#{env[PATH_INFO]}\",\n          length: extract_content_length(env),\n          params: env.fetch(ROUTER_PARAMS, EMPTY_PARAMS),\n          elapsed: elapsed,\n          elapsed_unit: MICROSECOND\n        }\n      end\n\n      # @api private\n      # @since 2.0.0\n      def extract_content_length(env)\n        value = env[CONTENT_LENGTH]\n        !value || value.to_s == \"0\" ? \"-\" : value\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "data", "signature": "def data(env, status:, elapsed:)", "start_line": 105, "end_line": 116}, "metadata": {"module": "Hanami", "class_name": "RackLogger", "class_signature": "class RackLogger"}, "task_id": 621}
{"function_name": "build_sql_colorizer", "file_path": "hanami/lib/hanami/logger/sql_formatter.rb", "focal_code": "def build_sql_colorizer\n        begin\n          require \"rouge\"\n        rescue LoadError\n          return nil\n        end\n\n        theme_name = ENV.fetch(\"HANAMI_SQL_THEME\", \"gruvbox\")\n        theme_class = Rouge::Theme.find(theme_name) || Rouge::Themes::Gruvbox\n        formatter = Rouge::Formatters::Terminal256.new(theme_class.new)\n\n        lexer = Rouge::Lexers::SQL.new\n\n        ->(sql) { formatter.format(lexer.lex(sql)) }\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/logger\"\n\nmodule Hanami\n  module Logger\n    # SQL query log formatter for Dry Logger.\n    #\n    # Formats SQL query log entries with a template that mirrors the structure of the built-in rack\n    # log formatter, providing consistent visual formatting across both HTTP request and database\n    # query logs.\n    #\n    # For example, in development, SQL logs alongside Rack logs:\n    #\n    #   [my_app] [INFO] [2026-03-04 10:15:32] SQL sqlite 1.234ms SELECT * FROM users\n    #   [my_app] [INFO] [2026-03-04 10:15:32] GET 200 1ms 127.0.0.1 /users -\n    #\n    # In production, the default JSON formatter handles SQL entries automatically via the structured\n    # payload.\n    #\n    # Supports colorization via Dry Logger's template color tags. When `colorize: true` is set in\n    # the logger options (the default in development), the \"SQL\" label is colorized, and severity\n    # is colorized per-level by the parent formatter (e.g. INFO => magenta, ERROR => red).\n    #\n    # When colorization is enabled and the \"rouge\" gem is available, SQL queries are syntax\n    # highlighted using Rouge's SQL lexer. This is a soft dependency; if Rouge is not installed,\n    # queries output as plain, unhighlighted text.\n    #\n    # The Rouge theme defaults to Gruvbox and can be customized by setting the `HANAMI_SQL_THEME`\n    # environment variable to any Rouge theme name (e.g. \"github.dark\", \"monokai\", \"gruvbox.light\").\n    # See `Rouge::Theme.registry` for available themes.\n    #\n    # @see Hanami::Logger::SQLLogger\n    #\n    # @api private\n    class SQLFormatter < Dry::Logger::Formatters::String\n      SQL_TEMPLATE = <<~TEXT\n        [%<progname>s] [%<severity>s] [%<time>s] SQL %<db>s %<elapsed>s%<elapsed_unit>s %<query>s\n      TEXT\n\n      SQL_TEMPLATE_COLORIZED = <<~TEXT\n        [%<progname>s] [%<severity>s] [%<time>s] <blue>SQL</blue> %<db>s %<elapsed>s%<elapsed_unit>s %<query>s\n      TEXT\n\n      def initialize(**options)\n        super\n        @template = Dry::Logger::Formatters::Template[\n          colorize? ? SQL_TEMPLATE_COLORIZED : SQL_TEMPLATE\n        ]\n        @sql_colorizer = build_sql_colorizer if colorize?\n      end\n\n      private\n\n      def format_query(value)\n        if @sql_colorizer\n          @sql_colorizer.call(value)\n        else\n          value\n        end\n      end\n\n      def build_sql_colorizer\n        begin\n          require \"rouge\"\n        rescue LoadError\n          return nil\n        end\n\n        theme_name = ENV.fetch(\"HANAMI_SQL_THEME\", \"gruvbox\")\n        theme_class = Rouge::Theme.find(theme_name) || Rouge::Themes::Gruvbox\n        formatter = Rouge::Formatters::Terminal256.new(theme_class.new)\n\n        lexer = Rouge::Lexers::SQL.new\n\n        ->(sql) { formatter.format(lexer.lex(sql)) }\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_sql_colorizer", "signature": "def build_sql_colorizer begin", "start_line": 63, "end_line": 77}, "metadata": {"module": "Hanami", "class_name": "SQLFormatter", "class_signature": "class SQLFormatter < < Dry::Logger::Formatters::String"}, "task_id": 622}
{"function_name": "render_exception", "file_path": "hanami/lib/hanami/middleware/render_errors.rb", "focal_code": "def render_exception(env, exception)\n        request = Rack::Request.new(env)\n        renderable = RenderableException.new(exception, responses: @config.render_error_responses)\n\n        status = renderable.status_code\n        request.path_info = \"/#{status}\"\n        request.set_header(Rack::REQUEST_METHOD, \"GET\")\n\n        @errors_app.call(request.env)\n      rescue Exception => exception\n        # rubocop:disable Style/StderrPuts\n        $stderr.puts \"Error during exception rendering: #{exception}\\n  #{exception.backtrace * \"\\n  \"}\"\n        # rubocop:enable Style/StderrPuts\n\n        [\n          500,\n          {\"Content-Type\" => \"text/plain; charset=utf-8\"},\n          [\"Internal Server Error\"]\n        ]\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"rack\"\n\n# rubocop:disable Lint/RescueException\n\nmodule Hanami\n  module Middleware\n    # Rack middleware that rescues errors raised by the app renders friendly error responses, via a\n    # given \"errors app\".\n    #\n    # By default, this is enabled only in production mode.\n    #\n    # @see Hanami::Config#render_errors\n    # @see Hanani::Middleware::PublicErrorsApp\n    #\n    # @api private\n    # @since 2.1.0\n    class RenderErrors\n      # @api private\n      # @since 2.1.0\n      class RenderableException\n        attr_reader :exception\n        attr_reader :responses\n\n        # @api private\n        # @since 2.1.0\n        def initialize(exception, responses:)\n          @exception = exception\n          @responses = responses\n        end\n\n        # @api private\n        # @since 2.1.0\n        def rescue_response?\n          responses.key?(exception.class.name)\n        end\n\n        # @api private\n        # @since 2.1.0\n        def status_code\n          Rack::Utils.status_code(responses[exception.class.name])\n        end\n      end\n\n      # @api private\n      # @since 2.1.0\n      def initialize(app, config, errors_app)\n        @app = app\n        @config = config\n        @errors_app = errors_app\n      end\n\n      # @api private\n      # @since 2.1.0\n      def call(env)\n        @app.call(env)\n      rescue Exception => exception\n        raise unless @config.render_errors\n\n        render_exception(env, exception)\n      end\n\n      private\n\n      def render_exception(env, exception)\n        request = Rack::Request.new(env)\n        renderable = RenderableException.new(exception, responses: @config.render_error_responses)\n\n        status = renderable.status_code\n        request.path_info = \"/#{status}\"\n        request.set_header(Rack::REQUEST_METHOD, \"GET\")\n\n        @errors_app.call(request.env)\n      rescue Exception => exception\n        # rubocop:disable Style/StderrPuts\n        $stderr.puts \"Error during exception rendering: #{exception}\\n  #{exception.backtrace * \"\\n  \"}\"\n        # rubocop:enable Style/StderrPuts\n\n        [\n          500,\n          {\"Content-Type\" => \"text/plain; charset=utf-8\"},\n          [\"Internal Server Error\"]\n        ]\n      end\n    end\n  end\nend\n\n# rubocop:enable Lint/RescueException\n", "language": "ruby", "function_component": {"name": "render_exception", "signature": "def render_exception(env, exception)", "start_line": 66, "end_line": 85}, "metadata": {"module": "Hanami", "class_name": "RenderErrors", "class_signature": "class RenderErrors"}, "task_id": 623}
{"function_name": "call", "file_path": "hanami/lib/hanami/middleware/public_errors_app.rb", "focal_code": "def call(env)\n        request = Rack::Request.new(env)\n        status = request.path_info[1..].to_i\n        content_type = request.get_header(\"HTTP_ACCEPT\")\n\n        default_body = {\n          status: status,\n          error: Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])\n        }\n\n        render(status, content_type, default_body)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"rack\"\n\nmodule Hanami\n  module Middleware\n    # The errors app given to {Hanami::Middleware::RenderErrors}, which renders error responses\n    # from HTML pages kept in `public/` as simple JSON structures.\n    #\n    # @see Hanami::Middleware::RenderErrors\n    #\n    # @api private\n    # @since 2.1.0\n    class PublicErrorsApp\n      # @api private\n      # @since 2.1.0\n      attr_reader :public_path\n\n      # @api private\n      # @since 2.1.0\n      def initialize(public_path)\n        @public_path = public_path\n      end\n\n      # @api private\n      # @since 2.1.0\n      def call(env)\n        request = Rack::Request.new(env)\n        status = request.path_info[1..].to_i\n        content_type = request.get_header(\"HTTP_ACCEPT\")\n\n        default_body = {\n          status: status,\n          error: Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])\n        }\n\n        render(status, content_type, default_body)\n      end\n\n      private\n\n      def render(status, content_type, default_body)\n        body, rendered_content_type = render_content(status, content_type, default_body)\n\n        [\n          status,\n          {\n            \"Content-Type\" => \"#{rendered_content_type}; charset=utf-8\",\n            \"Content-Length\" => body.bytesize.to_s\n          },\n          [body]\n        ]\n      end\n\n      def render_content(status, content_type, default_body)\n        if content_type.to_s.start_with?(\"application/json\")\n          require \"json\"\n          [JSON.generate(default_body), \"application/json\"]\n        else\n          [render_html_content(status, default_body), \"text/html\"]\n        end\n      end\n\n      def render_html_content(status, default_body)\n        path = \"#{public_path}/#{status}.html\"\n\n        if File.exist?(path)\n          File.read(path)\n        else\n          default_body[:error]\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(env)", "start_line": 27, "end_line": 38}, "metadata": {"module": "Hanami", "class_name": "PublicErrorsApp", "class_signature": "class PublicErrorsApp"}, "task_id": 624}
{"function_name": "render", "file_path": "hanami/lib/hanami/middleware/public_errors_app.rb", "focal_code": "def render(status, content_type, default_body)\n        body, rendered_content_type = render_content(status, content_type, default_body)\n\n        [\n          status,\n          {\n            \"Content-Type\" => \"#{rendered_content_type}; charset=utf-8\",\n            \"Content-Length\" => body.bytesize.to_s\n          },\n          [body]\n        ]\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"rack\"\n\nmodule Hanami\n  module Middleware\n    # The errors app given to {Hanami::Middleware::RenderErrors}, which renders error responses\n    # from HTML pages kept in `public/` as simple JSON structures.\n    #\n    # @see Hanami::Middleware::RenderErrors\n    #\n    # @api private\n    # @since 2.1.0\n    class PublicErrorsApp\n      # @api private\n      # @since 2.1.0\n      attr_reader :public_path\n\n      # @api private\n      # @since 2.1.0\n      def initialize(public_path)\n        @public_path = public_path\n      end\n\n      # @api private\n      # @since 2.1.0\n      def call(env)\n        request = Rack::Request.new(env)\n        status = request.path_info[1..].to_i\n        content_type = request.get_header(\"HTTP_ACCEPT\")\n\n        default_body = {\n          status: status,\n          error: Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])\n        }\n\n        render(status, content_type, default_body)\n      end\n\n      private\n\n      def render(status, content_type, default_body)\n        body, rendered_content_type = render_content(status, content_type, default_body)\n\n        [\n          status,\n          {\n            \"Content-Type\" => \"#{rendered_content_type}; charset=utf-8\",\n            \"Content-Length\" => body.bytesize.to_s\n          },\n          [body]\n        ]\n      end\n\n      def render_content(status, content_type, default_body)\n        if content_type.to_s.start_with?(\"application/json\")\n          require \"json\"\n          [JSON.generate(default_body), \"application/json\"]\n        else\n          [render_html_content(status, default_body), \"text/html\"]\n        end\n      end\n\n      def render_html_content(status, default_body)\n        path = \"#{public_path}/#{status}.html\"\n\n        if File.exist?(path)\n          File.read(path)\n        else\n          default_body[:error]\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "render", "signature": "def render(status, content_type, default_body)", "start_line": 42, "end_line": 53}, "metadata": {"module": "Hanami", "class_name": "PublicErrorsApp", "class_signature": "class PublicErrorsApp"}, "task_id": 625}
{"function_name": "start", "file_path": "hanami/lib/hanami/providers/rack.rb", "focal_code": "def start\n        slice.start :logger\n\n        monitor_middleware = Dry::Monitor::Rack::Middleware.new(\n          target[\"notifications\"],\n          clock: Dry::Monitor::Clock.new(unit: :microsecond)\n        )\n\n        rack_logger = Hanami::Web::RackLogger.new(target[:logger], env: slice.container.env)\n        rack_logger.attach(monitor_middleware)\n\n        register \"monitor\", monitor_middleware\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  # @api private\n  module Providers\n    # Provider source to register Rack integration components in Hanami slices.\n    #\n    # @see Hanami::Providers::Logger\n    # @see Hanami::Web::RackLogger\n    # @see https://github.com/rack/rack\n    # @see https://dry-rb.org/gems/dry-monitor/\n    #\n    # @api private\n    # @since 2.0.0\n    class Rack < Hanami::Provider::Source\n      # @api private\n      def prepare\n        Dry::Monitor.load_extensions(:rack)\n\n        # Explicitly register the Rack middleware events on our notifications bus. The Dry::Monitor\n        # rack extension (activated above) does register these globally, but if the notifications\n        # bus has been used before this provider loads, then it will have created its own separate\n        # local copy of all registered events as of that moment in time, which will not be included\n        # in the Rack events globally registered above.\n        notifications = target[\"notifications\"]\n        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_START)\n        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_STOP)\n        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_ERROR)\n      end\n\n      # @api private\n      def start\n        slice.start :logger\n\n        monitor_middleware = Dry::Monitor::Rack::Middleware.new(\n          target[\"notifications\"],\n          clock: Dry::Monitor::Clock.new(unit: :microsecond)\n        )\n\n        rack_logger = Hanami::Web::RackLogger.new(target[:logger], env: slice.container.env)\n        rack_logger.attach(monitor_middleware)\n\n        register \"monitor\", monitor_middleware\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "start", "signature": "def start slice.start :logger", "start_line": 32, "end_line": 44}, "metadata": {"module": "Hanami", "class_name": "Rack", "class_signature": "class Rack < < Hanami::Provider::Source"}, "task_id": 626}
{"function_name": "prepare", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare", "signature": "def prepare prepare_and_import_parent_db and return if import_from_parent?", "start_line": 40, "end_line": 73}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 627}
{"function_name": "apply_parent_config", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "apply_parent_config", "signature": "def apply_parent_config parent_db_provider.source.finalize_config", "start_line": 111, "end_line": 136}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 628}
{"function_name": "configure_gateways", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "configure_gateways", "signature": "def configure_gateways # Create gateway configs for gateways detected from database_url ENV vars", "start_line": 178, "end_line": 205}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 629}
{"function_name": "apply_parent_gateway_config", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "apply_parent_gateway_config", "signature": "def apply_parent_gateway_config(key, gw_config)", "start_line": 207, "end_line": 225}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 630}
{"function_name": "prepare_gateways", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "prepare_gateways", "signature": "def prepare_gateways config.gateways.transform_values { |gw_config|", "start_line": 227, "end_line": 238}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 631}
{"function_name": "detect_database_urls_from_env", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "detect_database_urls_from_env", "signature": "def detect_database_urls_from_env database_urls = {}", "start_line": 240, "end_line": 269}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 632}
{"function_name": "ensure_database_gem", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "ensure_database_gem", "signature": "def ensure_database_gem(database_url)", "start_line": 286, "end_line": 298}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 633}
{"function_name": "register_rom_components", "file_path": "hanami/lib/hanami/providers/db.rb", "focal_code": "def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\nrequire \"uri\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Providers\n    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    # @api private\n    # @since 2.2.0\n    class DB < Hanami::Provider::Source\n      extend Dry::Core::Cache\n\n      include Dry::Configurable(config_class: Providers::DB::Config)\n\n      setting :adapters, mutable: true, default: Adapters.new\n      setting :gateways, default: {}\n\n      def initialize(...)\n        super(...)\n\n        @config_finalized = false\n      end\n\n      def finalize_config\n        return if @config_finalized\n\n        apply_parent_config if apply_parent_config?\n\n        configure_gateways\n\n        @config_finalized = true\n\n        self\n      end\n\n      def prepare\n        prepare_and_import_parent_db and return if import_from_parent?\n\n        override_rom_inflector\n\n        finalize_config\n\n        require \"hanami-db\"\n\n        gateways = prepare_gateways\n\n        if gateways[:default]\n          register \"gateway\", gateways[:default]\n        elsif gateways.length == 1\n          register \"gateway\", gateways.values.first\n        end\n        gateways.each do |key, gateway|\n          register \"gateways.#{key}\", gateway\n        end\n\n        @rom_config = ROM::Configuration.new(gateways)\n\n        config.each_plugin do |adapter_name, plugin_spec, config_block|\n          if config_block\n            @rom_config.plugin(adapter_name, plugin_spec) do |plugin_config|\n              instance_exec(plugin_config, &config_block)\n            end\n          else\n            @rom_config.plugin(adapter_name, plugin_spec)\n          end\n        end\n\n        register \"config\", @rom_config\n      end\n\n      def start\n        start_and_import_parent_db and return if import_from_parent?\n\n        # Set up DB logging for the whole app. We share the app's notifications bus across all\n        # slices, so we only need to configure the subsciprtion for DB logging just once.\n        slice.app.start :db_logging\n\n        # Register ROM components\n        register_rom_components :relation, \"relations\"\n        register_rom_components :command, File.join(\"db\", \"commands\")\n        register_rom_components :mapper, File.join(\"db\", \"mappers\")\n\n        rom = ROM.container(@rom_config)\n\n        register \"rom\", rom\n      end\n\n      def stop\n        slice[\"db.rom\"].disconnect\n      end\n\n      # @api private\n      # @since 2.2.0\n      def database_urls\n        finalize_config\n        config.gateways.transform_values { _1.database_url }\n      end\n\n      private\n\n      def parent_db_provider\n        return @parent_db_provider if instance_variable_defined?(:@parent_db_provider)\n\n        @parent_db_provider = slice.parent && slice.parent.container.providers[:db]\n      end\n\n      def apply_parent_config\n        parent_db_provider.source.finalize_config\n\n        self.class.settings.keys.each do |key|\n          # Preserve settings already configured locally\n          next if config.configured?(key)\n\n          # Skip gateway config, we handle this in #configure_gateways\n          next if key == :gateways\n\n          # Skip adapter config, we handle this below\n          next if key == :adapters\n\n          config[key] = parent_db_provider.source.config[key]\n        end\n\n        parent_db_provider.source.config.adapters.each do |adapter_name, parent_adapter|\n          adapter = config.adapter(adapter_name)\n\n          adapter.class.settings.keys.each do |key|\n            next if adapter.config.configured?(key)\n\n            adapter.config[key] = parent_adapter.config[key].dup\n          end\n        end\n      end\n\n      def apply_parent_config?\n        slice.config.db.configure_from_parent && parent_db_provider\n      end\n\n      def import_from_parent?\n        slice.config.db.import_from_parent && slice.parent\n      end\n\n      def prepare_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.prepare :db\n        @rom_config = slice.parent[\"db.config\"]\n\n        register \"config\", (@rom_config = slice.parent[\"db.config\"])\n        register \"gateway\", slice.parent[\"db.gateway\"]\n      end\n\n      def start_and_import_parent_db\n        return unless parent_db_provider\n\n        slice.parent.start :db\n\n        register \"rom\", slice.parent[\"db.rom\"]\n      end\n\n      # ROM 5.3 doesn't have a configurable inflector.\n      #\n      # This is a problem in Hanami because using different\n      # inflection rules for ROM will lead to constant loading\n      # errors.\n      def override_rom_inflector\n        return if ROM::Inflector == Hanami.app[\"inflector\"]\n\n        ROM.instance_eval {\n          remove_const :Inflector\n          const_set :Inflector, Hanami.app[\"inflector\"]\n        }\n      end\n\n      def configure_gateways\n        # Create gateway configs for gateways detected from database_url ENV vars\n        database_urls_from_env = detect_database_urls_from_env\n        database_urls_from_env.keys.each do |key|\n          config.gateways[key] ||= Gateway.new\n        end\n\n        # Create a single default gateway if none is configured or detected from database URLs\n        config.gateways[:default] = Gateway.new if config.gateways.empty?\n\n        # Leave gateways in a stable order: :default first, followed by others in sort order\n        if config.gateways.length > 1\n          gateways = config.gateways\n          config.gateways = {default: gateways[:default], **gateways.sort.to_h}.compact\n        end\n\n        config.gateways.each do |key, gw_config|\n          gw_config.database_url ||= database_urls_from_env.fetch(key) {\n            raise Hanami::ComponentLoadError, \"A database_url for gateway #{key} is required to start :db.\"\n          }\n\n          ensure_database_gem(gw_config.database_url)\n\n          apply_parent_gateway_config(key, gw_config) if apply_parent_config?\n\n          gw_config.configure_adapter(config.adapters)\n        end\n      end\n\n      def apply_parent_gateway_config(key, gw_config)\n        parent_gw_config = parent_db_provider.source.config.gateways[key]\n\n        # Only copy config from a parent gateway with the same name _and_ database URL\n        return unless parent_gw_config&.database_url == gw_config.database_url\n\n        # Copy config from matching parent gateway\n        (gw_config.class.settings.keys - [:adapter]).each do |key|\n          next if gw_config.config.configured?(key)\n\n          gw_config.config[key] = parent_gw_config.config[key].dup\n        end\n\n        # If there is an adapter configured within this slice, prefer that, and do not copy the\n        # adapter from the parent gateway\n        unless config.adapters[gw_config.adapter_name] || gw_config.configured?(:adapter)\n          gw_config.adapter = parent_gw_config.adapter.dup\n        end\n      end\n\n      def prepare_gateways\n        config.gateways.transform_values { |gw_config|\n          # Avoid spurious connections by reusing identically configured gateways across slices\n          fetch_or_store(gw_config.cache_keys) {\n            ROM::Gateway.setup(\n              gw_config.adapter_name,\n              gw_config.database_url,\n              **gw_config.options\n            )\n          }\n        }\n      end\n\n      def detect_database_urls_from_env\n        database_urls = {}\n\n        env_var_prefix = slice.slice_name.name.gsub(\"/\", \"__\").upcase + \"__\" unless slice.app?\n\n        # Build gateway URLs from ENV vars with specific gateway named suffixes\n        gateway_prefix = \"#{env_var_prefix}DATABASE_URL__\"\n        ENV.select { |(k, _)| k.start_with?(gateway_prefix) }\n          .each do |(var, _)|\n            gateway_name = var.split(gateway_prefix).last.downcase\n\n            database_urls[gateway_name.to_sym] = ENV[var]\n          end\n\n        # Set the default gateway from ENV var without suffix\n        unless database_urls.key?(:default)\n          fallback_vars = [\"#{env_var_prefix}DATABASE_URL\", \"DATABASE_URL\"].uniq\n\n          fallback_vars.each do |var|\n            url = ENV[var]\n            database_urls[:default] = url and break if url\n          end\n        end\n\n        if Hanami.env?(:test)\n          database_urls.transform_values! { Hanami::DB::Testing.database_url(_1) }\n        end\n\n        database_urls\n      end\n\n      # @api private\n      # @since 2.2.0\n      DATABASE_GEMS = {\n        \"mysql2\" => \"mysql2\",\n        \"postgres\" => \"pg\",\n        \"sqlite\" => \"sqlite3\"\n      }.freeze\n      private_constant :DATABASE_GEMS\n\n      # Raises an error if the relevant database gem for the configured database_url is not\n      # installed.\n      #\n      # Takes a conservative approach to raising errors. It only does so for the database_url\n      # schemes generated by the `hanami new` CLI command. Uknown schemes are ignored and no errors\n      # are raised.\n      def ensure_database_gem(database_url)\n        scheme = URI(database_url).scheme\n        return unless scheme\n\n        database_gem = DATABASE_GEMS[scheme]\n        return unless database_gem\n\n        return if Hanami.bundled?(database_gem)\n\n        raise Hanami::ComponentLoadError, <<~STR\n          The \"#{database_gem}\" gem is required to connect to #{database_url}. Please add it to your Gemfile.\n        STR\n      end\n\n      def register_rom_components(component_type, path)\n        components_path = target.source_path.join(path)\n        components_path.glob(\"**/*.rb\").each do |component_file|\n          component_name = component_file\n            .relative_path_from(components_path)\n            .sub(RB_EXT_REGEXP, \"\")\n            .to_s\n\n          component_class = target.inflector.camelize(\n            \"#{target.slice_name.name}/#{path}/#{component_name}\"\n          ).then { target.inflector.constantize(_1) }\n\n          @rom_config.public_send(:\"register_#{component_type}\", component_class)\n        end\n      end\n    end\n    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity\n\n    Dry::System.register_provider_source(\n      :db,\n      source: DB,\n      group: :hanami,\n      provider_options: {namespace: true}\n    )\n  end\nend\n", "language": "ruby", "function_component": {"name": "register_rom_components", "signature": "def register_rom_components(component_type, path)", "start_line": 300, "end_line": 314}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 634}
{"function_name": "start", "file_path": "hanami/lib/hanami/providers/i18n.rb", "focal_code": "def start\n        backend = config.backend || ::I18n::Backend::Simple.new\n\n        # Configure fallbacks if enabled (only for default backend, not custom backends)\n        fallbacks_config = nil\n        if config.fallbacks && !config.backend\n          fallbacks_config =\n            case config.fallbacks\n            when true\n              # Use default_locale as the only fallback\n              fallbacks = ::I18n::Locale::Fallbacks.new\n              fallbacks.defaults = [config.default_locale]\n              fallbacks\n            when Hash\n              # Use explicit per-locale fallback mapping\n              ::I18n::Locale::Fallbacks.new(config.fallbacks)\n            when Array\n              # Use the given fallbacks for all locales\n              fallbacks = ::I18n::Locale::Fallbacks.new\n              fallbacks.defaults = config.fallbacks\n              fallbacks\n            else\n              ::I18n::Locale::Fallbacks.new(config.fallbacks)\n            end\n        end\n\n        # Only load translation files if using the default backend. Custom backends are expected to\n        # handle their own initialization.\n        unless config.backend\n          translation_files = resolve_load_paths(Array(config.load_path))\n          backend.load_translations(*translation_files) if translation_files.any?\n        end\n\n        register \"i18n\", Backend.new(\n          backend,\n          locale: config.default_locale,\n          default_locale: config.default_locale,\n          available_locales: config.available_locales,\n          fallbacks: fallbacks_config\n        )\n      end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Providers\n    # @api private\n    class I18n < Hanami::Provider::Source\n      SLICE_CONFIGURED_SETTINGS = %i[default_locale available_locales load_path fallbacks].freeze\n\n      DEFAULT_LOCALE = :en\n      DEFAULT_AVAILABLE_LOCALES = [].freeze\n      DEFAULT_LOAD_PATH = [\"config/i18n/**/*.{yml,yaml,json,rb}\"].freeze\n\n      setting :default_locale, default: DEFAULT_LOCALE\n      setting :available_locales, default: DEFAULT_AVAILABLE_LOCALES\n      setting :backend\n      setting :load_path, default: DEFAULT_LOAD_PATH\n      setting :fallbacks\n\n      def prepare\n        require \"i18n\"\n\n        SLICE_CONFIGURED_SETTINGS.each do |setting|\n          next if config.configured?(setting)\n\n          config.public_send(:\"#{setting}=\", slice.config.i18n.public_send(setting))\n        end\n      end\n\n      # rubocop:disable Metrics/AbcSize\n      def start\n        backend = config.backend || ::I18n::Backend::Simple.new\n\n        # Configure fallbacks if enabled (only for default backend, not custom backends)\n        fallbacks_config = nil\n        if config.fallbacks && !config.backend\n          fallbacks_config =\n            case config.fallbacks\n            when true\n              # Use default_locale as the only fallback\n              fallbacks = ::I18n::Locale::Fallbacks.new\n              fallbacks.defaults = [config.default_locale]\n              fallbacks\n            when Hash\n              # Use explicit per-locale fallback mapping\n              ::I18n::Locale::Fallbacks.new(config.fallbacks)\n            when Array\n              # Use the given fallbacks for all locales\n              fallbacks = ::I18n::Locale::Fallbacks.new\n              fallbacks.defaults = config.fallbacks\n              fallbacks\n            else\n              ::I18n::Locale::Fallbacks.new(config.fallbacks)\n            end\n        end\n\n        # Only load translation files if using the default backend. Custom backends are expected to\n        # handle their own initialization.\n        unless config.backend\n          translation_files = resolve_load_paths(Array(config.load_path))\n          backend.load_translations(*translation_files) if translation_files.any?\n        end\n\n        register \"i18n\", Backend.new(\n          backend,\n          locale: config.default_locale,\n          default_locale: config.default_locale,\n          available_locales: config.available_locales,\n          fallbacks: fallbacks_config\n        )\n      end\n      # rubocop:enable Metrics/AbcSize\n\n      private\n\n      # Resolves load path patterns to actual file paths. Relative patterns are resolved against\n      # slice.root. Absolute paths are used as-is.\n      def resolve_load_paths(patterns)\n        patterns.flat_map do |pattern|\n          if absolute_path?(pattern)\n            # Absolute path or already-globbed absolute paths\n            File.exist?(pattern) ? [pattern] : Dir.glob(pattern)\n          else\n            # Relative pattern - resolve against slice/app root\n            Dir.glob(slice.root.join(pattern))\n          end\n        end\n      end\n\n      def absolute_path?(path)\n        Pathname.new(path).absolute?\n      end\n    end\n\n    Dry::System.register_provider_source(\n      :i18n,\n      source: I18n,\n      group: :hanami\n    )\n  end\nend\n\nrequire_relative \"i18n/backend\"\n", "language": "ruby", "function_component": {"name": "start", "signature": "def start backend = config.backend || ::I18n::Backend::Simple.new", "start_line": 30, "end_line": 70}, "metadata": {"module": "Hanami", "class_name": "I18n", "class_signature": "class I18n < < Hanami::Provider::Source"}, "task_id": 635}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/slice/router.rb", "focal_code": "def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire_relative \"routing/resolver\"\nrequire_relative \"routing/middleware/stack\"\n\nmodule Hanami\n  class Slice\n    # `Hanami::Router` subclass with enhancements for use within Hanami apps.\n    #\n    # This is loaded from Hanami apps and slices and made available as their\n    # {Hanami::Slice::ClassMethods#router router}.\n    #\n    # @api private\n    class Router < ::Hanami::Router\n      # @api private\n      attr_reader :inflector\n\n      # @api private\n      attr_reader :middleware_stack\n\n      # @api private\n      attr_reader :path_prefix\n\n      # @api private\n      def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end\n\n      # @api private\n      def freeze\n        return self if frozen?\n\n        remove_instance_variable(:@middleware_stack)\n        super\n      end\n\n      # @api private\n      def to_rack_app\n        middleware_stack.to_rack_app(self)\n      end\n\n      # @api private\n      def use(*args, **kwargs, &blk)\n        middleware_stack.use(*args, **kwargs.merge(path_prefix: path_prefix.to_s), &blk)\n      end\n\n      # Yields a block for routes to resolve their action components from the given slice.\n      #\n      # An optional URL prefix may be supplied with `at:`.\n      #\n      # @example\n      #   # config/routes.rb\n      #\n      #   module MyApp\n      #     class Routes < Hanami::Routes\n      #       slice :admin, at: \"/admin\" do\n      #         # Will route to the \"actions.posts.index\" component in Admin::Slice\n      #         get \"posts\", to: \"posts.index\"\n      #       end\n      #     end\n      #   end\n      #\n      # @param slice_name [Symbol] the slice's name\n      # @param at [String, nil] optional URL prefix for the routes\n      #\n      # @api public\n      # @since 2.0.0\n      def slice(slice_name, at:, as: nil, &blk)\n        blk ||= @resolver.find_slice(slice_name).routes\n\n        prev_resolver = @resolver\n        @resolver = @resolver.to_slice(slice_name)\n\n        scope(at, as:, &blk)\n      ensure\n        @resolver = prev_resolver\n      end\n\n      # Generates RESTful routes for a plural resource.\n      #\n      # @param name [Symbol] the resource name (plural)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only Limit to specific actions\n      # @option options [Array<Symbol>] :except Exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resources :users\n      #   # Generates:\n      #   # GET    /users          users.index\n      #   # GET    /users/new      users.new\n      #   # POST   /users          users.create\n      #   # GET    /users/:id      users.show\n      #   # GET    /users/:id/edit users.edit\n      #   # PATCH  /users/:id      users.update\n      #   # DELETE /users/:id      users.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resources(name, **options, &block)\n        build_resource(name, :plural, options, &block)\n      end\n\n      # Generates RESTful routes for a singular resource.\n      #\n      # @param name [Symbol] the resource name (singular)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only limit to specific actions\n      # @option options [Array<Symbol>] :except exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resource :profile\n      #   # Generates (singular, no index):\n      #   # GET    /profile/new    profile.new\n      #   # POST   /profile        profile.create\n      #   # GET    /profile        profile.show\n      #   # GET    /profile/edit   profile.edit\n      #   # PATCH  /profile        profile.update\n      #   # DELETE /profile        profile.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resource(name, **options, &block)\n        build_resource(name, :singular, options, &block)\n      end\n\n      private\n\n      def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end\n\n      # Builds RESTful routes for a resource\n      #\n      # @api private\n      class ResourceBuilder\n        ROUTE_OPTIONS = {\n          index: {method: :get},\n          new: {method: :get, path_suffix: \"/new\", name_prefix: \"new\"},\n          create: {method: :post},\n          show: {method: :get, path_suffix: \"/:id\"},\n          edit: {method: :get, path_suffix: \"/:id/edit\", name_prefix: \"edit\"},\n          update: {method: :patch, path_suffix: \"/:id\"},\n          destroy: {method: :delete, path_suffix: \"/:id\"}\n        }.freeze\n\n        PLURAL_ACTIONS = %i[index new create show edit update destroy].freeze\n        SINGULAR_ACTIONS = (PLURAL_ACTIONS - %i[index]).freeze\n\n        def initialize(name:, type:, resource_scope:, options:, inflector:)\n          @name = name\n          @type = type\n          @resource_scope = resource_scope\n          @options = options\n          @inflector = inflector\n\n          @path = options[:path] || name.to_s\n        end\n\n        def scope(router, &block)\n          @resource_scope.push(@name)\n          router.scope(scope_path, as: scope_name, &block)\n        ensure\n          @resource_scope.pop\n        end\n\n        def add_routes(router)\n          actions.each do |action|\n            add_route(router, action, ROUTE_OPTIONS.fetch(action))\n          end\n        end\n\n        private\n\n        def plural?\n          @type == :plural\n        end\n\n        def singular?\n          !plural?\n        end\n\n        def scope_path\n          if plural?\n            \"#{@path}/:#{@inflector.singularize(@path.to_s)}_id\"\n          else\n            @path\n          end\n        end\n\n        def scope_name\n          @inflector.singularize(@name)\n        end\n\n        def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end\n\n        def add_route(router, action, route_options)\n          path = \"/#{@path}#{route_suffix(route_options[:path_suffix])}\"\n          to = \"#{key_path_base}#{CONTAINER_KEY_DELIMITER}#{action}\"\n          as = route_name(action, route_options[:name_prefix])\n\n          router.public_send(route_options[:method], path, to:, as:)\n        end\n\n        def route_suffix(suffix)\n          return suffix.sub(LEADING_ID_REGEX, \"\") if suffix && singular?\n\n          suffix\n        end\n        LEADING_ID_REGEX = %r{\\A/:id}\n\n        def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end\n\n        def route_name(action, prefix)\n          name = route_name_base\n          name = @inflector.pluralize(name) if plural? && PLURALIZED_NAME_ACTIONS.include?(action)\n\n          [prefix, name]\n        end\n        PLURALIZED_NAME_ACTIONS = %i[index create].freeze\n\n        def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize( routes:, inflector:, middleware_stack: Routing::Middleware::Stack.new, prefix: ::Hanami::Router::DEFAULT_PREFIX, **kwargs, &blk )", "start_line": 26, "end_line": 40}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 636}
{"function_name": "build_resource", "file_path": "hanami/lib/hanami/slice/router.rb", "focal_code": "def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire_relative \"routing/resolver\"\nrequire_relative \"routing/middleware/stack\"\n\nmodule Hanami\n  class Slice\n    # `Hanami::Router` subclass with enhancements for use within Hanami apps.\n    #\n    # This is loaded from Hanami apps and slices and made available as their\n    # {Hanami::Slice::ClassMethods#router router}.\n    #\n    # @api private\n    class Router < ::Hanami::Router\n      # @api private\n      attr_reader :inflector\n\n      # @api private\n      attr_reader :middleware_stack\n\n      # @api private\n      attr_reader :path_prefix\n\n      # @api private\n      def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end\n\n      # @api private\n      def freeze\n        return self if frozen?\n\n        remove_instance_variable(:@middleware_stack)\n        super\n      end\n\n      # @api private\n      def to_rack_app\n        middleware_stack.to_rack_app(self)\n      end\n\n      # @api private\n      def use(*args, **kwargs, &blk)\n        middleware_stack.use(*args, **kwargs.merge(path_prefix: path_prefix.to_s), &blk)\n      end\n\n      # Yields a block for routes to resolve their action components from the given slice.\n      #\n      # An optional URL prefix may be supplied with `at:`.\n      #\n      # @example\n      #   # config/routes.rb\n      #\n      #   module MyApp\n      #     class Routes < Hanami::Routes\n      #       slice :admin, at: \"/admin\" do\n      #         # Will route to the \"actions.posts.index\" component in Admin::Slice\n      #         get \"posts\", to: \"posts.index\"\n      #       end\n      #     end\n      #   end\n      #\n      # @param slice_name [Symbol] the slice's name\n      # @param at [String, nil] optional URL prefix for the routes\n      #\n      # @api public\n      # @since 2.0.0\n      def slice(slice_name, at:, as: nil, &blk)\n        blk ||= @resolver.find_slice(slice_name).routes\n\n        prev_resolver = @resolver\n        @resolver = @resolver.to_slice(slice_name)\n\n        scope(at, as:, &blk)\n      ensure\n        @resolver = prev_resolver\n      end\n\n      # Generates RESTful routes for a plural resource.\n      #\n      # @param name [Symbol] the resource name (plural)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only Limit to specific actions\n      # @option options [Array<Symbol>] :except Exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resources :users\n      #   # Generates:\n      #   # GET    /users          users.index\n      #   # GET    /users/new      users.new\n      #   # POST   /users          users.create\n      #   # GET    /users/:id      users.show\n      #   # GET    /users/:id/edit users.edit\n      #   # PATCH  /users/:id      users.update\n      #   # DELETE /users/:id      users.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resources(name, **options, &block)\n        build_resource(name, :plural, options, &block)\n      end\n\n      # Generates RESTful routes for a singular resource.\n      #\n      # @param name [Symbol] the resource name (singular)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only limit to specific actions\n      # @option options [Array<Symbol>] :except exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resource :profile\n      #   # Generates (singular, no index):\n      #   # GET    /profile/new    profile.new\n      #   # POST   /profile        profile.create\n      #   # GET    /profile        profile.show\n      #   # GET    /profile/edit   profile.edit\n      #   # PATCH  /profile        profile.update\n      #   # DELETE /profile        profile.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resource(name, **options, &block)\n        build_resource(name, :singular, options, &block)\n      end\n\n      private\n\n      def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end\n\n      # Builds RESTful routes for a resource\n      #\n      # @api private\n      class ResourceBuilder\n        ROUTE_OPTIONS = {\n          index: {method: :get},\n          new: {method: :get, path_suffix: \"/new\", name_prefix: \"new\"},\n          create: {method: :post},\n          show: {method: :get, path_suffix: \"/:id\"},\n          edit: {method: :get, path_suffix: \"/:id/edit\", name_prefix: \"edit\"},\n          update: {method: :patch, path_suffix: \"/:id\"},\n          destroy: {method: :delete, path_suffix: \"/:id\"}\n        }.freeze\n\n        PLURAL_ACTIONS = %i[index new create show edit update destroy].freeze\n        SINGULAR_ACTIONS = (PLURAL_ACTIONS - %i[index]).freeze\n\n        def initialize(name:, type:, resource_scope:, options:, inflector:)\n          @name = name\n          @type = type\n          @resource_scope = resource_scope\n          @options = options\n          @inflector = inflector\n\n          @path = options[:path] || name.to_s\n        end\n\n        def scope(router, &block)\n          @resource_scope.push(@name)\n          router.scope(scope_path, as: scope_name, &block)\n        ensure\n          @resource_scope.pop\n        end\n\n        def add_routes(router)\n          actions.each do |action|\n            add_route(router, action, ROUTE_OPTIONS.fetch(action))\n          end\n        end\n\n        private\n\n        def plural?\n          @type == :plural\n        end\n\n        def singular?\n          !plural?\n        end\n\n        def scope_path\n          if plural?\n            \"#{@path}/:#{@inflector.singularize(@path.to_s)}_id\"\n          else\n            @path\n          end\n        end\n\n        def scope_name\n          @inflector.singularize(@name)\n        end\n\n        def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end\n\n        def add_route(router, action, route_options)\n          path = \"/#{@path}#{route_suffix(route_options[:path_suffix])}\"\n          to = \"#{key_path_base}#{CONTAINER_KEY_DELIMITER}#{action}\"\n          as = route_name(action, route_options[:name_prefix])\n\n          router.public_send(route_options[:method], path, to:, as:)\n        end\n\n        def route_suffix(suffix)\n          return suffix.sub(LEADING_ID_REGEX, \"\") if suffix && singular?\n\n          suffix\n        end\n        LEADING_ID_REGEX = %r{\\A/:id}\n\n        def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end\n\n        def route_name(action, prefix)\n          name = route_name_base\n          name = @inflector.pluralize(name) if plural? && PLURALIZED_NAME_ACTIONS.include?(action)\n\n          [prefix, name]\n        end\n        PLURALIZED_NAME_ACTIONS = %i[index create].freeze\n\n        def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "build_resource", "signature": "def build_resource(name, type, options, &block)", "start_line": 147, "end_line": 158}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 637}
{"function_name": "actions", "file_path": "hanami/lib/hanami/slice/router.rb", "focal_code": "def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire_relative \"routing/resolver\"\nrequire_relative \"routing/middleware/stack\"\n\nmodule Hanami\n  class Slice\n    # `Hanami::Router` subclass with enhancements for use within Hanami apps.\n    #\n    # This is loaded from Hanami apps and slices and made available as their\n    # {Hanami::Slice::ClassMethods#router router}.\n    #\n    # @api private\n    class Router < ::Hanami::Router\n      # @api private\n      attr_reader :inflector\n\n      # @api private\n      attr_reader :middleware_stack\n\n      # @api private\n      attr_reader :path_prefix\n\n      # @api private\n      def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end\n\n      # @api private\n      def freeze\n        return self if frozen?\n\n        remove_instance_variable(:@middleware_stack)\n        super\n      end\n\n      # @api private\n      def to_rack_app\n        middleware_stack.to_rack_app(self)\n      end\n\n      # @api private\n      def use(*args, **kwargs, &blk)\n        middleware_stack.use(*args, **kwargs.merge(path_prefix: path_prefix.to_s), &blk)\n      end\n\n      # Yields a block for routes to resolve their action components from the given slice.\n      #\n      # An optional URL prefix may be supplied with `at:`.\n      #\n      # @example\n      #   # config/routes.rb\n      #\n      #   module MyApp\n      #     class Routes < Hanami::Routes\n      #       slice :admin, at: \"/admin\" do\n      #         # Will route to the \"actions.posts.index\" component in Admin::Slice\n      #         get \"posts\", to: \"posts.index\"\n      #       end\n      #     end\n      #   end\n      #\n      # @param slice_name [Symbol] the slice's name\n      # @param at [String, nil] optional URL prefix for the routes\n      #\n      # @api public\n      # @since 2.0.0\n      def slice(slice_name, at:, as: nil, &blk)\n        blk ||= @resolver.find_slice(slice_name).routes\n\n        prev_resolver = @resolver\n        @resolver = @resolver.to_slice(slice_name)\n\n        scope(at, as:, &blk)\n      ensure\n        @resolver = prev_resolver\n      end\n\n      # Generates RESTful routes for a plural resource.\n      #\n      # @param name [Symbol] the resource name (plural)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only Limit to specific actions\n      # @option options [Array<Symbol>] :except Exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resources :users\n      #   # Generates:\n      #   # GET    /users          users.index\n      #   # GET    /users/new      users.new\n      #   # POST   /users          users.create\n      #   # GET    /users/:id      users.show\n      #   # GET    /users/:id/edit users.edit\n      #   # PATCH  /users/:id      users.update\n      #   # DELETE /users/:id      users.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resources(name, **options, &block)\n        build_resource(name, :plural, options, &block)\n      end\n\n      # Generates RESTful routes for a singular resource.\n      #\n      # @param name [Symbol] the resource name (singular)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only limit to specific actions\n      # @option options [Array<Symbol>] :except exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resource :profile\n      #   # Generates (singular, no index):\n      #   # GET    /profile/new    profile.new\n      #   # POST   /profile        profile.create\n      #   # GET    /profile        profile.show\n      #   # GET    /profile/edit   profile.edit\n      #   # PATCH  /profile        profile.update\n      #   # DELETE /profile        profile.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resource(name, **options, &block)\n        build_resource(name, :singular, options, &block)\n      end\n\n      private\n\n      def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end\n\n      # Builds RESTful routes for a resource\n      #\n      # @api private\n      class ResourceBuilder\n        ROUTE_OPTIONS = {\n          index: {method: :get},\n          new: {method: :get, path_suffix: \"/new\", name_prefix: \"new\"},\n          create: {method: :post},\n          show: {method: :get, path_suffix: \"/:id\"},\n          edit: {method: :get, path_suffix: \"/:id/edit\", name_prefix: \"edit\"},\n          update: {method: :patch, path_suffix: \"/:id\"},\n          destroy: {method: :delete, path_suffix: \"/:id\"}\n        }.freeze\n\n        PLURAL_ACTIONS = %i[index new create show edit update destroy].freeze\n        SINGULAR_ACTIONS = (PLURAL_ACTIONS - %i[index]).freeze\n\n        def initialize(name:, type:, resource_scope:, options:, inflector:)\n          @name = name\n          @type = type\n          @resource_scope = resource_scope\n          @options = options\n          @inflector = inflector\n\n          @path = options[:path] || name.to_s\n        end\n\n        def scope(router, &block)\n          @resource_scope.push(@name)\n          router.scope(scope_path, as: scope_name, &block)\n        ensure\n          @resource_scope.pop\n        end\n\n        def add_routes(router)\n          actions.each do |action|\n            add_route(router, action, ROUTE_OPTIONS.fetch(action))\n          end\n        end\n\n        private\n\n        def plural?\n          @type == :plural\n        end\n\n        def singular?\n          !plural?\n        end\n\n        def scope_path\n          if plural?\n            \"#{@path}/:#{@inflector.singularize(@path.to_s)}_id\"\n          else\n            @path\n          end\n        end\n\n        def scope_name\n          @inflector.singularize(@name)\n        end\n\n        def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end\n\n        def add_route(router, action, route_options)\n          path = \"/#{@path}#{route_suffix(route_options[:path_suffix])}\"\n          to = \"#{key_path_base}#{CONTAINER_KEY_DELIMITER}#{action}\"\n          as = route_name(action, route_options[:name_prefix])\n\n          router.public_send(route_options[:method], path, to:, as:)\n        end\n\n        def route_suffix(suffix)\n          return suffix.sub(LEADING_ID_REGEX, \"\") if suffix && singular?\n\n          suffix\n        end\n        LEADING_ID_REGEX = %r{\\A/:id}\n\n        def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end\n\n        def route_name(action, prefix)\n          name = route_name_base\n          name = @inflector.pluralize(name) if plural? && PLURALIZED_NAME_ACTIONS.include?(action)\n\n          [prefix, name]\n        end\n        PLURALIZED_NAME_ACTIONS = %i[index create].freeze\n\n        def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "actions", "signature": "def actions default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS", "start_line": 222, "end_line": 231}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 638}
{"function_name": "key_path_base", "file_path": "hanami/lib/hanami/slice/router.rb", "focal_code": "def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire_relative \"routing/resolver\"\nrequire_relative \"routing/middleware/stack\"\n\nmodule Hanami\n  class Slice\n    # `Hanami::Router` subclass with enhancements for use within Hanami apps.\n    #\n    # This is loaded from Hanami apps and slices and made available as their\n    # {Hanami::Slice::ClassMethods#router router}.\n    #\n    # @api private\n    class Router < ::Hanami::Router\n      # @api private\n      attr_reader :inflector\n\n      # @api private\n      attr_reader :middleware_stack\n\n      # @api private\n      attr_reader :path_prefix\n\n      # @api private\n      def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end\n\n      # @api private\n      def freeze\n        return self if frozen?\n\n        remove_instance_variable(:@middleware_stack)\n        super\n      end\n\n      # @api private\n      def to_rack_app\n        middleware_stack.to_rack_app(self)\n      end\n\n      # @api private\n      def use(*args, **kwargs, &blk)\n        middleware_stack.use(*args, **kwargs.merge(path_prefix: path_prefix.to_s), &blk)\n      end\n\n      # Yields a block for routes to resolve their action components from the given slice.\n      #\n      # An optional URL prefix may be supplied with `at:`.\n      #\n      # @example\n      #   # config/routes.rb\n      #\n      #   module MyApp\n      #     class Routes < Hanami::Routes\n      #       slice :admin, at: \"/admin\" do\n      #         # Will route to the \"actions.posts.index\" component in Admin::Slice\n      #         get \"posts\", to: \"posts.index\"\n      #       end\n      #     end\n      #   end\n      #\n      # @param slice_name [Symbol] the slice's name\n      # @param at [String, nil] optional URL prefix for the routes\n      #\n      # @api public\n      # @since 2.0.0\n      def slice(slice_name, at:, as: nil, &blk)\n        blk ||= @resolver.find_slice(slice_name).routes\n\n        prev_resolver = @resolver\n        @resolver = @resolver.to_slice(slice_name)\n\n        scope(at, as:, &blk)\n      ensure\n        @resolver = prev_resolver\n      end\n\n      # Generates RESTful routes for a plural resource.\n      #\n      # @param name [Symbol] the resource name (plural)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only Limit to specific actions\n      # @option options [Array<Symbol>] :except Exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resources :users\n      #   # Generates:\n      #   # GET    /users          users.index\n      #   # GET    /users/new      users.new\n      #   # POST   /users          users.create\n      #   # GET    /users/:id      users.show\n      #   # GET    /users/:id/edit users.edit\n      #   # PATCH  /users/:id      users.update\n      #   # DELETE /users/:id      users.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resources(name, **options, &block)\n        build_resource(name, :plural, options, &block)\n      end\n\n      # Generates RESTful routes for a singular resource.\n      #\n      # @param name [Symbol] the resource name (singular)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only limit to specific actions\n      # @option options [Array<Symbol>] :except exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resource :profile\n      #   # Generates (singular, no index):\n      #   # GET    /profile/new    profile.new\n      #   # POST   /profile        profile.create\n      #   # GET    /profile        profile.show\n      #   # GET    /profile/edit   profile.edit\n      #   # PATCH  /profile        profile.update\n      #   # DELETE /profile        profile.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resource(name, **options, &block)\n        build_resource(name, :singular, options, &block)\n      end\n\n      private\n\n      def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end\n\n      # Builds RESTful routes for a resource\n      #\n      # @api private\n      class ResourceBuilder\n        ROUTE_OPTIONS = {\n          index: {method: :get},\n          new: {method: :get, path_suffix: \"/new\", name_prefix: \"new\"},\n          create: {method: :post},\n          show: {method: :get, path_suffix: \"/:id\"},\n          edit: {method: :get, path_suffix: \"/:id/edit\", name_prefix: \"edit\"},\n          update: {method: :patch, path_suffix: \"/:id\"},\n          destroy: {method: :delete, path_suffix: \"/:id\"}\n        }.freeze\n\n        PLURAL_ACTIONS = %i[index new create show edit update destroy].freeze\n        SINGULAR_ACTIONS = (PLURAL_ACTIONS - %i[index]).freeze\n\n        def initialize(name:, type:, resource_scope:, options:, inflector:)\n          @name = name\n          @type = type\n          @resource_scope = resource_scope\n          @options = options\n          @inflector = inflector\n\n          @path = options[:path] || name.to_s\n        end\n\n        def scope(router, &block)\n          @resource_scope.push(@name)\n          router.scope(scope_path, as: scope_name, &block)\n        ensure\n          @resource_scope.pop\n        end\n\n        def add_routes(router)\n          actions.each do |action|\n            add_route(router, action, ROUTE_OPTIONS.fetch(action))\n          end\n        end\n\n        private\n\n        def plural?\n          @type == :plural\n        end\n\n        def singular?\n          !plural?\n        end\n\n        def scope_path\n          if plural?\n            \"#{@path}/:#{@inflector.singularize(@path.to_s)}_id\"\n          else\n            @path\n          end\n        end\n\n        def scope_name\n          @inflector.singularize(@name)\n        end\n\n        def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end\n\n        def add_route(router, action, route_options)\n          path = \"/#{@path}#{route_suffix(route_options[:path_suffix])}\"\n          to = \"#{key_path_base}#{CONTAINER_KEY_DELIMITER}#{action}\"\n          as = route_name(action, route_options[:name_prefix])\n\n          router.public_send(route_options[:method], path, to:, as:)\n        end\n\n        def route_suffix(suffix)\n          return suffix.sub(LEADING_ID_REGEX, \"\") if suffix && singular?\n\n          suffix\n        end\n        LEADING_ID_REGEX = %r{\\A/:id}\n\n        def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end\n\n        def route_name(action, prefix)\n          name = route_name_base\n          name = @inflector.pluralize(name) if plural? && PLURALIZED_NAME_ACTIONS.include?(action)\n\n          [prefix, name]\n        end\n        PLURALIZED_NAME_ACTIONS = %i[index create].freeze\n\n        def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "key_path_base", "signature": "def key_path_base @key_path_base ||= @options[:to] || begin", "start_line": 248, "end_line": 257}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 639}
{"function_name": "route_name_base", "file_path": "hanami/lib/hanami/slice/router.rb", "focal_code": "def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire_relative \"routing/resolver\"\nrequire_relative \"routing/middleware/stack\"\n\nmodule Hanami\n  class Slice\n    # `Hanami::Router` subclass with enhancements for use within Hanami apps.\n    #\n    # This is loaded from Hanami apps and slices and made available as their\n    # {Hanami::Slice::ClassMethods#router router}.\n    #\n    # @api private\n    class Router < ::Hanami::Router\n      # @api private\n      attr_reader :inflector\n\n      # @api private\n      attr_reader :middleware_stack\n\n      # @api private\n      attr_reader :path_prefix\n\n      # @api private\n      def initialize(\n        routes:,\n        inflector:,\n        middleware_stack: Routing::Middleware::Stack.new,\n        prefix: ::Hanami::Router::DEFAULT_PREFIX,\n        **kwargs,\n        &blk\n      )\n        @path_prefix = Hanami::Router::Prefix.new(prefix)\n        @inflector = inflector\n        @middleware_stack = middleware_stack\n        @resource_scope = []\n        instance_eval(&blk)\n        super(**kwargs, &routes)\n      end\n\n      # @api private\n      def freeze\n        return self if frozen?\n\n        remove_instance_variable(:@middleware_stack)\n        super\n      end\n\n      # @api private\n      def to_rack_app\n        middleware_stack.to_rack_app(self)\n      end\n\n      # @api private\n      def use(*args, **kwargs, &blk)\n        middleware_stack.use(*args, **kwargs.merge(path_prefix: path_prefix.to_s), &blk)\n      end\n\n      # Yields a block for routes to resolve their action components from the given slice.\n      #\n      # An optional URL prefix may be supplied with `at:`.\n      #\n      # @example\n      #   # config/routes.rb\n      #\n      #   module MyApp\n      #     class Routes < Hanami::Routes\n      #       slice :admin, at: \"/admin\" do\n      #         # Will route to the \"actions.posts.index\" component in Admin::Slice\n      #         get \"posts\", to: \"posts.index\"\n      #       end\n      #     end\n      #   end\n      #\n      # @param slice_name [Symbol] the slice's name\n      # @param at [String, nil] optional URL prefix for the routes\n      #\n      # @api public\n      # @since 2.0.0\n      def slice(slice_name, at:, as: nil, &blk)\n        blk ||= @resolver.find_slice(slice_name).routes\n\n        prev_resolver = @resolver\n        @resolver = @resolver.to_slice(slice_name)\n\n        scope(at, as:, &blk)\n      ensure\n        @resolver = prev_resolver\n      end\n\n      # Generates RESTful routes for a plural resource.\n      #\n      # @param name [Symbol] the resource name (plural)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only Limit to specific actions\n      # @option options [Array<Symbol>] :except Exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resources :users\n      #   # Generates:\n      #   # GET    /users          users.index\n      #   # GET    /users/new      users.new\n      #   # POST   /users          users.create\n      #   # GET    /users/:id      users.show\n      #   # GET    /users/:id/edit users.edit\n      #   # PATCH  /users/:id      users.update\n      #   # DELETE /users/:id      users.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resources(name, **options, &block)\n        build_resource(name, :plural, options, &block)\n      end\n\n      # Generates RESTful routes for a singular resource.\n      #\n      # @param name [Symbol] the resource name (singular)\n      # @param options [Hash] options for customizing the routes\n      # @option options [Array<Symbol>] :only limit to specific actions\n      # @option options [Array<Symbol>] :except exclude specific actions\n      # @option options [String] :to the action key namespace, e.g. \"namespace.action\"\n      # @option options [String] :path the URL path\n      # @option options [String, Symbol] :as the route name prefix\n      #\n      # @example\n      #   resource :profile\n      #   # Generates (singular, no index):\n      #   # GET    /profile/new    profile.new\n      #   # POST   /profile        profile.create\n      #   # GET    /profile        profile.show\n      #   # GET    /profile/edit   profile.edit\n      #   # PATCH  /profile        profile.update\n      #   # DELETE /profile        profile.destroy\n      #\n      # @api public\n      # @since 2.3.0\n      def resource(name, **options, &block)\n        build_resource(name, :singular, options, &block)\n      end\n\n      private\n\n      def build_resource(name, type, options, &block)\n        resource_builder = ResourceBuilder.new(\n          name: name,\n          type: type,\n          resource_scope: @resource_scope,\n          options: options,\n          inflector: inflector\n        )\n\n        resource_builder.add_routes(self)\n        resource_builder.scope(self, &block) if block\n      end\n\n      # Builds RESTful routes for a resource\n      #\n      # @api private\n      class ResourceBuilder\n        ROUTE_OPTIONS = {\n          index: {method: :get},\n          new: {method: :get, path_suffix: \"/new\", name_prefix: \"new\"},\n          create: {method: :post},\n          show: {method: :get, path_suffix: \"/:id\"},\n          edit: {method: :get, path_suffix: \"/:id/edit\", name_prefix: \"edit\"},\n          update: {method: :patch, path_suffix: \"/:id\"},\n          destroy: {method: :delete, path_suffix: \"/:id\"}\n        }.freeze\n\n        PLURAL_ACTIONS = %i[index new create show edit update destroy].freeze\n        SINGULAR_ACTIONS = (PLURAL_ACTIONS - %i[index]).freeze\n\n        def initialize(name:, type:, resource_scope:, options:, inflector:)\n          @name = name\n          @type = type\n          @resource_scope = resource_scope\n          @options = options\n          @inflector = inflector\n\n          @path = options[:path] || name.to_s\n        end\n\n        def scope(router, &block)\n          @resource_scope.push(@name)\n          router.scope(scope_path, as: scope_name, &block)\n        ensure\n          @resource_scope.pop\n        end\n\n        def add_routes(router)\n          actions.each do |action|\n            add_route(router, action, ROUTE_OPTIONS.fetch(action))\n          end\n        end\n\n        private\n\n        def plural?\n          @type == :plural\n        end\n\n        def singular?\n          !plural?\n        end\n\n        def scope_path\n          if plural?\n            \"#{@path}/:#{@inflector.singularize(@path.to_s)}_id\"\n          else\n            @path\n          end\n        end\n\n        def scope_name\n          @inflector.singularize(@name)\n        end\n\n        def actions\n          default_actions = plural? ? PLURAL_ACTIONS : SINGULAR_ACTIONS\n          if @options[:only]\n            Array(@options[:only]) & default_actions\n          elsif @options[:except]\n            default_actions - Array(@options[:except])\n          else\n            default_actions\n          end\n        end\n\n        def add_route(router, action, route_options)\n          path = \"/#{@path}#{route_suffix(route_options[:path_suffix])}\"\n          to = \"#{key_path_base}#{CONTAINER_KEY_DELIMITER}#{action}\"\n          as = route_name(action, route_options[:name_prefix])\n\n          router.public_send(route_options[:method], path, to:, as:)\n        end\n\n        def route_suffix(suffix)\n          return suffix.sub(LEADING_ID_REGEX, \"\") if suffix && singular?\n\n          suffix\n        end\n        LEADING_ID_REGEX = %r{\\A/:id}\n\n        def key_path_base\n          @key_path_base ||= @options[:to] || begin\n            if @resource_scope.any?\n              prefix = @resource_scope.join(CONTAINER_KEY_DELIMITER)\n              \"#{prefix}#{CONTAINER_KEY_DELIMITER}#{@name}\"\n            else\n              @name.to_s\n            end\n          end\n        end\n\n        def route_name(action, prefix)\n          name = route_name_base\n          name = @inflector.pluralize(name) if plural? && PLURALIZED_NAME_ACTIONS.include?(action)\n\n          [prefix, name]\n        end\n        PLURALIZED_NAME_ACTIONS = %i[index create].freeze\n\n        def route_name_base\n          @route_name_base ||=\n            if @options[:as]\n              @options[:as].to_s\n            elsif plural?\n              @inflector.singularize(@name.to_s)\n            else\n              @name.to_s\n            end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "route_name_base", "signature": "def route_name_base @route_name_base ||=", "start_line": 267, "end_line": 276}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 640}
{"function_name": "form_for", "file_path": "hanami/lib/hanami/helpers/form_helper.rb", "focal_code": "def form_for(base_name, url = nil, values: _form_for_values, params: _form_for_params, **attributes)\n        url, base_name = base_name, nil if url.nil?\n\n        values = Values.new(values: values, params: params, csrf_token: _form_csrf_token)\n\n        builder = FormBuilder.new(\n          base_name: base_name,\n          values: values,\n          inflector: _context.inflector,\n          form_attributes: attributes\n        )\n\n        content = (block_given? ? yield(builder) : \"\").html_safe\n\n        builder.call(content, action: url, **attributes)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/view\"\n\nmodule Hanami\n  module Helpers\n    # Helper methods for generating HTML forms.\n    #\n    # These helpers will be automatically available in your view templates, part classes and scope\n    # classes.\n    #\n    # This module provides one primary method: {#form_for}, yielding an HTML form builder. This\n    # integrates with request params and template locals to populate the form with appropriate\n    # values.\n    #\n    # @api public\n    # @since 2.1.0\n    module FormHelper\n      require_relative \"form_helper/form_builder\"\n\n      # Default HTTP method for form\n      #\n      # @since 2.1.0\n      # @api private\n      DEFAULT_METHOD = \"POST\"\n\n      # Default charset\n      #\n      # @since 2.1.0\n      # @api private\n      DEFAULT_CHARSET = \"utf-8\"\n\n      # CSRF Token session key\n      #\n      # This name of this key is shared with the hanami and hanami-action gems.\n      #\n      # @since 2.1.0\n      # @api private\n      CSRF_TOKEN = :_csrf_token\n\n      include Hanami::View::Helpers::TagHelper\n\n      # Yields a form builder for constructing an HTML form and returns the resulting form string.\n      #\n      # See {FormHelper::FormBuilder} for the methods for building the form's fields.\n      #\n      # @overload form_for(base_name, url, values: _form_for_values, params: _form_for_params, **attributes)\n      #   Builds the form using the given base name for all fields.\n      #\n      #   @param base_name [String] the base\n      #   @param url [String] the URL for submitting the form\n      #   @param values [Hash] values to be used for populating form field values; optional,\n      #     defaults to the template's locals or to a part's `{name => self}`\n      #   @param params [Hash] request param values to be used for populating form field values;\n      #     these are used in preference over the `values`; optional, defaults to the current\n      #     request's params\n      #   @param attributes [Hash] the HTML attributes for the form tag\n      #   @yieldparam [FormHelper::FormBuilder] f the form builder\n      #\n      # @overload form_for(url, values: _form_for_values, params: _form_for_params, **attributes)\n      #   @param url [String] the URL for submitting the form\n      #   @param values [Hash] values to be used for populating form field values; optional,\n      #     defaults to the template's locals or to a part's `{name => self}`\n      #   @param params [Hash] request param values to be used for populating form field values;\n      #     these are used in preference over the `values`; optional, defaults to the current\n      #     request's params\n      #   @param attributes [Hash] the HTML attributes for the form tag\n      #   @yieldparam [FormHelper::FormBuilder] f the form builder\n      #\n      # @return [String] the form HTML\n      #\n      # @see FormHelper\n      # @see FormHelper::FormBuilder\n      #\n      # @example Basic usage\n      #   <%= form_for(\"book\", \"/books\", class: \"form-horizontal\") do |f| %>\n      #     <div>\n      #       <%= f.label \"title\" %>\n      #       <%= f.text_field \"title\", class: \"form-control\" %>\n      #     </div>\n      #\n      #     <%= f.submit \"Create\" %>\n      #   <% end %>\n      #\n      #   =>\n      #   <form action=\"/books\" method=\"POST\" accept-charset=\"utf-8\" class=\"form-horizontal\">\n      #     <input type=\"hidden\" name=\"_csrf_token\" value=\"920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d\">\n      #     <div>\n      #       <label for=\"book-title\">Title</label>\n      #       <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Test Driven Development\">\n      #     </div>\n      #\n      #     <button type=\"submit\">Create</button>\n      #   </form>\n      #\n      # @example Without base name\n      #\n      #   <%= form_for(\"/books\", class: \"form-horizontal\") do |f| %>\n      #     <div>\n      #       <%= f.label \"books.title\" %>\n      #       <%= f.text_field \"books.title\", class: \"form-control\" %>\n      #     </div>\n      #\n      #     <%= f.submit \"Create\" %>\n      #   <% end %>\n      #\n      #   =>\n      #   <form action=\"/books\" method=\"POST\" accept-charset=\"utf-8\" class=\"form-horizontal\">\n      #     <input type=\"hidden\" name=\"_csrf_token\" value=\"920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d\">\n      #     <div>\n      #       <label for=\"book-title\">Title</label>\n      #       <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Test Driven Development\">\n      #     </div>\n      #\n      #     <button type=\"submit\">Create</button>\n      #   </form>\n      #\n      # @example Method override\n      #   <%= form_for(\"/books/123\", method: :put) do |f|\n      #     <%= f.text_field \"book.title\" %>\n      #     <%= f.submit \"Update\" %>\n      #   <% end %>\n      #\n      #   =>\n      #   <form action=\"/books/123\" accept-charset=\"utf-8\" method=\"POST\">\n      #     <input type=\"hidden\" name=\"_method\" value=\"PUT\">\n      #     <input type=\"hidden\" name=\"_csrf_token\" value=\"920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d\">\n      #     <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Test Driven Development\">\n      #\n      #     <button type=\"submit\">Update</button>\n      #   </form>\n      #\n      # @example Overriding values\n      #   <%= form_for(\"/songs\", values: {song: {title: \"Envision\"}}) do |f| %>\n      #     <%= f.text_field \"song.title\" %>\n      #     <%= f.submit \"Create\" %>\n      #   <%= end %>\n      #\n      #   =>\n      #   <form action=\"/songs\" accept-charset=\"utf-8\" method=\"POST\">\n      #     <input type=\"hidden\" name=\"_csrf_token\" value=\"920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d\">\n      #     <input type=\"text\" name=\"song[title]\" id=\"song-title\" value=\"Envision\">\n      #\n      #     <button type=\"submit\">Create</button>\n      #   </form>\n      #\n      # @api public\n      # @since 2.1.0\n      def form_for(base_name, url = nil, values: _form_for_values, params: _form_for_params, **attributes)\n        url, base_name = base_name, nil if url.nil?\n\n        values = Values.new(values: values, params: params, csrf_token: _form_csrf_token)\n\n        builder = FormBuilder.new(\n          base_name: base_name,\n          values: values,\n          inflector: _context.inflector,\n          form_attributes: attributes\n        )\n\n        content = (block_given? ? yield(builder) : \"\").html_safe\n\n        builder.call(content, action: url, **attributes)\n      end\n\n      # Returns CSRF meta tags for use via unobtrusive JavaScript (UJS) libraries.\n      #\n      # @return [String, nil] the tags, if a CSRF token is available, or nil\n      #\n      # @example\n      #   csrf_meta_tags\n      #\n      #   =>\n      #   <meta name=\"csrf-param\" content=\"_csrf_token\">\n      #   <meta name=\"csrf-token\" content=\"4a038be85b7603c406dcbfad4b9cdf91ec6ca138ed6441163a07bb0fdfbe25b5\">\n      #\n      # @api public\n      # @since 2.1.0\n      def csrf_meta_tags\n        return unless (token = _form_csrf_token)\n\n        tag.meta(name: \"csrf-param\", content: CSRF_TOKEN) +\n          tag.meta(name: \"csrf-token\", content: token)\n      end\n\n      # @api private\n      # @since 2.1.0\n      def _form_for_values\n        if respond_to?(:_locals) # Scope\n          _locals\n        elsif respond_to?(:_name) # Part\n          {_name => self}\n        else\n          {}\n        end\n      end\n\n      # @api private\n      # @since 2.1.0\n      def _form_for_params\n        _context.request.params\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _form_csrf_token\n        return unless _context.request.session_enabled?\n\n        _context.csrf_token\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "form_for", "signature": "def form_for(base_name, url = nil, values: _form_for_values, params: _form_for_params, **attributes)", "start_line": 149, "end_line": 164}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 641}
{"function_name": "javascript_tag", "file_path": "hanami/lib/hanami/helpers/assets_helper.rb", "focal_code": "def javascript_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :src }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            src: _typed_url(source, JAVASCRIPT_EXT),\n            type: JAVASCRIPT_MIME_TYPE,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, JAVASCRIPT_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.script(**attributes).to_s\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"uri\"\nrequire \"hanami/view\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Helpers\n    # HTML assets helpers\n    #\n    # Inject these helpers in a view\n    #\n    # @since 2.1.0\n    #\n    # @see http://www.rubydoc.info/gems/hanami-helpers/Hanami/Helpers/HtmlHelper\n    module AssetsHelper\n      # @since 2.1.0\n      # @api private\n      NEW_LINE_SEPARATOR = \"\\n\"\n\n      # @since 2.1.0\n      # @api private\n      WILDCARD_EXT = \".*\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_EXT = \".js\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_EXT = \".css\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_MIME_TYPE = \"text/javascript\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_MIME_TYPE = \"text/css\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_MIME_TYPE = \"image/x-icon\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_REL = \"stylesheet\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_REL = \"shortcut icon\"\n\n      # @since 2.1.0\n      # @api private\n      DEFAULT_FAVICON = \"favicon.ico\"\n\n      # @since 0.3.0\n      # @api private\n      CROSSORIGIN_ANONYMOUS = \"anonymous\"\n\n      # @since 0.3.0\n      # @api private\n      # TODO: we can drop the defined?-check and fallback once Ruby 3.3 becomes our minimum required version\n      ABSOLUTE_URL_MATCHER = (\n        defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER\n      ).make_regexp\n\n      # @since 1.1.0\n      # @api private\n      QUERY_STRING_MATCHER = /\\?/\n\n      include Hanami::View::Helpers::TagHelper\n\n      # Generate `script` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. jQuery CDN).\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hash value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the javascript file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #\n      # @example Multiple Assets\n      #\n      #   <%= javascript_tag \"application\", \"dashboard\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #   # <script src=\"/assets/dashboard.js\" type=\"text/javascript\"></script>\n      #\n      # @example Asynchronous Execution\n      #\n      #   <%= javascript_tag \"application\", async: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" async=\"async\"></script>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Scripts\n      #\n      #   <%= javascript_tag \"https://example.com/assets/example.js\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <script src=\"https://example.com/assets/example.js\" type=\"text/javascript\"\n      #   #         integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Deferred Execution\n      #\n      #   <%= javascript_tag \"application\", defer: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" defer=\"defer\"></script>\n      #\n      # @example Disable nonce\n      #\n      #   <%= javascript_tag \"application\", nonce: false %>\n      #\n      # @example Absolute URL\n      #\n      #   <%= javascript_tag \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # <script src=\"https://code.jquery.com/jquery-2.1.4.min.js\" type=\"text/javascript\"></script>\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\" type=\"text/javascript\"></script>\n      #\n      # @example CDN Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\"></script>\n      def javascript_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :src }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            src: _typed_url(source, JAVASCRIPT_EXT),\n            type: JAVASCRIPT_MIME_TYPE,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, JAVASCRIPT_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.script(**attributes).to_s\n        end\n      end\n\n      # Generate `link` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hashed value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the stylesheet file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Multiple Assets\n      #\n      #   <%= stylesheet_tag \"application\", \"dashboard\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #   # <link href=\"/assets/dashboard.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Disable nonce\n      #\n      #   <%= stylesheet_tag \"application\", nonce: false %>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Assets\n      #\n      #   <%= stylesheet_tag \"https://example.com/assets/example.css\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <link href=\"https://example.com/assets/example.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Absolute URL\n      #\n      #   <%= stylesheet_tag \"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\" %>\n      #\n      #   # <link href=\"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      def stylesheet_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :href }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            href: _typed_url(source, STYLESHEET_EXT),\n            type: STYLESHEET_MIME_TYPE,\n            rel: STYLESHEET_REL,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, STYLESHEET_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.link(**attributes).to_s\n        end\n      end\n\n      # Generate `img` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # `alt` Attribute is auto generated from `src`.\n      # You can specify a different value, by passing the `:src` option.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL, or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the image file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\">\n      #\n      # @example Custom alt Attribute\n      #\n      #   <%= image_tag \"logo.png\", alt: \"Application Logo\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Application Logo\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= image_tag \"logo.png\", id: \"logo\", class: \"image\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\" id=\"logo\" class=\"image\">\n      #\n      # @example Absolute URL\n      #\n      #   <%= image_tag \"https://example-cdn.com/images/logo.png\" %>\n      #\n      #   # <img src=\"https://example-cdn.com/images/logo.png\" alt=\"Logo\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      def image_tag(source, options = {})\n        options = options.reject { |k, _| k.to_sym == :src }\n        attributes = {\n          src: asset_url(source),\n          alt: _context.inflector.humanize(::File.basename(source, WILDCARD_EXT))\n        }\n        attributes.merge!(options)\n\n        tag.img(**attributes)\n      end\n\n      # Generate `link` tag application favicon.\n      #\n      # If no argument is given, it assumes `favico.ico` from the application.\n      #\n      # It accepts one string representing the name of the asset.\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted version\n      # of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the favicon is file missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom Path\n      #\n      #   <%= favicon_tag \"fav.ico\" %>\n      #\n      #   # <link href=\"/assets/fav.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= favicon_tag \"favicon.ico\", id: \"fav\" %>\n      #\n      #   # <link id=\"fav\" href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\"\n      #           rel=\"shortcut icon\" type=\"image/x-icon\">\n      def favicon_tag(source = DEFAULT_FAVICON, options = {})\n        options = options.reject { |k, _| k.to_sym == :href }\n\n        attributes = {\n          href: asset_url(source),\n          rel: FAVICON_REL,\n          type: FAVICON_MIME_TYPE\n        }\n        attributes.merge!(options)\n\n        tag.link(**attributes)\n      end\n\n      # Generate `video` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the video file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie.mp4\"></video>\n      #\n      # @example Absolute URL\n      #\n      #   <%= video_tag \"https://example-cdn.com/assets/movie.mp4\" %>\n      #\n      #   # <video src=\"https://example-cdn.com/assets/movie.mp4\"></video>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= video_tag(\"movie.mp4\", autoplay: true, controls: true) %>\n      #\n      #   # <video src=\"/assets/movie.mp4\" autoplay=\"autoplay\" controls=\"controls\"></video>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       \"Your browser does not support the video tag\"\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #  Your browser does not support the video tag\n      #   # </video>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"movie.en.vtt\"),\n      #             srclang: \"en\", label: \"English\")\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #   <track kind=\"captions\" src=\"/assets/movie.en.vtt\" srclang=\"en\" label=\"English\">\n      #   # </video>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= video_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= video_tag(content: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      #\n      # @example CDN Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      def video_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.video(**options, &blk)\n      end\n\n      # Generate `audio` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the audio file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song.ogg\"></audio>\n      #\n      # @example Absolute URL\n      #\n      #   <%= audio_tag \"https://example-cdn.com/assets/song.ogg\" %>\n      #\n      #   # <audio src=\"https://example-cdn.com/assets/song.ogg\"></audio>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= audio_tag(\"song.ogg\", autoplay: true, controls: true) %>\n      #\n      #   # <audio src=\"/assets/song.ogg\" autoplay=\"autoplay\" controls=\"controls\"></audio>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       \"Your browser does not support the audio tag\"\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #  Your browser does not support the audio tag\n      #   # </audio>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"song.pt-BR.vtt\"),\n      #             srclang: \"pt-BR\", label: \"Portuguese\")\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #   <track kind=\"captions\" src=\"/assets/song.pt-BR.vtt\" srclang=\"pt-BR\" label=\"Portuguese\">\n      #   # </audio>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= audio_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= audio_tag(controls: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      #\n      # @example CDN Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      def audio_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.audio(**options, &blk)\n      end\n\n      # It generates the relative or absolute URL for the given asset.\n      # It automatically decides if it has to use the relative or absolute\n      # depending on the configuration and current environment.\n      #\n      # Absolute URLs are returned as they are.\n      #\n      # It can be the name of the asset, coming from the sources or third party\n      # gems.\n      #\n      # If Fingerprint mode is on, it returns the fingerprinted path of the source\n      #\n      # If CDN mode is on, it returns the absolute URL of the asset.\n      #\n      # @param source [String, #url] the asset name or asset object\n      #\n      # @return [String] the asset path\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the asset is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @example Basic Usage\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Alias\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Absolute URL\n      #\n      #   <%= asset_url \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # \"https://code.jquery.com/jquery-2.1.4.min.js\"\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #\n      # @example CDN Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      def asset_url(source)\n        return source.url if source.respond_to?(:url)\n        return source if _absolute_url?(source)\n\n        _context.assets[source].url\n      end\n\n      # Random per request nonce value for Content Security Policy (CSP) rules.\n      #\n      # If the `Hanami::Middleware::ContentSecurityPolicyNonce` middleware is\n      # in use, this helper returns the nonce value for the current request\n      # or `nil` otherwise.\n      #\n      # For this policy to work in the browser, you have to add the `'nonce'`\n      # placeholder to the script and/or style source policy rule. It will be\n      # substituted by the current nonce value like `'nonce-A12OggyZ'.\n      #\n      # @return [String, nil] nonce value of the current request\n      #\n      # @since 2.3.0\n      #\n      # @example App configuration\n      #\n      #   config.middleware.use Hanami::Middleware::ContentSecurityPolicyNonce\n      #   config.actions.content_security_policy[:script_src] = \"'self' 'nonce'\"\n      #   config.actions.content_security_policy[:style_src] = \"'self' 'nonce'\"\n      #\n      # @example View helper\n      #\n      #   <script nonce=\"<%= content_security_policy_nonce %>\">\n      def content_security_policy_nonce\n        return unless _context.request?\n\n        _context.request.env[CONTENT_SECURITY_POLICY_NONCE_REQUEST_KEY]\n      end\n\n      private\n\n      # @since 2.1.0\n      # @api private\n      def _safe_tags(*sources, &blk)\n        ::Hanami::View::HTML::SafeString.new(\n          sources.map(&blk).join(NEW_LINE_SEPARATOR)\n        )\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _typed_url(source, ext)\n        source = \"#{source}#{ext}\" if source.is_a?(String) && _append_extension?(source, ext)\n        asset_url(source)\n      end\n\n      # @api private\n      def _subresource_integrity_value(source, ext)\n        return if _absolute_url?(source)\n\n        source = \"#{source}#{ext}\" unless /#{Regexp.escape(ext)}\\z/.match?(source)\n        _context.assets[source].sri\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _absolute_url?(source)\n        ABSOLUTE_URL_MATCHER.match?(source.respond_to?(:url) ? source.url : source)\n      end\n\n      # @since 1.2.0\n      # @api private\n      def _crossorigin?(source)\n        return false unless _absolute_url?(source)\n\n        _context.assets.crossorigin?(source)\n      end\n\n      # @since 2.3.0\n      # @api private\n      def _nonce(source, nonce_option)\n        if nonce_option == false\n          nil\n        elsif nonce_option == true || (nonce_option.nil? && !_absolute_url?(source))\n          content_security_policy_nonce\n        else\n          nonce_option\n        end\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _source_options(src, options, &blk)\n        options ||= {}\n\n        if src.respond_to?(:to_hash)\n          options = src.to_hash\n        elsif src\n          options[:src] = asset_url(src)\n        end\n\n        if !options[:src] && !blk\n          raise ArgumentError.new(\"You should provide a source via `src` option or with a `source` HTML tag\")\n        end\n\n        options\n      end\n\n      # @since 1.1.0\n      # @api private\n      def _append_extension?(source, ext)\n        source !~ QUERY_STRING_MATCHER && source !~ /#{Regexp.escape(ext)}\\z/\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "javascript_tag", "signature": "def javascript_tag(*sources, **options)", "start_line": 168, "end_line": 187}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 642}
{"function_name": "stylesheet_tag", "file_path": "hanami/lib/hanami/helpers/assets_helper.rb", "focal_code": "def stylesheet_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :href }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            href: _typed_url(source, STYLESHEET_EXT),\n            type: STYLESHEET_MIME_TYPE,\n            rel: STYLESHEET_REL,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, STYLESHEET_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.link(**attributes).to_s\n        end\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"uri\"\nrequire \"hanami/view\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Helpers\n    # HTML assets helpers\n    #\n    # Inject these helpers in a view\n    #\n    # @since 2.1.0\n    #\n    # @see http://www.rubydoc.info/gems/hanami-helpers/Hanami/Helpers/HtmlHelper\n    module AssetsHelper\n      # @since 2.1.0\n      # @api private\n      NEW_LINE_SEPARATOR = \"\\n\"\n\n      # @since 2.1.0\n      # @api private\n      WILDCARD_EXT = \".*\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_EXT = \".js\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_EXT = \".css\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_MIME_TYPE = \"text/javascript\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_MIME_TYPE = \"text/css\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_MIME_TYPE = \"image/x-icon\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_REL = \"stylesheet\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_REL = \"shortcut icon\"\n\n      # @since 2.1.0\n      # @api private\n      DEFAULT_FAVICON = \"favicon.ico\"\n\n      # @since 0.3.0\n      # @api private\n      CROSSORIGIN_ANONYMOUS = \"anonymous\"\n\n      # @since 0.3.0\n      # @api private\n      # TODO: we can drop the defined?-check and fallback once Ruby 3.3 becomes our minimum required version\n      ABSOLUTE_URL_MATCHER = (\n        defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER\n      ).make_regexp\n\n      # @since 1.1.0\n      # @api private\n      QUERY_STRING_MATCHER = /\\?/\n\n      include Hanami::View::Helpers::TagHelper\n\n      # Generate `script` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. jQuery CDN).\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hash value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the javascript file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #\n      # @example Multiple Assets\n      #\n      #   <%= javascript_tag \"application\", \"dashboard\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #   # <script src=\"/assets/dashboard.js\" type=\"text/javascript\"></script>\n      #\n      # @example Asynchronous Execution\n      #\n      #   <%= javascript_tag \"application\", async: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" async=\"async\"></script>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Scripts\n      #\n      #   <%= javascript_tag \"https://example.com/assets/example.js\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <script src=\"https://example.com/assets/example.js\" type=\"text/javascript\"\n      #   #         integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Deferred Execution\n      #\n      #   <%= javascript_tag \"application\", defer: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" defer=\"defer\"></script>\n      #\n      # @example Disable nonce\n      #\n      #   <%= javascript_tag \"application\", nonce: false %>\n      #\n      # @example Absolute URL\n      #\n      #   <%= javascript_tag \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # <script src=\"https://code.jquery.com/jquery-2.1.4.min.js\" type=\"text/javascript\"></script>\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\" type=\"text/javascript\"></script>\n      #\n      # @example CDN Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\"></script>\n      def javascript_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :src }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            src: _typed_url(source, JAVASCRIPT_EXT),\n            type: JAVASCRIPT_MIME_TYPE,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, JAVASCRIPT_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.script(**attributes).to_s\n        end\n      end\n\n      # Generate `link` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hashed value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the stylesheet file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Multiple Assets\n      #\n      #   <%= stylesheet_tag \"application\", \"dashboard\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #   # <link href=\"/assets/dashboard.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Disable nonce\n      #\n      #   <%= stylesheet_tag \"application\", nonce: false %>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Assets\n      #\n      #   <%= stylesheet_tag \"https://example.com/assets/example.css\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <link href=\"https://example.com/assets/example.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Absolute URL\n      #\n      #   <%= stylesheet_tag \"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\" %>\n      #\n      #   # <link href=\"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      def stylesheet_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :href }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            href: _typed_url(source, STYLESHEET_EXT),\n            type: STYLESHEET_MIME_TYPE,\n            rel: STYLESHEET_REL,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, STYLESHEET_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.link(**attributes).to_s\n        end\n      end\n\n      # Generate `img` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # `alt` Attribute is auto generated from `src`.\n      # You can specify a different value, by passing the `:src` option.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL, or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the image file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\">\n      #\n      # @example Custom alt Attribute\n      #\n      #   <%= image_tag \"logo.png\", alt: \"Application Logo\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Application Logo\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= image_tag \"logo.png\", id: \"logo\", class: \"image\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\" id=\"logo\" class=\"image\">\n      #\n      # @example Absolute URL\n      #\n      #   <%= image_tag \"https://example-cdn.com/images/logo.png\" %>\n      #\n      #   # <img src=\"https://example-cdn.com/images/logo.png\" alt=\"Logo\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      def image_tag(source, options = {})\n        options = options.reject { |k, _| k.to_sym == :src }\n        attributes = {\n          src: asset_url(source),\n          alt: _context.inflector.humanize(::File.basename(source, WILDCARD_EXT))\n        }\n        attributes.merge!(options)\n\n        tag.img(**attributes)\n      end\n\n      # Generate `link` tag application favicon.\n      #\n      # If no argument is given, it assumes `favico.ico` from the application.\n      #\n      # It accepts one string representing the name of the asset.\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted version\n      # of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the favicon is file missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom Path\n      #\n      #   <%= favicon_tag \"fav.ico\" %>\n      #\n      #   # <link href=\"/assets/fav.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= favicon_tag \"favicon.ico\", id: \"fav\" %>\n      #\n      #   # <link id=\"fav\" href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\"\n      #           rel=\"shortcut icon\" type=\"image/x-icon\">\n      def favicon_tag(source = DEFAULT_FAVICON, options = {})\n        options = options.reject { |k, _| k.to_sym == :href }\n\n        attributes = {\n          href: asset_url(source),\n          rel: FAVICON_REL,\n          type: FAVICON_MIME_TYPE\n        }\n        attributes.merge!(options)\n\n        tag.link(**attributes)\n      end\n\n      # Generate `video` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the video file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie.mp4\"></video>\n      #\n      # @example Absolute URL\n      #\n      #   <%= video_tag \"https://example-cdn.com/assets/movie.mp4\" %>\n      #\n      #   # <video src=\"https://example-cdn.com/assets/movie.mp4\"></video>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= video_tag(\"movie.mp4\", autoplay: true, controls: true) %>\n      #\n      #   # <video src=\"/assets/movie.mp4\" autoplay=\"autoplay\" controls=\"controls\"></video>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       \"Your browser does not support the video tag\"\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #  Your browser does not support the video tag\n      #   # </video>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"movie.en.vtt\"),\n      #             srclang: \"en\", label: \"English\")\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #   <track kind=\"captions\" src=\"/assets/movie.en.vtt\" srclang=\"en\" label=\"English\">\n      #   # </video>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= video_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= video_tag(content: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      #\n      # @example CDN Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      def video_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.video(**options, &blk)\n      end\n\n      # Generate `audio` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the audio file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song.ogg\"></audio>\n      #\n      # @example Absolute URL\n      #\n      #   <%= audio_tag \"https://example-cdn.com/assets/song.ogg\" %>\n      #\n      #   # <audio src=\"https://example-cdn.com/assets/song.ogg\"></audio>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= audio_tag(\"song.ogg\", autoplay: true, controls: true) %>\n      #\n      #   # <audio src=\"/assets/song.ogg\" autoplay=\"autoplay\" controls=\"controls\"></audio>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       \"Your browser does not support the audio tag\"\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #  Your browser does not support the audio tag\n      #   # </audio>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"song.pt-BR.vtt\"),\n      #             srclang: \"pt-BR\", label: \"Portuguese\")\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #   <track kind=\"captions\" src=\"/assets/song.pt-BR.vtt\" srclang=\"pt-BR\" label=\"Portuguese\">\n      #   # </audio>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= audio_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= audio_tag(controls: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      #\n      # @example CDN Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      def audio_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.audio(**options, &blk)\n      end\n\n      # It generates the relative or absolute URL for the given asset.\n      # It automatically decides if it has to use the relative or absolute\n      # depending on the configuration and current environment.\n      #\n      # Absolute URLs are returned as they are.\n      #\n      # It can be the name of the asset, coming from the sources or third party\n      # gems.\n      #\n      # If Fingerprint mode is on, it returns the fingerprinted path of the source\n      #\n      # If CDN mode is on, it returns the absolute URL of the asset.\n      #\n      # @param source [String, #url] the asset name or asset object\n      #\n      # @return [String] the asset path\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the asset is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @example Basic Usage\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Alias\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Absolute URL\n      #\n      #   <%= asset_url \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # \"https://code.jquery.com/jquery-2.1.4.min.js\"\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #\n      # @example CDN Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      def asset_url(source)\n        return source.url if source.respond_to?(:url)\n        return source if _absolute_url?(source)\n\n        _context.assets[source].url\n      end\n\n      # Random per request nonce value for Content Security Policy (CSP) rules.\n      #\n      # If the `Hanami::Middleware::ContentSecurityPolicyNonce` middleware is\n      # in use, this helper returns the nonce value for the current request\n      # or `nil` otherwise.\n      #\n      # For this policy to work in the browser, you have to add the `'nonce'`\n      # placeholder to the script and/or style source policy rule. It will be\n      # substituted by the current nonce value like `'nonce-A12OggyZ'.\n      #\n      # @return [String, nil] nonce value of the current request\n      #\n      # @since 2.3.0\n      #\n      # @example App configuration\n      #\n      #   config.middleware.use Hanami::Middleware::ContentSecurityPolicyNonce\n      #   config.actions.content_security_policy[:script_src] = \"'self' 'nonce'\"\n      #   config.actions.content_security_policy[:style_src] = \"'self' 'nonce'\"\n      #\n      # @example View helper\n      #\n      #   <script nonce=\"<%= content_security_policy_nonce %>\">\n      def content_security_policy_nonce\n        return unless _context.request?\n\n        _context.request.env[CONTENT_SECURITY_POLICY_NONCE_REQUEST_KEY]\n      end\n\n      private\n\n      # @since 2.1.0\n      # @api private\n      def _safe_tags(*sources, &blk)\n        ::Hanami::View::HTML::SafeString.new(\n          sources.map(&blk).join(NEW_LINE_SEPARATOR)\n        )\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _typed_url(source, ext)\n        source = \"#{source}#{ext}\" if source.is_a?(String) && _append_extension?(source, ext)\n        asset_url(source)\n      end\n\n      # @api private\n      def _subresource_integrity_value(source, ext)\n        return if _absolute_url?(source)\n\n        source = \"#{source}#{ext}\" unless /#{Regexp.escape(ext)}\\z/.match?(source)\n        _context.assets[source].sri\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _absolute_url?(source)\n        ABSOLUTE_URL_MATCHER.match?(source.respond_to?(:url) ? source.url : source)\n      end\n\n      # @since 1.2.0\n      # @api private\n      def _crossorigin?(source)\n        return false unless _absolute_url?(source)\n\n        _context.assets.crossorigin?(source)\n      end\n\n      # @since 2.3.0\n      # @api private\n      def _nonce(source, nonce_option)\n        if nonce_option == false\n          nil\n        elsif nonce_option == true || (nonce_option.nil? && !_absolute_url?(source))\n          content_security_policy_nonce\n        else\n          nonce_option\n        end\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _source_options(src, options, &blk)\n        options ||= {}\n\n        if src.respond_to?(:to_hash)\n          options = src.to_hash\n        elsif src\n          options[:src] = asset_url(src)\n        end\n\n        if !options[:src] && !blk\n          raise ArgumentError.new(\"You should provide a source via `src` option or with a `source` HTML tag\")\n        end\n\n        options\n      end\n\n      # @since 1.1.0\n      # @api private\n      def _append_extension?(source, ext)\n        source !~ QUERY_STRING_MATCHER && source !~ /#{Regexp.escape(ext)}\\z/\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "stylesheet_tag", "signature": "def stylesheet_tag(*sources, **options)", "start_line": 272, "end_line": 292}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 643}
{"function_name": "favicon_tag", "file_path": "hanami/lib/hanami/helpers/assets_helper.rb", "focal_code": "def favicon_tag(source = DEFAULT_FAVICON, options = {})\n        options = options.reject { |k, _| k.to_sym == :href }\n\n        attributes = {\n          href: asset_url(source),\n          rel: FAVICON_REL,\n          type: FAVICON_MIME_TYPE\n        }\n        attributes.merge!(options)\n\n        tag.link(**attributes)\n      end", "file_content": "# frozen_string_literal: true\n\nrequire \"uri\"\nrequire \"hanami/view\"\nrequire_relative \"../constants\"\n\nmodule Hanami\n  module Helpers\n    # HTML assets helpers\n    #\n    # Inject these helpers in a view\n    #\n    # @since 2.1.0\n    #\n    # @see http://www.rubydoc.info/gems/hanami-helpers/Hanami/Helpers/HtmlHelper\n    module AssetsHelper\n      # @since 2.1.0\n      # @api private\n      NEW_LINE_SEPARATOR = \"\\n\"\n\n      # @since 2.1.0\n      # @api private\n      WILDCARD_EXT = \".*\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_EXT = \".js\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_EXT = \".css\"\n\n      # @since 2.1.0\n      # @api private\n      JAVASCRIPT_MIME_TYPE = \"text/javascript\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_MIME_TYPE = \"text/css\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_MIME_TYPE = \"image/x-icon\"\n\n      # @since 2.1.0\n      # @api private\n      STYLESHEET_REL = \"stylesheet\"\n\n      # @since 2.1.0\n      # @api private\n      FAVICON_REL = \"shortcut icon\"\n\n      # @since 2.1.0\n      # @api private\n      DEFAULT_FAVICON = \"favicon.ico\"\n\n      # @since 0.3.0\n      # @api private\n      CROSSORIGIN_ANONYMOUS = \"anonymous\"\n\n      # @since 0.3.0\n      # @api private\n      # TODO: we can drop the defined?-check and fallback once Ruby 3.3 becomes our minimum required version\n      ABSOLUTE_URL_MATCHER = (\n        defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER\n      ).make_regexp\n\n      # @since 1.1.0\n      # @api private\n      QUERY_STRING_MATCHER = /\\?/\n\n      include Hanami::View::Helpers::TagHelper\n\n      # Generate `script` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. jQuery CDN).\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hash value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the javascript file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #\n      # @example Multiple Assets\n      #\n      #   <%= javascript_tag \"application\", \"dashboard\" %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n      #   # <script src=\"/assets/dashboard.js\" type=\"text/javascript\"></script>\n      #\n      # @example Asynchronous Execution\n      #\n      #   <%= javascript_tag \"application\", async: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" async=\"async\"></script>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Scripts\n      #\n      #   <%= javascript_tag \"https://example.com/assets/example.js\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <script src=\"https://example.com/assets/example.js\" type=\"text/javascript\"\n      #   #         integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Deferred Execution\n      #\n      #   <%= javascript_tag \"application\", defer: true %>\n      #\n      #   # <script src=\"/assets/application.js\" type=\"text/javascript\" defer=\"defer\"></script>\n      #\n      # @example Disable nonce\n      #\n      #   <%= javascript_tag \"application\", nonce: false %>\n      #\n      # @example Absolute URL\n      #\n      #   <%= javascript_tag \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # <script src=\"https://code.jquery.com/jquery-2.1.4.min.js\" type=\"text/javascript\"></script>\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\" type=\"text/javascript\"></script>\n      #\n      # @example CDN Mode\n      #\n      #   <%= javascript_tag \"application\" %>\n      #\n      #   # <script src=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #   #         type=\"text/javascript\"></script>\n      def javascript_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :src }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            src: _typed_url(source, JAVASCRIPT_EXT),\n            type: JAVASCRIPT_MIME_TYPE,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, JAVASCRIPT_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.script(**attributes).to_s\n        end\n      end\n\n      # Generate `link` tag for given source(s)\n      #\n      # It accepts one or more strings representing the name of the asset, if it\n      # comes from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # If the \"subresource integrity mode\" is on, `integrity` is the\n      # name of the algorithm, then a hyphen, then the hashed value of the file.\n      # If more than one algorithm is used, they\"ll be separated by a space.\n      #\n      # If the Content Security Policy uses 'nonce' and the source is not\n      # absolute, the nonce value of the current request is automatically added\n      # as an attribute. You can override this with the `nonce: false` option.\n      # See {#content_security_policy_nonce} for more.\n      #\n      # @param sources [Array<String, #url>] one or more assets by name or absolute URL\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the stylesheet file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Single Asset\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Multiple Assets\n      #\n      #   <%= stylesheet_tag \"application\", \"dashboard\" %>\n      #\n      #   # <link href=\"/assets/application.css\" type=\"text/css\" rel=\"stylesheet\">\n      #   # <link href=\"/assets/dashboard.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Disable nonce\n      #\n      #   <%= stylesheet_tag \"application\", nonce: false %>\n      #\n      # @example Subresource Integrity\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Subresource Integrity for 3rd Party Assets\n      #\n      #   <%= stylesheet_tag \"https://example.com/assets/example.css\", integrity: \"sha384-oqVu...Y8wC\" %>\n      #\n      #   # <link href=\"https://example.com/assets/example.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\" integrity=\"sha384-oqVu...Y8wC\" crossorigin=\"anonymous\"></script>\n      #\n      # @example Absolute URL\n      #\n      #   <%= stylesheet_tag \"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\" %>\n      #\n      #   # <link href=\"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\" type=\"text/css\" rel=\"stylesheet\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= stylesheet_tag \"application\" %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css\"\n      #   #       type=\"text/css\" rel=\"stylesheet\">\n      def stylesheet_tag(*sources, **options)\n        options = options.reject { |k, _| k.to_sym == :href }\n        nonce_option = options.delete(:nonce)\n\n        _safe_tags(*sources) do |source|\n          attributes = {\n            href: _typed_url(source, STYLESHEET_EXT),\n            type: STYLESHEET_MIME_TYPE,\n            rel: STYLESHEET_REL,\n            nonce: _nonce(source, nonce_option)\n          }\n          attributes.merge!(options)\n\n          if _context.assets.subresource_integrity? || attributes.include?(:integrity)\n            attributes[:integrity] ||= _subresource_integrity_value(source, STYLESHEET_EXT)\n            attributes[:crossorigin] ||= CROSSORIGIN_ANONYMOUS\n          end\n\n          tag.link(**attributes).to_s\n        end\n      end\n\n      # Generate `img` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # `alt` Attribute is auto generated from `src`.\n      # You can specify a different value, by passing the `:src` option.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL, or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the image file is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\">\n      #\n      # @example Custom alt Attribute\n      #\n      #   <%= image_tag \"logo.png\", alt: \"Application Logo\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Application Logo\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= image_tag \"logo.png\", id: \"logo\", class: \"image\" %>\n      #\n      #   # <img src=\"/assets/logo.png\" alt=\"Logo\" id=\"logo\" class=\"image\">\n      #\n      # @example Absolute URL\n      #\n      #   <%= image_tag \"https://example-cdn.com/images/logo.png\" %>\n      #\n      #   # <img src=\"https://example-cdn.com/images/logo.png\" alt=\"Logo\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= image_tag \"logo.png\" %>\n      #\n      #   # <img src=\"https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png\" alt=\"Logo\">\n      def image_tag(source, options = {})\n        options = options.reject { |k, _| k.to_sym == :src }\n        attributes = {\n          src: asset_url(source),\n          alt: _context.inflector.humanize(::File.basename(source, WILDCARD_EXT))\n        }\n        attributes.merge!(options)\n\n        tag.img(**attributes)\n      end\n\n      # Generate `link` tag application favicon.\n      #\n      # If no argument is given, it assumes `favico.ico` from the application.\n      #\n      # It accepts one string representing the name of the asset.\n      #\n      # If the \"fingerprint mode\" is on, `href` is the fingerprinted version\n      # of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `href` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the favicon is file missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom Path\n      #\n      #   <%= favicon_tag \"fav.ico\" %>\n      #\n      #   # <link href=\"/assets/fav.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= favicon_tag \"favicon.ico\", id: \"fav\" %>\n      #\n      #   # <link id=\"fav\" href=\"/assets/favicon.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\" rel=\"shortcut icon\" type=\"image/x-icon\">\n      #\n      # @example CDN Mode\n      #\n      #   <%= favicon_tag %>\n      #\n      #   # <link href=\"https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico\"\n      #           rel=\"shortcut icon\" type=\"image/x-icon\">\n      def favicon_tag(source = DEFAULT_FAVICON, options = {})\n        options = options.reject { |k, _| k.to_sym == :href }\n\n        attributes = {\n          href: asset_url(source),\n          rel: FAVICON_REL,\n          type: FAVICON_MIME_TYPE\n        }\n        attributes.merge!(options)\n\n        tag.link(**attributes)\n      end\n\n      # Generate `video` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the video file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie.mp4\"></video>\n      #\n      # @example Absolute URL\n      #\n      #   <%= video_tag \"https://example-cdn.com/assets/movie.mp4\" %>\n      #\n      #   # <video src=\"https://example-cdn.com/assets/movie.mp4\"></video>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= video_tag(\"movie.mp4\", autoplay: true, controls: true) %>\n      #\n      #   # <video src=\"/assets/movie.mp4\" autoplay=\"autoplay\" controls=\"controls\"></video>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       \"Your browser does not support the video tag\"\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #  Your browser does not support the video tag\n      #   # </video>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     video(\"movie.mp4\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"movie.en.vtt\"),\n      #             srclang: \"en\", label: \"English\")\n      #     end\n      #   %>\n      #\n      #   # <video src=\"/assets/movie.mp4\">\n      #   #   <track kind=\"captions\" src=\"/assets/movie.en.vtt\" srclang=\"en\" label=\"English\">\n      #   # </video>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= video_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= video_tag(content: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      #\n      # @example CDN Mode\n      #\n      #   <%= video_tag \"movie.mp4\" %>\n      #\n      #   # <video src=\"https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4\"></video>\n      def video_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.video(**options, &blk)\n      end\n\n      # Generate `audio` tag for given source\n      #\n      # It accepts one string representing the name of the asset, if it comes\n      # from the application or third party gems. It also accepts strings\n      # representing absolute URLs in case of public CDN (eg. Bootstrap CDN).\n      #\n      # Alternatively, it accepts a block that allows to specify one or more\n      # sources via the `source` tag.\n      #\n      # If the \"fingerprint mode\" is on, `src` is the fingerprinted\n      # version of the relative URL.\n      #\n      # If the \"CDN mode\" is on, the `src` is an absolute URL of the\n      # application CDN.\n      #\n      # @param source [String, #url] asset name, absolute URL or asset object\n      # @param options [Hash] HTML 5 attributes\n      #\n      # @return [Hanami::View::HTML::SafeString] the markup\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the audio file is missing\n      # from the manifest\n      #\n      # @raise [ArgumentError] if source isn\"t specified both as argument or\n      #   tag inside the given block\n      #\n      # @since 2.1.0\n      #\n      # @see Hanami::Assets::Helpers#path\n      #\n      # @example Basic Usage\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song.ogg\"></audio>\n      #\n      # @example Absolute URL\n      #\n      #   <%= audio_tag \"https://example-cdn.com/assets/song.ogg\" %>\n      #\n      #   # <audio src=\"https://example-cdn.com/assets/song.ogg\"></audio>\n      #\n      # @example Custom HTML Attributes\n      #\n      #   <%= audio_tag(\"song.ogg\", autoplay: true, controls: true) %>\n      #\n      #   # <audio src=\"/assets/song.ogg\" autoplay=\"autoplay\" controls=\"controls\"></audio>\n      #\n      # @example Fallback Content\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       \"Your browser does not support the audio tag\"\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #  Your browser does not support the audio tag\n      #   # </audio>\n      #\n      # @example Tracks\n      #\n      #   <%=\n      #     audio(\"song.ogg\") do\n      #       tag.track(kind: \"captions\", src: asset_url(\"song.pt-BR.vtt\"),\n      #             srclang: \"pt-BR\", label: \"Portuguese\")\n      #     end\n      #   %>\n      #\n      #   # <audio src=\"/assets/song.ogg\">\n      #   #   <track kind=\"captions\" src=\"/assets/song.pt-BR.vtt\" srclang=\"pt-BR\" label=\"Portuguese\">\n      #   # </audio>\n      #\n      # @example Without Any Argument\n      #\n      #   <%= audio_tag %>\n      #\n      #   # ArgumentError\n      #\n      # @example Without src And Without Block\n      #\n      #   <%= audio_tag(controls: true) %>\n      #\n      #   # ArgumentError\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      #\n      # @example CDN Mode\n      #\n      #   <%= audio_tag \"song.ogg\" %>\n      #\n      #   # <audio src=\"https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg\"></audio>\n      def audio_tag(source = nil, options = {}, &blk)\n        options = _source_options(source, options, &blk)\n        tag.audio(**options, &blk)\n      end\n\n      # It generates the relative or absolute URL for the given asset.\n      # It automatically decides if it has to use the relative or absolute\n      # depending on the configuration and current environment.\n      #\n      # Absolute URLs are returned as they are.\n      #\n      # It can be the name of the asset, coming from the sources or third party\n      # gems.\n      #\n      # If Fingerprint mode is on, it returns the fingerprinted path of the source\n      #\n      # If CDN mode is on, it returns the absolute URL of the asset.\n      #\n      # @param source [String, #url] the asset name or asset object\n      #\n      # @return [String] the asset path\n      #\n      # @raise [Hanami::Assets::MissingManifestAssetError] if `fingerprint` or\n      # `subresource_integrity` modes are on and the asset is missing\n      # from the manifest\n      #\n      # @since 2.1.0\n      #\n      # @example Basic Usage\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Alias\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application.js\"\n      #\n      # @example Absolute URL\n      #\n      #   <%= asset_url \"https://code.jquery.com/jquery-2.1.4.min.js\" %>\n      #\n      #   # \"https://code.jquery.com/jquery-2.1.4.min.js\"\n      #\n      # @example Fingerprint Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      #\n      # @example CDN Mode\n      #\n      #   <%= asset_url \"application.js\" %>\n      #\n      #   # \"https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js\"\n      def asset_url(source)\n        return source.url if source.respond_to?(:url)\n        return source if _absolute_url?(source)\n\n        _context.assets[source].url\n      end\n\n      # Random per request nonce value for Content Security Policy (CSP) rules.\n      #\n      # If the `Hanami::Middleware::ContentSecurityPolicyNonce` middleware is\n      # in use, this helper returns the nonce value for the current request\n      # or `nil` otherwise.\n      #\n      # For this policy to work in the browser, you have to add the `'nonce'`\n      # placeholder to the script and/or style source policy rule. It will be\n      # substituted by the current nonce value like `'nonce-A12OggyZ'.\n      #\n      # @return [String, nil] nonce value of the current request\n      #\n      # @since 2.3.0\n      #\n      # @example App configuration\n      #\n      #   config.middleware.use Hanami::Middleware::ContentSecurityPolicyNonce\n      #   config.actions.content_security_policy[:script_src] = \"'self' 'nonce'\"\n      #   config.actions.content_security_policy[:style_src] = \"'self' 'nonce'\"\n      #\n      # @example View helper\n      #\n      #   <script nonce=\"<%= content_security_policy_nonce %>\">\n      def content_security_policy_nonce\n        return unless _context.request?\n\n        _context.request.env[CONTENT_SECURITY_POLICY_NONCE_REQUEST_KEY]\n      end\n\n      private\n\n      # @since 2.1.0\n      # @api private\n      def _safe_tags(*sources, &blk)\n        ::Hanami::View::HTML::SafeString.new(\n          sources.map(&blk).join(NEW_LINE_SEPARATOR)\n        )\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _typed_url(source, ext)\n        source = \"#{source}#{ext}\" if source.is_a?(String) && _append_extension?(source, ext)\n        asset_url(source)\n      end\n\n      # @api private\n      def _subresource_integrity_value(source, ext)\n        return if _absolute_url?(source)\n\n        source = \"#{source}#{ext}\" unless /#{Regexp.escape(ext)}\\z/.match?(source)\n        _context.assets[source].sri\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _absolute_url?(source)\n        ABSOLUTE_URL_MATCHER.match?(source.respond_to?(:url) ? source.url : source)\n      end\n\n      # @since 1.2.0\n      # @api private\n      def _crossorigin?(source)\n        return false unless _absolute_url?(source)\n\n        _context.assets.crossorigin?(source)\n      end\n\n      # @since 2.3.0\n      # @api private\n      def _nonce(source, nonce_option)\n        if nonce_option == false\n          nil\n        elsif nonce_option == true || (nonce_option.nil? && !_absolute_url?(source))\n          content_security_policy_nonce\n        else\n          nonce_option\n        end\n      end\n\n      # @since 2.1.0\n      # @api private\n      def _source_options(src, options, &blk)\n        options ||= {}\n\n        if src.respond_to?(:to_hash)\n          options = src.to_hash\n        elsif src\n          options[:src] = asset_url(src)\n        end\n\n        if !options[:src] && !blk\n          raise ArgumentError.new(\"You should provide a source via `src` option or with a `source` HTML tag\")\n        end\n\n        options\n      end\n\n      # @since 1.1.0\n      # @api private\n      def _append_extension?(source, ext)\n        source !~ QUERY_STRING_MATCHER && source !~ /#{Regexp.escape(ext)}\\z/\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "favicon_tag", "signature": "def favicon_tag(source = DEFAULT_FAVICON, options = {})", "start_line": 423, "end_line": 434}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 644}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/config/actions/content_security_policy.rb", "focal_code": "def initialize(&blk)\n          @policy = {\n            base_uri: \"'self'\",\n            child_src: \"'self'\",\n            connect_src: \"'self'\",\n            default_src: \"'none'\",\n            font_src: \"'self'\",\n            form_action: \"'self'\",\n            frame_ancestors: \"'self'\",\n            frame_src: \"'self'\",\n            img_src: \"'self' https: data:\",\n            media_src: \"'self'\",\n            object_src: \"'none'\",\n            script_src: \"'self'\",\n            style_src: \"'self' 'unsafe-inline' https:\"\n          }\n\n          blk&.(self)\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  class Config\n    class Actions\n      # Config for Content Security Policy in Hanami apps\n      #\n      # @since 2.0.0\n      class ContentSecurityPolicy\n        # @since 2.0.0\n        # @api private\n        def initialize(&blk)\n          @policy = {\n            base_uri: \"'self'\",\n            child_src: \"'self'\",\n            connect_src: \"'self'\",\n            default_src: \"'none'\",\n            font_src: \"'self'\",\n            form_action: \"'self'\",\n            frame_ancestors: \"'self'\",\n            frame_src: \"'self'\",\n            img_src: \"'self' https: data:\",\n            media_src: \"'self'\",\n            object_src: \"'none'\",\n            script_src: \"'self'\",\n            style_src: \"'self' 'unsafe-inline' https:\"\n          }\n\n          blk&.(self)\n        end\n\n        # @since 2.0.0\n        # @api private\n        def initialize_copy(original_object)\n          @policy = original_object.instance_variable_get(:@policy).dup\n          super\n        end\n\n        # Get a CSP setting\n        #\n        # @param key [Symbol] the underscored name of the CPS setting\n        # @return [String,NilClass] the CSP setting, if any\n        #\n        # @since 2.0.0\n        # @api public\n        #\n        # @example\n        #   module MyApp\n        #     class App < Hanami::App\n        #       config.actions.content_security_policy[:base_uri] # => \"'self'\"\n        #     end\n        #   end\n        def [](key)\n          @policy[key]\n        end\n\n        # Set a CSP setting\n        #\n        # @param key [Symbol] the underscored name of the CPS setting\n        # @param value [String] the CSP setting value\n        #\n        # @since 2.0.0\n        # @api public\n        #\n        # @example Replace a default value\n        #   module MyApp\n        #     class App < Hanami::App\n        #       config.actions.content_security_policy[:plugin_types] = nil\n        #     end\n        #   end\n        #\n        # @example Append to a default value\n        #   module MyApp\n        #     class App < Hanami::App\n        #       config.actions.content_security_policy[:script_src] += \" https://my.cdn.test\"\n        #     end\n        #   end\n        def []=(key, value)\n          @policy[key] = value\n        end\n\n        # Deletes a CSP key\n        #\n        # @param key [Symbol] the underscored name of the CPS setting\n        #\n        # @since 2.0.0\n        # @api public\n        #\n        # @example\n        #   module MyApp\n        #     class App < Hanami::App\n        #       config.actions.content_security_policy.delete(:object_src)\n        #     end\n        #   end\n        def delete(key)\n          @policy.delete(key)\n        end\n\n        # Returns true if 'nonce' is used in any of the policies.\n        #\n        # @return [Boolean]\n        #\n        # @api public\n        # @since 2.3.0\n        def nonce?\n          @policy.any? { _2.match?(/'nonce'/) }\n        end\n\n        # Returns an array of middleware name to support 'nonce' in\n        # policies, or an empty array if 'nonce' is not used.\n        #\n        # @return [Array<(Symbol, Array)>]\n        #\n        # @api public\n        # @since 2.3.0\n        def middleware\n          return [] unless nonce?\n\n          [Hanami::Middleware::ContentSecurityPolicyNonce]\n        end\n\n        # @since 2.0.0\n        # @api private\n        def to_s\n          @policy.map do |key, value|\n            \"#{dasherize(key)} #{value}\"\n          end.join(\";\")\n        end\n\n        private\n\n        # @since 2.0.0\n        # @api private\n        def dasherize(key)\n          key.to_s.gsub(\"_\", \"-\")\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize(&blk)", "start_line": 12, "end_line": 30}, "metadata": {"module": "Hanami", "class_name": "Config", "class_signature": "class Config"}, "task_id": 645}
{"function_name": "translate", "file_path": "hanami/lib/hanami/providers/i18n/backend.rb", "focal_code": "def translate(key, **options)\n          locale = options[:locale] || self.locale\n\n          result = catch(:exception) do\n            @backend.translate(locale, key, options)\n          end\n\n          # If translation is missing and fallbacks are configured, try fallback locales\n          if result.is_a?(::I18n::MissingTranslation) && @fallbacks && !options[:fallback]\n            fallback_locales = @fallbacks[locale] - [locale]\n            fallback_locales.each do |fallback_locale|\n              fallback_result = catch(:exception) do\n                @backend.translate(fallback_locale, key, options.merge(fallback: true))\n              end\n\n              unless fallback_result.is_a?(::I18n::MissingTranslation)\n                return fallback_result\n              end\n            end\n          end\n\n          if result.is_a?(::I18n::MissingTranslation)\n            if options[:raise]\n              raise ::I18n::MissingTranslationData.new(locale, key, options)\n            else\n              handle_missing_translation(result, options)\n            end\n          else\n            result\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Providers\n    class I18n < Hanami::Provider::Source\n      # A wrapper that provides a full `I18n`-like interface for an individual I18n backend. This\n      # allows each Hanami slice to have its own isolated I18n instance.\n      #\n      # Unlike the global I18n module which uses class variables for configuration,\n      # this wrapper maintains per-instance state for true isolation between slices.\n      #\n      # @api public\n      # @since x.x.x\n      class Backend\n        attr_reader :backend\n\n        # Returns the default locale.\n        #\n        # @return [Symbol] the default locale\n        #\n        # @api public\n        # @since x.x.x\n        attr_reader :default_locale\n\n        # Creates a new Backend instance.\n        #\n        # @param backend [I18n::Backend::Base] the underlying I18n backend\n        # @param locale [Symbol, String, nil] initial locale to set in thread-local storage\n        # @param default_locale [Symbol, String] the default locale to use when no locale is set\n        # @param available_locales [Array<Symbol, String>] list of available locales\n        # @param fallbacks [I18n::Locale::Fallbacks, nil] fallbacks configuration for missing translations\n        #\n        # @api private\n        # @since x.x.x\n        def initialize(backend, locale: nil, default_locale: :en, available_locales: [], fallbacks: nil)\n          @backend = backend\n          @default_locale = default_locale.to_sym\n          @available_locales = Array(available_locales).map(&:to_sym)\n          @fallbacks = fallbacks\n\n          # Set initial locale (if provided) in thread-local storage.\n          @storage_key = :\"hanami_i18n_#{object_id}\"\n          self.locale = locale if locale\n        end\n\n        # rubocop:disable Metrics/PerceivedComplexity\n\n        # Translates the given key.\n        #\n        # @param key [String, Symbol] the translation key to look up\n        # @param options [Hash] translation options\n        # @option options [Symbol, String] :locale the locale to use (defaults to current locale)\n        # @option options [String, Proc, Array] :default default value if translation is missing\n        # @option options [Hash] :scope additional scope for the key\n        # @option options [Integer] :count for pluralization\n        # @option options [Boolean] :raise whether to raise an exception for missing translations\n        #\n        # @return [String, Object] the translated string or default value\n        #\n        # @raise [I18n::MissingTranslationData] if translation is missing and :raise option is true\n        #\n        # @example Basic translation\n        #   translate(\"hello\") # => \"Hello\"\n        #\n        # @example Translation with interpolation\n        #   translate(\"greeting\", name: \"Alice\") # => \"Hello, Alice\"\n        #\n        # @example With explicit locale\n        #   translate(\"hello\", locale: :fr) # => \"Bonjour\"\n        #\n        # @api public\n        # @since x.x.x\n        def translate(key, **options)\n          locale = options[:locale] || self.locale\n\n          result = catch(:exception) do\n            @backend.translate(locale, key, options)\n          end\n\n          # If translation is missing and fallbacks are configured, try fallback locales\n          if result.is_a?(::I18n::MissingTranslation) && @fallbacks && !options[:fallback]\n            fallback_locales = @fallbacks[locale] - [locale]\n            fallback_locales.each do |fallback_locale|\n              fallback_result = catch(:exception) do\n                @backend.translate(fallback_locale, key, options.merge(fallback: true))\n              end\n\n              unless fallback_result.is_a?(::I18n::MissingTranslation)\n                return fallback_result\n              end\n            end\n          end\n\n          if result.is_a?(::I18n::MissingTranslation)\n            if options[:raise]\n              raise ::I18n::MissingTranslationData.new(locale, key, options)\n            else\n              handle_missing_translation(result, options)\n            end\n          else\n            result\n          end\n        end\n\n        # rubocop:enable Metrics/PerceivedComplexity\n\n        # @api public\n        # @since x.x.x\n        alias_method :t, :translate\n\n        # Translates the given key, raising an exception if translation is missing.\n        #\n        # @param key [String, Symbol] the translation key to look up\n        # @param options [Hash] translation options (see {#translate})\n        #\n        # @return [String, Object] the translated string\n        #\n        # @raise [I18n::MissingTranslationData] if translation is missing\n        #\n        # @example\n        #   t!(\"hello\") # => \"Hello\"\n        #   t!(\"missing.key\") # raises I18n::MissingTranslationData\n        #\n        # @api public\n        # @since x.x.x\n        def t!(key, **options)\n          translate(key, **options.merge(raise: true))\n        end\n\n        # Localizes the given object (e.g., date, time, number).\n        #\n        # @param object [Date, Time, DateTime, Numeric] the object to localize\n        # @param locale [Symbol, String, nil] the locale to use (defaults to current locale)\n        # @param format [Symbol, String, nil] the format to use for localization\n        # @param options [Hash] additional localization options\n        #\n        # @return [String] the localized string representation\n        #\n        # @example Localize a date\n        #   localize(Date.today, format: :long) # => \"January 19, 2026\"\n        #\n        # @example Localize with specific locale\n        #   localize(Date.today, locale: :fr, format: :long) # => \"19 janvier 2026\"\n        #\n        # @api public\n        # @since x.x.x\n        def localize(object, locale: nil, format: nil, **options)\n          locale ||= self.locale\n          @backend.localize(locale, object, format, options)\n        end\n\n        # @api public\n        # @since x.x.x\n        alias_method :l, :localize\n\n        # Returns true if a translation exists for the given key.\n        #\n        # @param key [String, Symbol] the translation key to check\n        # @param locale [Symbol, String, nil] the locale to check (defaults to current locale)\n        # @param options [Hash] additional options\n        #\n        # @return [Boolean] true if the translation exists, false otherwise\n        #\n        # @example\n        #   exists?(\"hello\") # => true\n        #   exists?(\"missing.key\") # => false\n        #\n        # @api public\n        # @since x.x.x\n        def exists?(key, locale: nil, **options)\n          locale ||= self.locale\n          @backend.exists?(locale, key, options)\n        end\n\n        # Transliterates the given string.\n        #\n        # @param key [String] the string to transliterate\n        # @param locale [Symbol, String, nil] the locale to use (defaults to current locale)\n        # @param replacement [String, nil] replacement string for non-transliteratable characters\n        # @param options [Hash] additional transliteration options\n        #\n        # @return [String] the transliterated string\n        #\n        # @example\n        #   transliterate(\"Ærøskøbing\") # => \"AEroskobing\"\n        #\n        # @api public\n        # @since x.x.x\n        def transliterate(key, locale: nil, replacement: nil, **options)\n          locale ||= self.locale\n          @backend.transliterate(locale, key, replacement)\n        end\n\n        # Returns available locales.\n        #\n        # If configured via `config.i18n.available_locales`, returns the configured locales.\n        # Otherwise, returns all locales detected from loaded translation files.\n        #\n        # @api public\n        # @since x.x.x\n        def available_locales\n          if @available_locales.any?\n            @available_locales\n          else\n            @backend.available_locales\n          end\n        end\n\n        # Reloads translations from translation files.\n        #\n        # @return [void]\n        #\n        # @api public\n        # @since x.x.x\n        def reload!\n          @backend.reload!\n        end\n\n        # Eager loads translations if the backend supports it.\n        #\n        # @return [void]\n        #\n        # @api public\n        # @since x.x.x\n        def eager_load!\n          @backend.eager_load! if @backend.respond_to?(:eager_load!)\n        end\n\n        # Returns the current locale from fiber/thread-local storage, or default_locale.\n        #\n        # This is thread-safe and works correctly with concurrent requests.\n        # Each backend instance maintains its own locale in thread storage.\n        #\n        # @return [Symbol] the current locale or default locale if none is set\n        #\n        # @example\n        #   locale # => :en\n        #   self.locale = :fr\n        #   locale # => :fr\n        #\n        # @api public\n        # @since x.x.x\n        def locale\n          Thread.current[@storage_key] || default_locale\n        end\n\n        # Sets the current locale in fiber/thread-local storage.\n        #\n        # This is thread-safe and works correctly with concurrent requests.\n        # Each backend instance maintains its own locale in thread storage.\n        #\n        # @param value [Symbol, String, nil] the locale to set (converted to symbol)\n        #\n        # @return [Symbol, nil] the locale value that was set\n        #\n        # @example\n        #   self.locale = :fr\n        #   self.locale = \"de\"\n        #   self.locale = nil # resets to default_locale\n        #\n        # @api public\n        # @since x.x.x\n        def locale=(value)\n          Thread.current[@storage_key] = value&.to_sym\n        end\n\n        # Executes a block with a temporary locale.\n        #\n        # This is useful for executing code with a specific locale without affecting\n        # other concurrent requests. The previous locale is restored even if the block raises.\n        #\n        # @param tmp_locale [Symbol, String, nil] the temporary locale to use\n        #\n        # @yieldreturn [Object] the return value of the block\n        #\n        # @return [Object] the return value of the block\n        #\n        # @example\n        #   with_locale(:fr) do\n        #     t(\"greeting\") # Uses French locale\n        #   end\n        #   # locale is restored to previous value\n        #\n        # @example Nested usage\n        #   with_locale(:fr) do\n        #     with_locale(:de) do\n        #       t(\"hello\") # Uses German\n        #     end\n        #     t(\"hello\") # Uses French\n        #   end\n        #\n        # @api public\n        # @since x.x.x\n        def with_locale(tmp_locale)\n          previous_locale = Thread.current[@storage_key]\n          Thread.current[@storage_key] = tmp_locale&.to_sym\n          yield\n        ensure\n          Thread.current[@storage_key] = previous_locale\n        end\n\n        private\n\n        def handle_missing_translation(missing_translation, options)\n          default = options[:default]\n          return default if default.is_a?(String)\n\n          key = missing_translation.key\n          key.to_s\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "translate", "signature": "def translate(key, **options)", "start_line": 73, "end_line": 103}, "metadata": {"module": "Hanami", "class_name": "I18n", "class_signature": "class I18n < < Hanami::Provider::Source"}, "task_id": 646}
{"function_name": "configure_extensions", "file_path": "hanami/lib/hanami/providers/db/sql_adapter.rb", "focal_code": "def configure_extensions(database_url)\n          return if skip_defaults?(:extensions)\n\n          # Extensions for all SQL databases\n          extension(\n            :caller_logging,\n            :error_sql,\n            :sql_comments\n          )\n\n          # Extensions for specific databases\n          if database_url.to_s.start_with?(%r{postgres(ql)*://})\n            extension(\n              :pg_array,\n              :pg_enum,\n              :pg_json,\n              :pg_range\n            )\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Providers\n    class DB < Hanami::Provider::Source\n      # @api public\n      # @since 2.2.0\n      class SQLAdapter < Adapter\n        # @api public\n        # @since 2.2.0\n        setting :extensions, mutable: true\n\n        # @api public\n        # @since 2.2.0\n        def extension(*extensions)\n          self.extensions.concat(extensions).uniq!\n        end\n\n        # @api public\n        # @since 2.2.0\n        def extensions\n          config.extensions ||= []\n        end\n\n        # @api private\n        def configure_from_adapter(other_adapter)\n          super\n\n          return if skip_defaults?\n\n          # As part of gateway configuration, every gateway will receive the \"any adapter\" here,\n          # which is a plain `Adapter`, not an `SQLAdapter`. Its configuration will have been merged\n          # by `super`, so no further work is required.\n          return unless other_adapter.is_a?(self.class)\n\n          extensions.concat(other_adapter.extensions).uniq! unless skip_defaults?(:extensions)\n        end\n\n        # @api private\n        def configure_for_database(database_url)\n          return if skip_defaults?\n\n          configure_plugins\n          configure_extensions(database_url)\n        end\n\n        # @api private\n        private def configure_plugins\n          return if skip_defaults?(:plugins)\n\n          # Configure the plugin via a frozen proc, so it can be properly uniq'ed when configured\n          # for multiple gateways. See `Hanami::Providers::DB::Config#each_plugin`.\n          plugin(relations: :instrumentation, &INSTRUMENTATION_PLUGIN_CONFIG)\n\n          plugin relations: :auto_restrictions\n        end\n\n        # @api private\n        INSTRUMENTATION_PLUGIN_CONFIG = -> plugin {\n          plugin.notifications = target[\"notifications\"]\n        }.freeze\n        private_constant :INSTRUMENTATION_PLUGIN_CONFIG\n\n        # @api private\n        private def configure_extensions(database_url)\n          return if skip_defaults?(:extensions)\n\n          # Extensions for all SQL databases\n          extension(\n            :caller_logging,\n            :error_sql,\n            :sql_comments\n          )\n\n          # Extensions for specific databases\n          if database_url.to_s.start_with?(%r{postgres(ql)*://})\n            extension(\n              :pg_array,\n              :pg_enum,\n              :pg_json,\n              :pg_range\n            )\n          end\n        end\n\n        # @api private\n        def gateway_options\n          {extensions: extensions}\n        end\n\n        # @api public\n        # @since 2.2.0\n        def clear\n          config.extensions = nil\n          super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "configure_extensions", "signature": "def configure_extensions(database_url)", "start_line": 65, "end_line": 84}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 647}
{"function_name": "adapter", "file_path": "hanami/lib/hanami/providers/db/gateway.rb", "focal_code": "def adapter(name = Undefined)\n          return config.adapter if name.eql?(Undefined)\n\n          if block_given?\n            # If a block is given, explicitly configure the gateway's adapter\n            config.adapter_name = name\n            adapter = (config.adapter ||= Adapters.new_adapter(name))\n            yield adapter\n            adapter\n          else\n            # If an adapter name is given without a block, use the default adapter configured with\n            # the same name\n            config.adapter_name = adapter_name\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"dry/configurable\"\nrequire \"dry/core\"\n\nmodule Hanami\n  module Providers\n    class DB < Hanami::Provider::Source\n      # @api public\n      # @since 2.2.0\n      class Gateway\n        include Dry::Core::Constants\n        include Dry::Configurable\n\n        setting :database_url\n        setting :adapter_name, default: :sql\n        setting :adapter, mutable: true\n        setting :connection_options, default: {}\n\n        # @api public\n        # @since 2.2.0\n        def adapter(name = Undefined)\n          return config.adapter if name.eql?(Undefined)\n\n          if block_given?\n            # If a block is given, explicitly configure the gateway's adapter\n            config.adapter_name = name\n            adapter = (config.adapter ||= Adapters.new_adapter(name))\n            yield adapter\n            adapter\n          else\n            # If an adapter name is given without a block, use the default adapter configured with\n            # the same name\n            config.adapter_name = adapter_name\n          end\n        end\n\n        # @api public\n        # @since 2.2.0\n        def connection_options(**options)\n          if options.any?\n            config.connection_options.merge!(options)\n          end\n\n          config.connection_options\n        end\n\n        # @api public\n        # @since 2.2.0\n        def options\n          {**connection_options, **config.adapter.gateway_options}\n        end\n\n        # @api private\n        def configure_adapter(default_adapters)\n          default_adapter = default_adapters.find(config.adapter_name)\n          config.adapter ||= default_adapter.dup\n\n          config.adapter.configure_from_adapter(default_adapter)\n\n          config.adapter.configure_for_database(config.database_url)\n\n          self\n        end\n\n        # @api private\n        def cache_keys\n          [config.database_url, config.connection_options, config.adapter.gateway_cache_keys]\n        end\n\n        private\n\n        def method_missing(name, *args, &block)\n          if config.respond_to?(name)\n            config.public_send(name, *args, &block)\n          else\n            super\n          end\n        end\n\n        def respond_to_missing?(name, _include_all = false)\n          config.respond_to?(name) || super\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "adapter", "signature": "def adapter(name = Undefined)", "start_line": 22, "end_line": 36}, "metadata": {"module": "Hanami", "class_name": "DB", "class_signature": "class DB < < Hanami::Provider::Source"}, "task_id": 648}
{"function_name": "call", "file_path": "hanami/lib/hanami/slice/routing/resolver.rb", "focal_code": "def call(_path, endpoint)\n          endpoint =\n            case endpoint\n            when String\n              resolve_slice_action(endpoint)\n            when Class\n              endpoint.respond_to?(:call) ? endpoint : endpoint.new\n            else\n              endpoint\n            end\n\n          unless endpoint.respond_to?(:call)\n            raise Routes::NotCallableEndpointError.new(endpoint)\n          end\n\n          endpoint\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  class Slice\n    # @api private\n    module Routing\n      # Hanami app router endpoint resolver\n      #\n      # This resolves endpoints objects from a slice container using the strings passed to `to:` as\n      # their container keys.\n      #\n      # @api private\n      # @since 2.0.0\n      class Resolver\n        SLICE_ACTIONS_KEY_NAMESPACE = \"actions\"\n\n        # @api private\n        # @since 2.0.0\n        def initialize(slice:)\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.0.0\n        def find_slice(slice_name)\n          slice.slices[slice_name]\n        end\n\n        # @api private\n        # @since 2.0.0\n        def to_slice(slice_name)\n          self.class.new(slice: find_slice(slice_name))\n        end\n\n        # @api private\n        # @since 2.0.0\n        def call(_path, endpoint)\n          endpoint =\n            case endpoint\n            when String\n              resolve_slice_action(endpoint)\n            when Class\n              endpoint.respond_to?(:call) ? endpoint : endpoint.new\n            else\n              endpoint\n            end\n\n          unless endpoint.respond_to?(:call)\n            raise Routes::NotCallableEndpointError.new(endpoint)\n          end\n\n          endpoint\n        end\n\n        private\n\n        # @api private\n        # @since 2.0.0\n        attr_reader :slice\n\n        # @api private\n        # @since 2.0.0\n        def resolve_slice_action(key)\n          action_key = \"#{SLICE_ACTIONS_KEY_NAMESPACE}.#{key}\"\n\n          ensure_action_in_slice(action_key)\n\n          # Lazily resolve action from the slice to reduce router initialization time, and\n          # circumvent endless loops from the action requiring access to router-related\n          # concerns (which may not be fully loaded at the time of reading the routes)\n          -> (*args) {\n            action = slice.resolve(action_key) do\n              raise Routes::MissingActionError.new(action_key, slice)\n            end\n\n            action.call(*args)\n          }\n        end\n\n        def ensure_action_in_slice(key)\n          return unless slice.booted?\n\n          raise Routes::MissingActionError.new(key, slice) unless slice.key?(key)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(_path, endpoint)", "start_line": 37, "end_line": 53}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 649}
{"function_name": "resolve_slice_action", "file_path": "hanami/lib/hanami/slice/routing/resolver.rb", "focal_code": "def resolve_slice_action(key)\n          action_key = \"#{SLICE_ACTIONS_KEY_NAMESPACE}.#{key}\"\n\n          ensure_action_in_slice(action_key)\n\n          # Lazily resolve action from the slice to reduce router initialization time, and\n          # circumvent endless loops from the action requiring access to router-related\n          # concerns (which may not be fully loaded at the time of reading the routes)\n          -> (*args) {\n            action = slice.resolve(action_key) do\n              raise Routes::MissingActionError.new(action_key, slice)\n            end\n\n            action.call(*args)\n          }\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  class Slice\n    # @api private\n    module Routing\n      # Hanami app router endpoint resolver\n      #\n      # This resolves endpoints objects from a slice container using the strings passed to `to:` as\n      # their container keys.\n      #\n      # @api private\n      # @since 2.0.0\n      class Resolver\n        SLICE_ACTIONS_KEY_NAMESPACE = \"actions\"\n\n        # @api private\n        # @since 2.0.0\n        def initialize(slice:)\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.0.0\n        def find_slice(slice_name)\n          slice.slices[slice_name]\n        end\n\n        # @api private\n        # @since 2.0.0\n        def to_slice(slice_name)\n          self.class.new(slice: find_slice(slice_name))\n        end\n\n        # @api private\n        # @since 2.0.0\n        def call(_path, endpoint)\n          endpoint =\n            case endpoint\n            when String\n              resolve_slice_action(endpoint)\n            when Class\n              endpoint.respond_to?(:call) ? endpoint : endpoint.new\n            else\n              endpoint\n            end\n\n          unless endpoint.respond_to?(:call)\n            raise Routes::NotCallableEndpointError.new(endpoint)\n          end\n\n          endpoint\n        end\n\n        private\n\n        # @api private\n        # @since 2.0.0\n        attr_reader :slice\n\n        # @api private\n        # @since 2.0.0\n        def resolve_slice_action(key)\n          action_key = \"#{SLICE_ACTIONS_KEY_NAMESPACE}.#{key}\"\n\n          ensure_action_in_slice(action_key)\n\n          # Lazily resolve action from the slice to reduce router initialization time, and\n          # circumvent endless loops from the action requiring access to router-related\n          # concerns (which may not be fully loaded at the time of reading the routes)\n          -> (*args) {\n            action = slice.resolve(action_key) do\n              raise Routes::MissingActionError.new(action_key, slice)\n            end\n\n            action.call(*args)\n          }\n        end\n\n        def ensure_action_in_slice(key)\n          return unless slice.booted?\n\n          raise Routes::MissingActionError.new(key, slice) unless slice.key?(key)\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "resolve_slice_action", "signature": "def resolve_slice_action(key)", "start_line": 63, "end_line": 78}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 650}
{"function_name": "use", "file_path": "hanami/lib/hanami/slice/routing/middleware/stack.rb", "focal_code": "def use(spec, *args, path_prefix: ::Hanami::Router::DEFAULT_PREFIX, before: nil, after: nil, **kwargs, &blk)\n            middleware = resolve_middleware_class(spec)\n            item = [middleware, args, kwargs, blk]\n\n            if before\n              @stack[path_prefix].insert((idx = index_of(before, path_prefix)).zero? ? 0 : idx - 1, item)\n            elsif after\n              @stack[path_prefix].insert(index_of(after, path_prefix) + 1, item)\n            else\n              @stack[path_prefix].push(item)\n            end\n\n            self\n          end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire \"hanami/middleware\"\nrequire \"hanami/middleware/app\"\nrequire \"hanami/errors\"\n\nmodule Hanami\n  class Slice\n    module Routing\n      # @since 2.0.0\n      # @api private\n      module Middleware\n        # Wraps a rack app with a middleware stack\n        #\n        # We use this class to add middlewares to the rack application generated from\n        # {Hanami::Slice::Router}.\n        #\n        # ```\n        # stack = Hanami::Slice::Routing::Middleware::Stack.new\n        # stack.use(Rack::ContentType, \"text/html\")\n        # stack.to_rack_app(a_rack_app)\n        # ```\n        #\n        # Middlewares can be mounted on specific paths:\n        #\n        # ```\n        # stack.with(\"/api\") do\n        #   stack.use(Rack::ContentType, \"application/json\")\n        # end\n        # ```\n        #\n        # @see Hanami::Config#middleware\n        #\n        # @since 2.0.0\n        # @api private\n        class Stack\n          include Enumerable\n\n          # @since 2.0.0\n          # @api private\n          attr_reader :stack\n\n          # Returns an array of Ruby namespaces from which to load middleware classes specified by\n          # symbol names given to {#use}.\n          #\n          # Defaults to `[Hanami::Middleware]`.\n          #\n          # @return [Array<Object>]\n          #\n          # @api public\n          # @since 2.0.0\n          attr_reader :namespaces\n\n          # @since 2.0.0\n          # @api private\n          def initialize\n            @stack = Hash.new { |hash, key| hash[key] = [] }\n            @namespaces = [Hanami::Middleware]\n          end\n\n          # @since 2.0.0\n          # @api private\n          def initialize_copy(source)\n            super\n            @stack = stack.dup\n            @namespaces = namespaces.dup\n          end\n\n          # Adds a middleware to the stack.\n          #\n          # @example\n          #   # Using a symbol name; adds Hanami::Middleware::BodyParser.new([:json])\n          #   middleware.use :body_parser, :json\n          #\n          #   # Using a class name\n          #   middleware.use MyMiddleware\n          #\n          #   # Adding a middleware before or after others\n          #   middleware.use MyMiddleware, before: SomeMiddleware\n          #   middleware.use MyMiddleware, after: OtherMiddleware\n          #\n          # @param spec [Symbol, Class] the middleware name or class name\n          # @param args [Array, nil] Arguments to pass to the middleware's `.new` method\n          # @param before [Class, nil] an optional (already added) middleware class to add the\n          #   middleware before\n          # @param after [Class, nil] an optional (already added) middleware class to add the\n          #   middleware after\n          #\n          # @return [self]\n          #\n          # @api public\n          # @since 2.0.0\n          def use(spec, *args, path_prefix: ::Hanami::Router::DEFAULT_PREFIX, before: nil, after: nil, **kwargs, &blk)\n            middleware = resolve_middleware_class(spec)\n            item = [middleware, args, kwargs, blk]\n\n            if before\n              @stack[path_prefix].insert((idx = index_of(before, path_prefix)).zero? ? 0 : idx - 1, item)\n            elsif after\n              @stack[path_prefix].insert(index_of(after, path_prefix) + 1, item)\n            else\n              @stack[path_prefix].push(item)\n            end\n\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def update(other)\n            other.stack.each do |path_prefix, items|\n              stack[path_prefix].concat(items)\n            end\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_rack_app(app)\n            unless Hanami.bundled?(\"rack\")\n              raise \"Add \\\"rack\\\" to your `Gemfile` to run Hanami as a rack app\"\n            end\n\n            mapping = to_hash\n            return app if mapping.empty?\n\n            Hanami::Middleware::App.new(app, mapping)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_hash\n            @stack.each_with_object({}) do |(path, _), result|\n              result[path] = stack_for(path)\n            end\n          end\n\n          # @since 2.0.0\n          # @api private\n          def empty?\n            @stack.empty?\n          end\n\n          # @since 2.0.0\n          # @api private\n          def each(&blk)\n            @stack.each(&blk)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def mapped(builder, prefix, &blk)\n            if prefix == ::Hanami::Router::DEFAULT_PREFIX\n              builder.instance_eval(&blk)\n            else\n              builder.map(prefix, &blk)\n            end\n          end\n\n          private\n\n          # @since 2.0.0\n          def index_of(middleware, path_prefix)\n            @stack[path_prefix].index { |(m, *)| m.equal?(middleware) }\n          end\n\n          # @since 2.0.0\n          # @api private\n          def stack_for(current_path)\n            @stack.each_with_object([]) do |(path, stack), result|\n              next unless current_path.start_with?(path)\n\n              result.push(stack)\n            end.flatten(1)\n          end\n\n          # @since 2.0.0\n          def resolve_middleware_class(spec)\n            case spec\n            when Symbol then load_middleware_class(spec)\n            when Class, Module then spec\n            else\n              if spec.respond_to?(:call)\n                spec\n              else\n                raise UnsupportedMiddlewareSpecError, spec\n              end\n            end\n          end\n\n          # @since 2.0.0\n          def load_middleware_class(spec)\n            begin\n              require \"hanami/middleware/#{spec}\"\n            rescue LoadError # rubocop:disable Lint/SuppressedException\n            end\n\n            # FIXME: Classify must use App inflector\n            class_name = Hanami::Utils::String.classify(spec.to_s)\n            namespace = namespaces.detect { |ns| ns.const_defined?(class_name) }\n\n            if namespace\n              namespace.const_get(class_name)\n            else\n              raise(\n                UnsupportedMiddlewareSpecError,\n                \"Failed to find corresponding middleware class for `#{spec}` in #{namespaces.join(', ')}\"\n              )\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "use", "signature": "def use(spec, *args, path_prefix: ::Hanami::Router::DEFAULT_PREFIX, before: nil, after: nil, **kwargs, &blk)", "start_line": 94, "end_line": 107}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 651}
{"function_name": "resolve_middleware_class", "file_path": "hanami/lib/hanami/slice/routing/middleware/stack.rb", "focal_code": "def resolve_middleware_class(spec)\n            case spec\n            when Symbol then load_middleware_class(spec)\n            when Class, Module then spec\n            else\n              if spec.respond_to?(:call)\n                spec\n              else\n                raise UnsupportedMiddlewareSpecError, spec\n              end\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire \"hanami/middleware\"\nrequire \"hanami/middleware/app\"\nrequire \"hanami/errors\"\n\nmodule Hanami\n  class Slice\n    module Routing\n      # @since 2.0.0\n      # @api private\n      module Middleware\n        # Wraps a rack app with a middleware stack\n        #\n        # We use this class to add middlewares to the rack application generated from\n        # {Hanami::Slice::Router}.\n        #\n        # ```\n        # stack = Hanami::Slice::Routing::Middleware::Stack.new\n        # stack.use(Rack::ContentType, \"text/html\")\n        # stack.to_rack_app(a_rack_app)\n        # ```\n        #\n        # Middlewares can be mounted on specific paths:\n        #\n        # ```\n        # stack.with(\"/api\") do\n        #   stack.use(Rack::ContentType, \"application/json\")\n        # end\n        # ```\n        #\n        # @see Hanami::Config#middleware\n        #\n        # @since 2.0.0\n        # @api private\n        class Stack\n          include Enumerable\n\n          # @since 2.0.0\n          # @api private\n          attr_reader :stack\n\n          # Returns an array of Ruby namespaces from which to load middleware classes specified by\n          # symbol names given to {#use}.\n          #\n          # Defaults to `[Hanami::Middleware]`.\n          #\n          # @return [Array<Object>]\n          #\n          # @api public\n          # @since 2.0.0\n          attr_reader :namespaces\n\n          # @since 2.0.0\n          # @api private\n          def initialize\n            @stack = Hash.new { |hash, key| hash[key] = [] }\n            @namespaces = [Hanami::Middleware]\n          end\n\n          # @since 2.0.0\n          # @api private\n          def initialize_copy(source)\n            super\n            @stack = stack.dup\n            @namespaces = namespaces.dup\n          end\n\n          # Adds a middleware to the stack.\n          #\n          # @example\n          #   # Using a symbol name; adds Hanami::Middleware::BodyParser.new([:json])\n          #   middleware.use :body_parser, :json\n          #\n          #   # Using a class name\n          #   middleware.use MyMiddleware\n          #\n          #   # Adding a middleware before or after others\n          #   middleware.use MyMiddleware, before: SomeMiddleware\n          #   middleware.use MyMiddleware, after: OtherMiddleware\n          #\n          # @param spec [Symbol, Class] the middleware name or class name\n          # @param args [Array, nil] Arguments to pass to the middleware's `.new` method\n          # @param before [Class, nil] an optional (already added) middleware class to add the\n          #   middleware before\n          # @param after [Class, nil] an optional (already added) middleware class to add the\n          #   middleware after\n          #\n          # @return [self]\n          #\n          # @api public\n          # @since 2.0.0\n          def use(spec, *args, path_prefix: ::Hanami::Router::DEFAULT_PREFIX, before: nil, after: nil, **kwargs, &blk)\n            middleware = resolve_middleware_class(spec)\n            item = [middleware, args, kwargs, blk]\n\n            if before\n              @stack[path_prefix].insert((idx = index_of(before, path_prefix)).zero? ? 0 : idx - 1, item)\n            elsif after\n              @stack[path_prefix].insert(index_of(after, path_prefix) + 1, item)\n            else\n              @stack[path_prefix].push(item)\n            end\n\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def update(other)\n            other.stack.each do |path_prefix, items|\n              stack[path_prefix].concat(items)\n            end\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_rack_app(app)\n            unless Hanami.bundled?(\"rack\")\n              raise \"Add \\\"rack\\\" to your `Gemfile` to run Hanami as a rack app\"\n            end\n\n            mapping = to_hash\n            return app if mapping.empty?\n\n            Hanami::Middleware::App.new(app, mapping)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_hash\n            @stack.each_with_object({}) do |(path, _), result|\n              result[path] = stack_for(path)\n            end\n          end\n\n          # @since 2.0.0\n          # @api private\n          def empty?\n            @stack.empty?\n          end\n\n          # @since 2.0.0\n          # @api private\n          def each(&blk)\n            @stack.each(&blk)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def mapped(builder, prefix, &blk)\n            if prefix == ::Hanami::Router::DEFAULT_PREFIX\n              builder.instance_eval(&blk)\n            else\n              builder.map(prefix, &blk)\n            end\n          end\n\n          private\n\n          # @since 2.0.0\n          def index_of(middleware, path_prefix)\n            @stack[path_prefix].index { |(m, *)| m.equal?(middleware) }\n          end\n\n          # @since 2.0.0\n          # @api private\n          def stack_for(current_path)\n            @stack.each_with_object([]) do |(path, stack), result|\n              next unless current_path.start_with?(path)\n\n              result.push(stack)\n            end.flatten(1)\n          end\n\n          # @since 2.0.0\n          def resolve_middleware_class(spec)\n            case spec\n            when Symbol then load_middleware_class(spec)\n            when Class, Module then spec\n            else\n              if spec.respond_to?(:call)\n                spec\n              else\n                raise UnsupportedMiddlewareSpecError, spec\n              end\n            end\n          end\n\n          # @since 2.0.0\n          def load_middleware_class(spec)\n            begin\n              require \"hanami/middleware/#{spec}\"\n            rescue LoadError # rubocop:disable Lint/SuppressedException\n            end\n\n            # FIXME: Classify must use App inflector\n            class_name = Hanami::Utils::String.classify(spec.to_s)\n            namespace = namespaces.detect { |ns| ns.const_defined?(class_name) }\n\n            if namespace\n              namespace.const_get(class_name)\n            else\n              raise(\n                UnsupportedMiddlewareSpecError,\n                \"Failed to find corresponding middleware class for `#{spec}` in #{namespaces.join(', ')}\"\n              )\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "resolve_middleware_class", "signature": "def resolve_middleware_class(spec)", "start_line": 179, "end_line": 190}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 652}
{"function_name": "load_middleware_class", "file_path": "hanami/lib/hanami/slice/routing/middleware/stack.rb", "focal_code": "def load_middleware_class(spec)\n            begin\n              require \"hanami/middleware/#{spec}\"\n            rescue LoadError # rubocop:disable Lint/SuppressedException\n            end\n\n            # FIXME: Classify must use App inflector\n            class_name = Hanami::Utils::String.classify(spec.to_s)\n            namespace = namespaces.detect { |ns| ns.const_defined?(class_name) }\n\n            if namespace\n              namespace.const_get(class_name)\n            else\n              raise(\n                UnsupportedMiddlewareSpecError,\n                \"Failed to find corresponding middleware class for `#{spec}` in #{namespaces.join(', ')}\"\n              )\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/router\"\nrequire \"hanami/middleware\"\nrequire \"hanami/middleware/app\"\nrequire \"hanami/errors\"\n\nmodule Hanami\n  class Slice\n    module Routing\n      # @since 2.0.0\n      # @api private\n      module Middleware\n        # Wraps a rack app with a middleware stack\n        #\n        # We use this class to add middlewares to the rack application generated from\n        # {Hanami::Slice::Router}.\n        #\n        # ```\n        # stack = Hanami::Slice::Routing::Middleware::Stack.new\n        # stack.use(Rack::ContentType, \"text/html\")\n        # stack.to_rack_app(a_rack_app)\n        # ```\n        #\n        # Middlewares can be mounted on specific paths:\n        #\n        # ```\n        # stack.with(\"/api\") do\n        #   stack.use(Rack::ContentType, \"application/json\")\n        # end\n        # ```\n        #\n        # @see Hanami::Config#middleware\n        #\n        # @since 2.0.0\n        # @api private\n        class Stack\n          include Enumerable\n\n          # @since 2.0.0\n          # @api private\n          attr_reader :stack\n\n          # Returns an array of Ruby namespaces from which to load middleware classes specified by\n          # symbol names given to {#use}.\n          #\n          # Defaults to `[Hanami::Middleware]`.\n          #\n          # @return [Array<Object>]\n          #\n          # @api public\n          # @since 2.0.0\n          attr_reader :namespaces\n\n          # @since 2.0.0\n          # @api private\n          def initialize\n            @stack = Hash.new { |hash, key| hash[key] = [] }\n            @namespaces = [Hanami::Middleware]\n          end\n\n          # @since 2.0.0\n          # @api private\n          def initialize_copy(source)\n            super\n            @stack = stack.dup\n            @namespaces = namespaces.dup\n          end\n\n          # Adds a middleware to the stack.\n          #\n          # @example\n          #   # Using a symbol name; adds Hanami::Middleware::BodyParser.new([:json])\n          #   middleware.use :body_parser, :json\n          #\n          #   # Using a class name\n          #   middleware.use MyMiddleware\n          #\n          #   # Adding a middleware before or after others\n          #   middleware.use MyMiddleware, before: SomeMiddleware\n          #   middleware.use MyMiddleware, after: OtherMiddleware\n          #\n          # @param spec [Symbol, Class] the middleware name or class name\n          # @param args [Array, nil] Arguments to pass to the middleware's `.new` method\n          # @param before [Class, nil] an optional (already added) middleware class to add the\n          #   middleware before\n          # @param after [Class, nil] an optional (already added) middleware class to add the\n          #   middleware after\n          #\n          # @return [self]\n          #\n          # @api public\n          # @since 2.0.0\n          def use(spec, *args, path_prefix: ::Hanami::Router::DEFAULT_PREFIX, before: nil, after: nil, **kwargs, &blk)\n            middleware = resolve_middleware_class(spec)\n            item = [middleware, args, kwargs, blk]\n\n            if before\n              @stack[path_prefix].insert((idx = index_of(before, path_prefix)).zero? ? 0 : idx - 1, item)\n            elsif after\n              @stack[path_prefix].insert(index_of(after, path_prefix) + 1, item)\n            else\n              @stack[path_prefix].push(item)\n            end\n\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def update(other)\n            other.stack.each do |path_prefix, items|\n              stack[path_prefix].concat(items)\n            end\n            self\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_rack_app(app)\n            unless Hanami.bundled?(\"rack\")\n              raise \"Add \\\"rack\\\" to your `Gemfile` to run Hanami as a rack app\"\n            end\n\n            mapping = to_hash\n            return app if mapping.empty?\n\n            Hanami::Middleware::App.new(app, mapping)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def to_hash\n            @stack.each_with_object({}) do |(path, _), result|\n              result[path] = stack_for(path)\n            end\n          end\n\n          # @since 2.0.0\n          # @api private\n          def empty?\n            @stack.empty?\n          end\n\n          # @since 2.0.0\n          # @api private\n          def each(&blk)\n            @stack.each(&blk)\n          end\n\n          # @since 2.0.0\n          # @api private\n          def mapped(builder, prefix, &blk)\n            if prefix == ::Hanami::Router::DEFAULT_PREFIX\n              builder.instance_eval(&blk)\n            else\n              builder.map(prefix, &blk)\n            end\n          end\n\n          private\n\n          # @since 2.0.0\n          def index_of(middleware, path_prefix)\n            @stack[path_prefix].index { |(m, *)| m.equal?(middleware) }\n          end\n\n          # @since 2.0.0\n          # @api private\n          def stack_for(current_path)\n            @stack.each_with_object([]) do |(path, stack), result|\n              next unless current_path.start_with?(path)\n\n              result.push(stack)\n            end.flatten(1)\n          end\n\n          # @since 2.0.0\n          def resolve_middleware_class(spec)\n            case spec\n            when Symbol then load_middleware_class(spec)\n            when Class, Module then spec\n            else\n              if spec.respond_to?(:call)\n                spec\n              else\n                raise UnsupportedMiddlewareSpecError, spec\n              end\n            end\n          end\n\n          # @since 2.0.0\n          def load_middleware_class(spec)\n            begin\n              require \"hanami/middleware/#{spec}\"\n            rescue LoadError # rubocop:disable Lint/SuppressedException\n            end\n\n            # FIXME: Classify must use App inflector\n            class_name = Hanami::Utils::String.classify(spec.to_s)\n            namespace = namespaces.detect { |ns| ns.const_defined?(class_name) }\n\n            if namespace\n              namespace.const_get(class_name)\n            else\n              raise(\n                UnsupportedMiddlewareSpecError,\n                \"Failed to find corresponding middleware class for `#{spec}` in #{namespaces.join(', ')}\"\n              )\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "load_middleware_class", "signature": "def load_middleware_class(spec)", "start_line": 193, "end_line": 211}, "metadata": {"module": "Hanami", "class_name": "Slice", "class_signature": "class Slice"}, "task_id": 653}
{"function_name": "define_transaction", "file_path": "hanami/lib/hanami/extensions/operation/slice_configured_db_operation.rb", "focal_code": "def define_transaction\n            slice = self.slice\n            define_method(:transaction) do |**kwargs, &block|\n              unless rom\n                msg = <<~TEXT.strip\n                  A configured db for #{slice} is required to run transactions.\n                TEXT\n                raise Hanami::ComponentLoadError, msg\n              end\n\n              super(**kwargs, &block)\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Operation\n      # Extends operations to support the database.\n      #\n      # Add an initializer accepting a `rom:` dependency, which is supplied automatically from the\n      # `\"db.rom\"` component in the operation's slice.\n      #\n      # @api private\n      class SliceConfiguredDBOperation < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(operation_class)\n          require \"dry/operation/extensions/rom\"\n          operation_class.include Dry::Operation::Extensions::ROM\n\n          operation_class.include InstanceMethods\n          operation_class.include SliceInstanceMethods.new(slice)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}>\"\n        end\n\n        private\n\n        def define_new\n          resolve_rom = method(:resolve_rom)\n\n          define_method(:new) do |**kwargs|\n            super(\n              **kwargs,\n              rom: kwargs.fetch(:rom) { resolve_rom.() },\n            )\n          end\n        end\n\n        def resolve_rom\n          slice[\"db.rom\"] if slice.key?(\"db.rom\")\n        end\n\n        module InstanceMethods\n          attr_reader :rom\n\n          def initialize(rom:, **)\n            super()\n            @rom = rom\n          end\n        end\n\n        class SliceInstanceMethods < Module\n          attr_reader :slice\n\n          def initialize(slice)\n            super()\n            @slice = slice\n          end\n\n          def included(operation_class)\n            define_transaction\n          end\n\n          private\n\n          def define_transaction\n            slice = self.slice\n            define_method(:transaction) do |**kwargs, &block|\n              unless rom\n                msg = <<~TEXT.strip\n                  A configured db for #{slice} is required to run transactions.\n                TEXT\n                raise Hanami::ComponentLoadError, msg\n              end\n\n              super(**kwargs, &block)\n            end\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_transaction", "signature": "def define_transaction slice = self.slice", "start_line": 73, "end_line": 85}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredDBOperation", "class_signature": "class SliceConfiguredDBOperation < < Module"}, "task_id": 654}
{"function_name": "define_inherited", "file_path": "hanami/lib/hanami/extensions/db/repo.rb", "focal_code": "def define_inherited\n          root_for_repo_class = method(:root_for_repo_class)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n\n            unless subclass.root\n              root = root_for_repo_class.(subclass)\n              subclass.root root if root\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/db\"\n\nmodule Hanami\n  module Extensions\n    # @api private\n    # @since 2.2.0\n    module DB\n      # @api private\n      # @since 2.2.0\n      module Repo\n        def self.included(repo_class)\n          super\n\n          repo_class.extend(Hanami::SliceConfigurable)\n          repo_class.extend(ClassMethods)\n        end\n\n        # @api private\n        # @since 2.2.0\n        module ClassMethods\n          def configure_for_slice(slice)\n            extend SliceConfiguredRepo.new(slice)\n          end\n        end\n      end\n\n      # @api private\n      # @since 2.2.0\n      class SliceConfiguredRepo < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(repo_class)\n          define_inherited\n          configure_repo(repo_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        def define_inherited\n          root_for_repo_class = method(:root_for_repo_class)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n\n            unless subclass.root\n              root = root_for_repo_class.(subclass)\n              subclass.root root if root\n            end\n          end\n        end\n\n        def configure_repo(repo_class)\n          repo_class.struct_namespace struct_namespace\n        end\n\n        def define_new\n          resolve_rom = method(:resolve_rom)\n\n          define_method(:new) do |**kwargs|\n            container = kwargs.delete(:container) || resolve_rom.()\n            super(container: container, **kwargs)\n          end\n        end\n\n        def resolve_rom\n          slice[\"db.rom\"]\n        end\n\n        REPO_CLASS_NAME_REGEX = /^(?<name>.+)_(repo|repository)$/\n\n        def root_for_repo_class(repo_class)\n          repo_class_name = slice.inflector.demodulize(repo_class)\n            .then { slice.inflector.underscore(_1) }\n\n          repo_class_match = repo_class_name.match(REPO_CLASS_NAME_REGEX)\n          return unless repo_class_match\n\n          repo_class_match[:name]\n            .then { slice.inflector.pluralize(_1) }\n            .then(&:to_sym)\n        end\n\n        def struct_namespace\n          @struct_namespace ||=\n            if slice.namespace.const_defined?(:Structs)\n              slice.namespace.const_get(:Structs)\n            else\n              slice.namespace.const_set(:Structs, Module.new)\n            end\n        end\n      end\n    end\n  end\nend\n\nHanami::DB::Repo.include(Hanami::Extensions::DB::Repo)\n", "language": "ruby", "function_component": {"name": "define_inherited", "signature": "def define_inherited root_for_repo_class = method(:root_for_repo_class)", "start_line": 51, "end_line": 62}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredRepo", "class_signature": "class SliceConfiguredRepo < < Module"}, "task_id": 655}
{"function_name": "configure_view", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_view.rb", "focal_code": "def configure_view(view_class)\n          view_class.settings.each do |setting|\n            next unless slice.config.views.respond_to?(setting.name)\n\n            # Configure the view from config on the slice, _unless it has already been configured by\n            # a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its views config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # view classes.\n            #\n            # For example, given an app-level base view class, with custom config:\n            #\n            #   module MyApp\n            #     class View < Hanami::View\n            #       config.layout = \"custom_layout\"\n            #     end\n            #   end\n            #\n            # And then a view in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Views\n            #       class SomeView < MyApp::View\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredView` will be extended two times:\n            #\n            # 1. When `MyApp::View` is defined\n            # 2. Again when `MySlice::Views::SomeView` is defined\n            #\n            # If we blindly re-configure all view settings each time `SliceConfiguredView` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.layout` explicitly configured in the `MyApp::View` base class, leaving\n            # `MySlice::Views::SomeView` with `config.layout` of `\"app\"` (the default as specified\n            # at `Hanami.app.config.views.layout`), and not the `\"custom_layout\"` value configured\n            # in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.views.public_send(setting.name)\n            parent_value = slice.parent.config.views.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            view_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n\n          view_class.config.inflector = inflector\n\n          # Configure the paths for this view if:\n          #   - We are the app, and a user hasn't provided custom `paths` (in this case, we need to\n          #     set the defaults)\n          #   - We are a slice, and the view's inherited `paths` is identical to the parent's config\n          #     (which would result in the view in a slice erroneously trying to find templates in\n          #     the app)\n          if view_class.config.paths.empty? ||\n             (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])\n            view_class.config.paths = templates_path(slice)\n          end\n\n          view_class.config.template = template_name(view_class)\n          view_class.config.default_context = Extensions::View::Context.context_class(slice).new\n\n          view_class.config.part_class = part_class\n          view_class.config.scope_class = scope_class\n\n          if (part_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{PARTS_DIR}\"))\n            view_class.config.part_namespace = part_namespace\n          end\n          if (scope_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{SCOPES_DIR}\"))\n            view_class.config.scope_namespace = scope_namespace\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view class defined within a\n      # slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredView < Module\n        TEMPLATES_DIR = \"templates\"\n        VIEWS_DIR = \"views\"\n        PARTS_DIR = \"parts\"\n        SCOPES_DIR = \"scopes\"\n\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(view_class)\n          load_app_view\n          configure_view(view_class)\n          define_inherited\n        end\n\n        # @return [String]\n        #\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # If the given view doesn't inherit from the app view, attempt to load it anyway, since\n        # requiring the app view is necessary for _its_ `SliceConfiguredView` hook to execute and\n        # define the app-level part and scope classes that we refer to here.\n        def load_app_view\n          return if app?\n\n          begin\n            slice.app.namespace.const_get(:View, false)\n          rescue NameError => exception\n            raise unless exception.name == :View\n          end\n        end\n\n        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n        def configure_view(view_class)\n          view_class.settings.each do |setting|\n            next unless slice.config.views.respond_to?(setting.name)\n\n            # Configure the view from config on the slice, _unless it has already been configured by\n            # a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its views config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # view classes.\n            #\n            # For example, given an app-level base view class, with custom config:\n            #\n            #   module MyApp\n            #     class View < Hanami::View\n            #       config.layout = \"custom_layout\"\n            #     end\n            #   end\n            #\n            # And then a view in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Views\n            #       class SomeView < MyApp::View\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredView` will be extended two times:\n            #\n            # 1. When `MyApp::View` is defined\n            # 2. Again when `MySlice::Views::SomeView` is defined\n            #\n            # If we blindly re-configure all view settings each time `SliceConfiguredView` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.layout` explicitly configured in the `MyApp::View` base class, leaving\n            # `MySlice::Views::SomeView` with `config.layout` of `\"app\"` (the default as specified\n            # at `Hanami.app.config.views.layout`), and not the `\"custom_layout\"` value configured\n            # in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.views.public_send(setting.name)\n            parent_value = slice.parent.config.views.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            view_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n\n          view_class.config.inflector = inflector\n\n          # Configure the paths for this view if:\n          #   - We are the app, and a user hasn't provided custom `paths` (in this case, we need to\n          #     set the defaults)\n          #   - We are a slice, and the view's inherited `paths` is identical to the parent's config\n          #     (which would result in the view in a slice erroneously trying to find templates in\n          #     the app)\n          if view_class.config.paths.empty? ||\n             (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])\n            view_class.config.paths = templates_path(slice)\n          end\n\n          view_class.config.template = template_name(view_class)\n          view_class.config.default_context = Extensions::View::Context.context_class(slice).new\n\n          view_class.config.part_class = part_class\n          view_class.config.scope_class = scope_class\n\n          if (part_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{PARTS_DIR}\"))\n            view_class.config.part_namespace = part_namespace\n          end\n          if (scope_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{SCOPES_DIR}\"))\n            view_class.config.scope_namespace = scope_namespace\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n        def define_inherited\n          template_name = method(:template_name)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n            subclass.config.template = template_name.(subclass)\n          end\n        end\n\n        def templates_path(slice)\n          if slice.app.equal?(slice)\n            slice.root.join(APP_DIR, TEMPLATES_DIR)\n          else\n            slice.root.join(TEMPLATES_DIR)\n          end\n        end\n\n        def namespace_from_path(path)\n          path = \"#{slice.slice_name.path}/#{path}\"\n\n          begin\n            require path\n          rescue LoadError => exception\n            raise exception unless exception.path == path\n          end\n\n          begin\n            inflector.constantize(inflector.camelize(path))\n          rescue NameError # rubocop: disable Lint/SuppressedException\n          end\n        end\n\n        def template_name(view_class)\n          inflector\n            .underscore(view_class.name)\n            .sub(/^#{slice.slice_name.path}\\//, \"\")\n            .sub(/^#{VIEWS_DIR}\\//, \"\")\n        end\n\n        def inflector\n          slice.inflector\n        end\n\n        def part_class\n          @part_class ||=\n            if views_namespace.const_defined?(:Part)\n              views_namespace.const_get(:Part)\n            else\n              views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, because the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def part_superclass\n          return Hanami::View::Part if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/part\"))\n          rescue NameError\n            Hanami::View::Part\n          end\n        end\n\n        def scope_class\n          @scope_class ||=\n            if views_namespace.const_defined?(:Scope)\n              views_namespace.const_get(:Scope)\n            else\n              views_namespace.const_set(:Scope, Class.new(scope_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, since the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def scope_superclass\n          return Hanami::View::Scope if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/scope\"))\n          rescue NameError\n            Hanami::View::Scope\n          end\n        end\n\n        def views_namespace\n          @slice_views_namespace ||=\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n        end\n\n        def app?\n          slice.app == slice\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "configure_view", "signature": "def configure_view(view_class)", "start_line": 58, "end_line": 136}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredView", "class_signature": "class SliceConfiguredView < < Module"}, "task_id": 656}
{"function_name": "namespace_from_path", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_view.rb", "focal_code": "def namespace_from_path(path)\n          path = \"#{slice.slice_name.path}/#{path}\"\n\n          begin\n            require path\n          rescue LoadError => exception\n            raise exception unless exception.path == path\n          end\n\n          begin\n            inflector.constantize(inflector.camelize(path))\n          rescue NameError # rubocop: disable Lint/SuppressedException\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view class defined within a\n      # slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredView < Module\n        TEMPLATES_DIR = \"templates\"\n        VIEWS_DIR = \"views\"\n        PARTS_DIR = \"parts\"\n        SCOPES_DIR = \"scopes\"\n\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(view_class)\n          load_app_view\n          configure_view(view_class)\n          define_inherited\n        end\n\n        # @return [String]\n        #\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # If the given view doesn't inherit from the app view, attempt to load it anyway, since\n        # requiring the app view is necessary for _its_ `SliceConfiguredView` hook to execute and\n        # define the app-level part and scope classes that we refer to here.\n        def load_app_view\n          return if app?\n\n          begin\n            slice.app.namespace.const_get(:View, false)\n          rescue NameError => exception\n            raise unless exception.name == :View\n          end\n        end\n\n        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n        def configure_view(view_class)\n          view_class.settings.each do |setting|\n            next unless slice.config.views.respond_to?(setting.name)\n\n            # Configure the view from config on the slice, _unless it has already been configured by\n            # a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its views config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # view classes.\n            #\n            # For example, given an app-level base view class, with custom config:\n            #\n            #   module MyApp\n            #     class View < Hanami::View\n            #       config.layout = \"custom_layout\"\n            #     end\n            #   end\n            #\n            # And then a view in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Views\n            #       class SomeView < MyApp::View\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredView` will be extended two times:\n            #\n            # 1. When `MyApp::View` is defined\n            # 2. Again when `MySlice::Views::SomeView` is defined\n            #\n            # If we blindly re-configure all view settings each time `SliceConfiguredView` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.layout` explicitly configured in the `MyApp::View` base class, leaving\n            # `MySlice::Views::SomeView` with `config.layout` of `\"app\"` (the default as specified\n            # at `Hanami.app.config.views.layout`), and not the `\"custom_layout\"` value configured\n            # in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.views.public_send(setting.name)\n            parent_value = slice.parent.config.views.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            view_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n\n          view_class.config.inflector = inflector\n\n          # Configure the paths for this view if:\n          #   - We are the app, and a user hasn't provided custom `paths` (in this case, we need to\n          #     set the defaults)\n          #   - We are a slice, and the view's inherited `paths` is identical to the parent's config\n          #     (which would result in the view in a slice erroneously trying to find templates in\n          #     the app)\n          if view_class.config.paths.empty? ||\n             (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])\n            view_class.config.paths = templates_path(slice)\n          end\n\n          view_class.config.template = template_name(view_class)\n          view_class.config.default_context = Extensions::View::Context.context_class(slice).new\n\n          view_class.config.part_class = part_class\n          view_class.config.scope_class = scope_class\n\n          if (part_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{PARTS_DIR}\"))\n            view_class.config.part_namespace = part_namespace\n          end\n          if (scope_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{SCOPES_DIR}\"))\n            view_class.config.scope_namespace = scope_namespace\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n        def define_inherited\n          template_name = method(:template_name)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n            subclass.config.template = template_name.(subclass)\n          end\n        end\n\n        def templates_path(slice)\n          if slice.app.equal?(slice)\n            slice.root.join(APP_DIR, TEMPLATES_DIR)\n          else\n            slice.root.join(TEMPLATES_DIR)\n          end\n        end\n\n        def namespace_from_path(path)\n          path = \"#{slice.slice_name.path}/#{path}\"\n\n          begin\n            require path\n          rescue LoadError => exception\n            raise exception unless exception.path == path\n          end\n\n          begin\n            inflector.constantize(inflector.camelize(path))\n          rescue NameError # rubocop: disable Lint/SuppressedException\n          end\n        end\n\n        def template_name(view_class)\n          inflector\n            .underscore(view_class.name)\n            .sub(/^#{slice.slice_name.path}\\//, \"\")\n            .sub(/^#{VIEWS_DIR}\\//, \"\")\n        end\n\n        def inflector\n          slice.inflector\n        end\n\n        def part_class\n          @part_class ||=\n            if views_namespace.const_defined?(:Part)\n              views_namespace.const_get(:Part)\n            else\n              views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, because the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def part_superclass\n          return Hanami::View::Part if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/part\"))\n          rescue NameError\n            Hanami::View::Part\n          end\n        end\n\n        def scope_class\n          @scope_class ||=\n            if views_namespace.const_defined?(:Scope)\n              views_namespace.const_get(:Scope)\n            else\n              views_namespace.const_set(:Scope, Class.new(scope_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, since the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def scope_superclass\n          return Hanami::View::Scope if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/scope\"))\n          rescue NameError\n            Hanami::View::Scope\n          end\n        end\n\n        def views_namespace\n          @slice_views_namespace ||=\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n        end\n\n        def app?\n          slice.app == slice\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "namespace_from_path", "signature": "def namespace_from_path(path)", "start_line": 156, "end_line": 169}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredView", "class_signature": "class SliceConfiguredView < < Module"}, "task_id": 657}
{"function_name": "part_class", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_view.rb", "focal_code": "def part_class\n          @part_class ||=\n            if views_namespace.const_defined?(:Part)\n              views_namespace.const_get(:Part)\n            else\n              views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, because the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view class defined within a\n      # slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredView < Module\n        TEMPLATES_DIR = \"templates\"\n        VIEWS_DIR = \"views\"\n        PARTS_DIR = \"parts\"\n        SCOPES_DIR = \"scopes\"\n\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(view_class)\n          load_app_view\n          configure_view(view_class)\n          define_inherited\n        end\n\n        # @return [String]\n        #\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # If the given view doesn't inherit from the app view, attempt to load it anyway, since\n        # requiring the app view is necessary for _its_ `SliceConfiguredView` hook to execute and\n        # define the app-level part and scope classes that we refer to here.\n        def load_app_view\n          return if app?\n\n          begin\n            slice.app.namespace.const_get(:View, false)\n          rescue NameError => exception\n            raise unless exception.name == :View\n          end\n        end\n\n        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n        def configure_view(view_class)\n          view_class.settings.each do |setting|\n            next unless slice.config.views.respond_to?(setting.name)\n\n            # Configure the view from config on the slice, _unless it has already been configured by\n            # a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its views config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # view classes.\n            #\n            # For example, given an app-level base view class, with custom config:\n            #\n            #   module MyApp\n            #     class View < Hanami::View\n            #       config.layout = \"custom_layout\"\n            #     end\n            #   end\n            #\n            # And then a view in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Views\n            #       class SomeView < MyApp::View\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredView` will be extended two times:\n            #\n            # 1. When `MyApp::View` is defined\n            # 2. Again when `MySlice::Views::SomeView` is defined\n            #\n            # If we blindly re-configure all view settings each time `SliceConfiguredView` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.layout` explicitly configured in the `MyApp::View` base class, leaving\n            # `MySlice::Views::SomeView` with `config.layout` of `\"app\"` (the default as specified\n            # at `Hanami.app.config.views.layout`), and not the `\"custom_layout\"` value configured\n            # in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.views.public_send(setting.name)\n            parent_value = slice.parent.config.views.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            view_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n\n          view_class.config.inflector = inflector\n\n          # Configure the paths for this view if:\n          #   - We are the app, and a user hasn't provided custom `paths` (in this case, we need to\n          #     set the defaults)\n          #   - We are a slice, and the view's inherited `paths` is identical to the parent's config\n          #     (which would result in the view in a slice erroneously trying to find templates in\n          #     the app)\n          if view_class.config.paths.empty? ||\n             (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])\n            view_class.config.paths = templates_path(slice)\n          end\n\n          view_class.config.template = template_name(view_class)\n          view_class.config.default_context = Extensions::View::Context.context_class(slice).new\n\n          view_class.config.part_class = part_class\n          view_class.config.scope_class = scope_class\n\n          if (part_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{PARTS_DIR}\"))\n            view_class.config.part_namespace = part_namespace\n          end\n          if (scope_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{SCOPES_DIR}\"))\n            view_class.config.scope_namespace = scope_namespace\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n        def define_inherited\n          template_name = method(:template_name)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n            subclass.config.template = template_name.(subclass)\n          end\n        end\n\n        def templates_path(slice)\n          if slice.app.equal?(slice)\n            slice.root.join(APP_DIR, TEMPLATES_DIR)\n          else\n            slice.root.join(TEMPLATES_DIR)\n          end\n        end\n\n        def namespace_from_path(path)\n          path = \"#{slice.slice_name.path}/#{path}\"\n\n          begin\n            require path\n          rescue LoadError => exception\n            raise exception unless exception.path == path\n          end\n\n          begin\n            inflector.constantize(inflector.camelize(path))\n          rescue NameError # rubocop: disable Lint/SuppressedException\n          end\n        end\n\n        def template_name(view_class)\n          inflector\n            .underscore(view_class.name)\n            .sub(/^#{slice.slice_name.path}\\//, \"\")\n            .sub(/^#{VIEWS_DIR}\\//, \"\")\n        end\n\n        def inflector\n          slice.inflector\n        end\n\n        def part_class\n          @part_class ||=\n            if views_namespace.const_defined?(:Part)\n              views_namespace.const_get(:Part)\n            else\n              views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, because the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def part_superclass\n          return Hanami::View::Part if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/part\"))\n          rescue NameError\n            Hanami::View::Part\n          end\n        end\n\n        def scope_class\n          @scope_class ||=\n            if views_namespace.const_defined?(:Scope)\n              views_namespace.const_get(:Scope)\n            else\n              views_namespace.const_set(:Scope, Class.new(scope_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, since the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def scope_superclass\n          return Hanami::View::Scope if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/scope\"))\n          rescue NameError\n            Hanami::View::Scope\n          end\n        end\n\n        def views_namespace\n          @slice_views_namespace ||=\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n        end\n\n        def app?\n          slice.app == slice\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "part_class", "signature": "def part_class @part_class ||=", "start_line": 182, "end_line": 193}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredView", "class_signature": "class SliceConfiguredView < < Module"}, "task_id": 658}
{"function_name": "scope_class", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_view.rb", "focal_code": "def scope_class\n          @scope_class ||=\n            if views_namespace.const_defined?(:Scope)\n              views_namespace.const_get(:Scope)\n            else\n              views_namespace.const_set(:Scope, Class.new(scope_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, since the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view class defined within a\n      # slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredView < Module\n        TEMPLATES_DIR = \"templates\"\n        VIEWS_DIR = \"views\"\n        PARTS_DIR = \"parts\"\n        SCOPES_DIR = \"scopes\"\n\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(view_class)\n          load_app_view\n          configure_view(view_class)\n          define_inherited\n        end\n\n        # @return [String]\n        #\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # If the given view doesn't inherit from the app view, attempt to load it anyway, since\n        # requiring the app view is necessary for _its_ `SliceConfiguredView` hook to execute and\n        # define the app-level part and scope classes that we refer to here.\n        def load_app_view\n          return if app?\n\n          begin\n            slice.app.namespace.const_get(:View, false)\n          rescue NameError => exception\n            raise unless exception.name == :View\n          end\n        end\n\n        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n        def configure_view(view_class)\n          view_class.settings.each do |setting|\n            next unless slice.config.views.respond_to?(setting.name)\n\n            # Configure the view from config on the slice, _unless it has already been configured by\n            # a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its views config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # view classes.\n            #\n            # For example, given an app-level base view class, with custom config:\n            #\n            #   module MyApp\n            #     class View < Hanami::View\n            #       config.layout = \"custom_layout\"\n            #     end\n            #   end\n            #\n            # And then a view in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Views\n            #       class SomeView < MyApp::View\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredView` will be extended two times:\n            #\n            # 1. When `MyApp::View` is defined\n            # 2. Again when `MySlice::Views::SomeView` is defined\n            #\n            # If we blindly re-configure all view settings each time `SliceConfiguredView` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.layout` explicitly configured in the `MyApp::View` base class, leaving\n            # `MySlice::Views::SomeView` with `config.layout` of `\"app\"` (the default as specified\n            # at `Hanami.app.config.views.layout`), and not the `\"custom_layout\"` value configured\n            # in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.views.public_send(setting.name)\n            parent_value = slice.parent.config.views.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            view_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n\n          view_class.config.inflector = inflector\n\n          # Configure the paths for this view if:\n          #   - We are the app, and a user hasn't provided custom `paths` (in this case, we need to\n          #     set the defaults)\n          #   - We are a slice, and the view's inherited `paths` is identical to the parent's config\n          #     (which would result in the view in a slice erroneously trying to find templates in\n          #     the app)\n          if view_class.config.paths.empty? ||\n             (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])\n            view_class.config.paths = templates_path(slice)\n          end\n\n          view_class.config.template = template_name(view_class)\n          view_class.config.default_context = Extensions::View::Context.context_class(slice).new\n\n          view_class.config.part_class = part_class\n          view_class.config.scope_class = scope_class\n\n          if (part_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{PARTS_DIR}\"))\n            view_class.config.part_namespace = part_namespace\n          end\n          if (scope_namespace = namespace_from_path(\"#{VIEWS_DIR}/#{SCOPES_DIR}\"))\n            view_class.config.scope_namespace = scope_namespace\n          end\n        end\n        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity\n\n        def define_inherited\n          template_name = method(:template_name)\n\n          define_method(:inherited) do |subclass|\n            super(subclass)\n            subclass.config.template = template_name.(subclass)\n          end\n        end\n\n        def templates_path(slice)\n          if slice.app.equal?(slice)\n            slice.root.join(APP_DIR, TEMPLATES_DIR)\n          else\n            slice.root.join(TEMPLATES_DIR)\n          end\n        end\n\n        def namespace_from_path(path)\n          path = \"#{slice.slice_name.path}/#{path}\"\n\n          begin\n            require path\n          rescue LoadError => exception\n            raise exception unless exception.path == path\n          end\n\n          begin\n            inflector.constantize(inflector.camelize(path))\n          rescue NameError # rubocop: disable Lint/SuppressedException\n          end\n        end\n\n        def template_name(view_class)\n          inflector\n            .underscore(view_class.name)\n            .sub(/^#{slice.slice_name.path}\\//, \"\")\n            .sub(/^#{VIEWS_DIR}\\//, \"\")\n        end\n\n        def inflector\n          slice.inflector\n        end\n\n        def part_class\n          @part_class ||=\n            if views_namespace.const_defined?(:Part)\n              views_namespace.const_get(:Part)\n            else\n              views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, because the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def part_superclass\n          return Hanami::View::Part if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/part\"))\n          rescue NameError\n            Hanami::View::Part\n          end\n        end\n\n        def scope_class\n          @scope_class ||=\n            if views_namespace.const_defined?(:Scope)\n              views_namespace.const_get(:Scope)\n            else\n              views_namespace.const_set(:Scope, Class.new(scope_superclass).tap { |klass|\n                # Give the slice to `configure_for_slice`, since it cannot be inferred when it is\n                # called via `.inherited`, since the class is anonymous at this point\n                klass.configure_for_slice(slice)\n              })\n            end\n        end\n\n        def scope_superclass\n          return Hanami::View::Scope if app?\n\n          begin\n            inflector.constantize(inflector.camelize(\"#{slice.app.slice_name.name}/views/scope\"))\n          rescue NameError\n            Hanami::View::Scope\n          end\n        end\n\n        def views_namespace\n          @slice_views_namespace ||=\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n        end\n\n        def app?\n          slice.app == slice\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "scope_class", "signature": "def scope_class @scope_class ||=", "start_line": 205, "end_line": 216}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredView", "class_signature": "class SliceConfiguredView < < Module"}, "task_id": 659}
{"function_name": "define_new", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_part.rb", "focal_code": "def define_new\n          slice = self.slice\n\n          define_method(:new) do |**args|\n            return super(**args) if args.key?(:rendering)\n\n            slice_rendering = Class.new(Hanami::View)\n              .configure_for_slice(slice)\n              .new\n              .rendering\n\n            super(rendering: slice_rendering, **args)\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view part class defined within a\n      # slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredPart < Module\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(klass)\n          define_new\n        end\n\n        # @return [String]\n        #\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # Defines a `.new` method on the part class that provides a default `rendering:` argument of\n        # a rendering coming from a view configured for the slice. This means that any part can be\n        # initialized standalone (with a `value:` only) and still have access to all the integrated\n        # view facilities from the slice, such as helpers. This is helpful when unit testing parts.\n        #\n        # @example\n        #   module MyApp::Views::Parts\n        #     class Post < MyApp::View::Part\n        #       def title_tag\n        #         helpers.h1(value.title)\n        #       end\n        #     end\n        #   end\n        #\n        #   # Useful when unit testing parts\n        #   part = MyApp::Views::Parts::Post.new(value: hello_world_post)\n        #   part.title_tag # => \"<h1>Hello world</h1>\"\n        def define_new\n          slice = self.slice\n\n          define_method(:new) do |**args|\n            return super(**args) if args.key?(:rendering)\n\n            slice_rendering = Class.new(Hanami::View)\n              .configure_for_slice(slice)\n              .new\n              .rendering\n\n            super(rendering: slice_rendering, **args)\n          end\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_new", "signature": "def define_new slice = self.slice", "start_line": 54, "end_line": 67}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredPart", "class_signature": "class SliceConfiguredPart < < Module"}, "task_id": 660}
{"function_name": "context_superclass", "file_path": "hanami/lib/hanami/extensions/view/context.rb", "focal_code": "def context_superclass(slice)\n            return Hanami::View::Context if Hanami.app.equal?(slice)\n\n            begin\n              slice.inflector.constantize(\n                slice.inflector.camelize(\"#{slice.app.slice_name.name}/views/context\")\n              )\n            rescue NameError => exception\n              raise exception unless %i[Views Context].include?(exception.name)\n\n              Hanami::View::Context\n            end\n          end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"../../errors\"\nrequire_relative \"slice_configured_context\"\n\nmodule Hanami\n  module Extensions\n    module View\n      # View context for views in Hanami apps.\n      #\n      # @api public\n      # @since 2.1.0\n      module Context\n        class << self\n          # Returns a context class for the given slice. If a context class is not defined, defines\n          # a class named `Views::Context` within the slice's namespace.\n          #\n          # @api private\n          # @since 2.1.0\n          def context_class(slice)\n            views_namespace = views_namespace(slice)\n\n            if views_namespace.const_defined?(:Context)\n              return views_namespace.const_get(:Context)\n            end\n\n            views_namespace.const_set(:Context, Class.new(context_superclass(slice)).tap { |klass|\n              klass.configure_for_slice(slice)\n            })\n          end\n\n          private\n\n          # @api private\n          # @since 2.1.0\n          def context_superclass(slice)\n            return Hanami::View::Context if Hanami.app.equal?(slice)\n\n            begin\n              slice.inflector.constantize(\n                slice.inflector.camelize(\"#{slice.app.slice_name.name}/views/context\")\n              )\n            rescue NameError => exception\n              raise exception unless %i[Views Context].include?(exception.name)\n\n              Hanami::View::Context\n            end\n          end\n\n          # @api private\n          # @since 2.1.0\n          def views_namespace(slice)\n            # TODO: this could be moved into the top-level Extensions::View\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n          end\n        end\n\n        # @api private\n        # @since 2.1.0\n        module ClassExtension\n          def self.included(context_class)\n            super\n\n            context_class.extend(Hanami::SliceConfigurable)\n            context_class.extend(ClassMethods)\n            context_class.prepend(InstanceMethods)\n          end\n\n          # @api private\n          # @since 2.1.0\n          module ClassMethods\n            # @api private\n            # @since 2.1.0\n            def configure_for_slice(slice)\n              extend SliceConfiguredContext.new(slice)\n            end\n          end\n\n          # @api public\n          # @since 2.1.0\n          module InstanceMethods\n            # Returns the app's inflector.\n            #\n            # @return [Dry::Inflector] the inflector\n            #\n            # @api public\n            # @since 2.1.0\n            attr_reader :inflector\n\n            # @see SliceConfiguredContext#define_new\n            #\n            # @api private\n            # @since 2.1.0\n            def initialize(\n              inflector: nil,\n              routes: nil,\n              assets: nil,\n              request: nil,\n              **args\n            )\n              @inflector = inflector\n              @routes = routes\n              @assets = assets\n              @request = request\n\n              @content_for = {}\n\n              super(**args)\n            end\n\n            # @api private\n            # @since 2.1.0\n            def initialize_copy(source)\n              # The standard implementation of initialize_copy will make shallow copies of all\n              # instance variables from the source. This is fine for most of our ivars.\n              super\n\n              # Dup any objects that will be mutated over a given rendering to ensure no leakage of\n              # state across distinct view renderings.\n              @content_for = source.instance_variable_get(:@content_for).dup\n            end\n\n            # Returns the app's assets.\n            #\n            # @return [Hanami::Assets] the assets\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-assets gem is not bundled\n            #\n            # @api public\n            # @since 2.1.0\n            def assets\n              unless @assets\n                msg =\n                  if Hanami.bundled?(\"hanami-assets\")\n                    \"Have you put files into your assets directory?\"\n                  else\n                    \"The hanami-assets gem is required to access assets.\"\n                  end\n\n                raise Hanami::ComponentLoadError, \"Assets not available. #{msg}\"\n              end\n\n              @assets\n            end\n\n            # Returns the current request, if the view is rendered from within an action.\n            #\n            # @return [Hanami::Action::Request] the request\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            #\n            # @api public\n            # @since 2.1.0\n            def request\n              unless @request\n                raise Hanami::ComponentLoadError, <<~STR\n                  Request not available. Only views rendered from Hanami::Action instances have a request.\n                STR\n              end\n\n              @request\n            end\n\n            # Returns true if the view is rendered from within an action and a request is available.\n            #\n            # @return [Boolean]\n            #\n            # @api public\n            # @since 2.3.0\n            def request?\n              !!@request\n            end\n\n            # Returns the app's routes helper.\n            #\n            # @return [Hanami::Slice::RoutesHelper] the routes helper\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-router gem is not bundled or routes\n            #   are not defined\n            #\n            # @api public\n            # @since 2.1.0\n            def routes\n              unless @routes\n                raise Hanami::ComponentLoadError, \"the hanami-router gem is required to access routes\"\n              end\n\n              @routes\n            end\n\n            # @overload content_for(key, value = nil, &block)\n            #   Stores a string or block of template markup for later use.\n            #\n            #   @param key [Symbol] the content key, for later retrieval\n            #   @param value [String, nil] the content, if no block is given\n            #\n            #   @return [String] the content\n            #\n            #   @example\n            #     content_for(:page_title, \"Hello world\")\n            #\n            #   @example In a template\n            #     <%= content_for :page_title do %>\n            #       <h1>Hello world</h1>\n            #     <% end %>\n            #\n            # @overload content_for(key)\n            #   Returns the previously stored content for the given key.\n            #\n            #   @param key [Symbol] the content key\n            #\n            #   @return [String, nil] the content, or nil if no content previously stored with the\n            #     key\n            #\n            # @api public\n            # @since 2.1.0\n            def content_for(key, value = nil)\n              if block_given?\n                @content_for[key] = yield\n                nil\n              elsif value\n                @content_for[key] = value\n                nil\n              else\n                @content_for[key]\n              end\n            end\n\n            # Returns the current request's CSRF token.\n            #\n            # @return [String] the token\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def csrf_token\n              request.session[Hanami::Action::CSRFProtection::CSRF_TOKEN]\n            end\n\n            # Returns the session for the current request.\n            #\n            # @return [Rack::Session::Abstract::SessionHash] the session hash\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def session\n              request.session\n            end\n\n            # Returns the flash hash for the current request.\n            #\n            # @return []\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def flash\n              request.flash\n            end\n          end\n        end\n      end\n    end\n  end\nend\n\nHanami::View::Context.include(Hanami::Extensions::View::Context::ClassExtension)\n", "language": "ruby", "function_component": {"name": "context_superclass", "signature": "def context_superclass(slice)", "start_line": 36, "end_line": 48}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 661}
{"function_name": "initialize", "file_path": "hanami/lib/hanami/extensions/view/context.rb", "focal_code": "def initialize(\n              inflector: nil,\n              routes: nil,\n              assets: nil,\n              request: nil,\n              **args\n            )\n              @inflector = inflector\n              @routes = routes\n              @assets = assets\n              @request = request\n\n              @content_for = {}\n\n              super(**args)\n            end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"../../errors\"\nrequire_relative \"slice_configured_context\"\n\nmodule Hanami\n  module Extensions\n    module View\n      # View context for views in Hanami apps.\n      #\n      # @api public\n      # @since 2.1.0\n      module Context\n        class << self\n          # Returns a context class for the given slice. If a context class is not defined, defines\n          # a class named `Views::Context` within the slice's namespace.\n          #\n          # @api private\n          # @since 2.1.0\n          def context_class(slice)\n            views_namespace = views_namespace(slice)\n\n            if views_namespace.const_defined?(:Context)\n              return views_namespace.const_get(:Context)\n            end\n\n            views_namespace.const_set(:Context, Class.new(context_superclass(slice)).tap { |klass|\n              klass.configure_for_slice(slice)\n            })\n          end\n\n          private\n\n          # @api private\n          # @since 2.1.0\n          def context_superclass(slice)\n            return Hanami::View::Context if Hanami.app.equal?(slice)\n\n            begin\n              slice.inflector.constantize(\n                slice.inflector.camelize(\"#{slice.app.slice_name.name}/views/context\")\n              )\n            rescue NameError => exception\n              raise exception unless %i[Views Context].include?(exception.name)\n\n              Hanami::View::Context\n            end\n          end\n\n          # @api private\n          # @since 2.1.0\n          def views_namespace(slice)\n            # TODO: this could be moved into the top-level Extensions::View\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n          end\n        end\n\n        # @api private\n        # @since 2.1.0\n        module ClassExtension\n          def self.included(context_class)\n            super\n\n            context_class.extend(Hanami::SliceConfigurable)\n            context_class.extend(ClassMethods)\n            context_class.prepend(InstanceMethods)\n          end\n\n          # @api private\n          # @since 2.1.0\n          module ClassMethods\n            # @api private\n            # @since 2.1.0\n            def configure_for_slice(slice)\n              extend SliceConfiguredContext.new(slice)\n            end\n          end\n\n          # @api public\n          # @since 2.1.0\n          module InstanceMethods\n            # Returns the app's inflector.\n            #\n            # @return [Dry::Inflector] the inflector\n            #\n            # @api public\n            # @since 2.1.0\n            attr_reader :inflector\n\n            # @see SliceConfiguredContext#define_new\n            #\n            # @api private\n            # @since 2.1.0\n            def initialize(\n              inflector: nil,\n              routes: nil,\n              assets: nil,\n              request: nil,\n              **args\n            )\n              @inflector = inflector\n              @routes = routes\n              @assets = assets\n              @request = request\n\n              @content_for = {}\n\n              super(**args)\n            end\n\n            # @api private\n            # @since 2.1.0\n            def initialize_copy(source)\n              # The standard implementation of initialize_copy will make shallow copies of all\n              # instance variables from the source. This is fine for most of our ivars.\n              super\n\n              # Dup any objects that will be mutated over a given rendering to ensure no leakage of\n              # state across distinct view renderings.\n              @content_for = source.instance_variable_get(:@content_for).dup\n            end\n\n            # Returns the app's assets.\n            #\n            # @return [Hanami::Assets] the assets\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-assets gem is not bundled\n            #\n            # @api public\n            # @since 2.1.0\n            def assets\n              unless @assets\n                msg =\n                  if Hanami.bundled?(\"hanami-assets\")\n                    \"Have you put files into your assets directory?\"\n                  else\n                    \"The hanami-assets gem is required to access assets.\"\n                  end\n\n                raise Hanami::ComponentLoadError, \"Assets not available. #{msg}\"\n              end\n\n              @assets\n            end\n\n            # Returns the current request, if the view is rendered from within an action.\n            #\n            # @return [Hanami::Action::Request] the request\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            #\n            # @api public\n            # @since 2.1.0\n            def request\n              unless @request\n                raise Hanami::ComponentLoadError, <<~STR\n                  Request not available. Only views rendered from Hanami::Action instances have a request.\n                STR\n              end\n\n              @request\n            end\n\n            # Returns true if the view is rendered from within an action and a request is available.\n            #\n            # @return [Boolean]\n            #\n            # @api public\n            # @since 2.3.0\n            def request?\n              !!@request\n            end\n\n            # Returns the app's routes helper.\n            #\n            # @return [Hanami::Slice::RoutesHelper] the routes helper\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-router gem is not bundled or routes\n            #   are not defined\n            #\n            # @api public\n            # @since 2.1.0\n            def routes\n              unless @routes\n                raise Hanami::ComponentLoadError, \"the hanami-router gem is required to access routes\"\n              end\n\n              @routes\n            end\n\n            # @overload content_for(key, value = nil, &block)\n            #   Stores a string or block of template markup for later use.\n            #\n            #   @param key [Symbol] the content key, for later retrieval\n            #   @param value [String, nil] the content, if no block is given\n            #\n            #   @return [String] the content\n            #\n            #   @example\n            #     content_for(:page_title, \"Hello world\")\n            #\n            #   @example In a template\n            #     <%= content_for :page_title do %>\n            #       <h1>Hello world</h1>\n            #     <% end %>\n            #\n            # @overload content_for(key)\n            #   Returns the previously stored content for the given key.\n            #\n            #   @param key [Symbol] the content key\n            #\n            #   @return [String, nil] the content, or nil if no content previously stored with the\n            #     key\n            #\n            # @api public\n            # @since 2.1.0\n            def content_for(key, value = nil)\n              if block_given?\n                @content_for[key] = yield\n                nil\n              elsif value\n                @content_for[key] = value\n                nil\n              else\n                @content_for[key]\n              end\n            end\n\n            # Returns the current request's CSRF token.\n            #\n            # @return [String] the token\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def csrf_token\n              request.session[Hanami::Action::CSRFProtection::CSRF_TOKEN]\n            end\n\n            # Returns the session for the current request.\n            #\n            # @return [Rack::Session::Abstract::SessionHash] the session hash\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def session\n              request.session\n            end\n\n            # Returns the flash hash for the current request.\n            #\n            # @return []\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def flash\n              request.flash\n            end\n          end\n        end\n      end\n    end\n  end\nend\n\nHanami::View::Context.include(Hanami::Extensions::View::Context::ClassExtension)\n", "language": "ruby", "function_component": {"name": "initialize", "signature": "def initialize( inflector: nil, routes: nil, assets: nil, request: nil, **args )", "start_line": 98, "end_line": 113}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 662}
{"function_name": "assets", "file_path": "hanami/lib/hanami/extensions/view/context.rb", "focal_code": "def assets\n              unless @assets\n                msg =\n                  if Hanami.bundled?(\"hanami-assets\")\n                    \"Have you put files into your assets directory?\"\n                  else\n                    \"The hanami-assets gem is required to access assets.\"\n                  end\n\n                raise Hanami::ComponentLoadError, \"Assets not available. #{msg}\"\n              end\n\n              @assets\n            end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"../../errors\"\nrequire_relative \"slice_configured_context\"\n\nmodule Hanami\n  module Extensions\n    module View\n      # View context for views in Hanami apps.\n      #\n      # @api public\n      # @since 2.1.0\n      module Context\n        class << self\n          # Returns a context class for the given slice. If a context class is not defined, defines\n          # a class named `Views::Context` within the slice's namespace.\n          #\n          # @api private\n          # @since 2.1.0\n          def context_class(slice)\n            views_namespace = views_namespace(slice)\n\n            if views_namespace.const_defined?(:Context)\n              return views_namespace.const_get(:Context)\n            end\n\n            views_namespace.const_set(:Context, Class.new(context_superclass(slice)).tap { |klass|\n              klass.configure_for_slice(slice)\n            })\n          end\n\n          private\n\n          # @api private\n          # @since 2.1.0\n          def context_superclass(slice)\n            return Hanami::View::Context if Hanami.app.equal?(slice)\n\n            begin\n              slice.inflector.constantize(\n                slice.inflector.camelize(\"#{slice.app.slice_name.name}/views/context\")\n              )\n            rescue NameError => exception\n              raise exception unless %i[Views Context].include?(exception.name)\n\n              Hanami::View::Context\n            end\n          end\n\n          # @api private\n          # @since 2.1.0\n          def views_namespace(slice)\n            # TODO: this could be moved into the top-level Extensions::View\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n          end\n        end\n\n        # @api private\n        # @since 2.1.0\n        module ClassExtension\n          def self.included(context_class)\n            super\n\n            context_class.extend(Hanami::SliceConfigurable)\n            context_class.extend(ClassMethods)\n            context_class.prepend(InstanceMethods)\n          end\n\n          # @api private\n          # @since 2.1.0\n          module ClassMethods\n            # @api private\n            # @since 2.1.0\n            def configure_for_slice(slice)\n              extend SliceConfiguredContext.new(slice)\n            end\n          end\n\n          # @api public\n          # @since 2.1.0\n          module InstanceMethods\n            # Returns the app's inflector.\n            #\n            # @return [Dry::Inflector] the inflector\n            #\n            # @api public\n            # @since 2.1.0\n            attr_reader :inflector\n\n            # @see SliceConfiguredContext#define_new\n            #\n            # @api private\n            # @since 2.1.0\n            def initialize(\n              inflector: nil,\n              routes: nil,\n              assets: nil,\n              request: nil,\n              **args\n            )\n              @inflector = inflector\n              @routes = routes\n              @assets = assets\n              @request = request\n\n              @content_for = {}\n\n              super(**args)\n            end\n\n            # @api private\n            # @since 2.1.0\n            def initialize_copy(source)\n              # The standard implementation of initialize_copy will make shallow copies of all\n              # instance variables from the source. This is fine for most of our ivars.\n              super\n\n              # Dup any objects that will be mutated over a given rendering to ensure no leakage of\n              # state across distinct view renderings.\n              @content_for = source.instance_variable_get(:@content_for).dup\n            end\n\n            # Returns the app's assets.\n            #\n            # @return [Hanami::Assets] the assets\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-assets gem is not bundled\n            #\n            # @api public\n            # @since 2.1.0\n            def assets\n              unless @assets\n                msg =\n                  if Hanami.bundled?(\"hanami-assets\")\n                    \"Have you put files into your assets directory?\"\n                  else\n                    \"The hanami-assets gem is required to access assets.\"\n                  end\n\n                raise Hanami::ComponentLoadError, \"Assets not available. #{msg}\"\n              end\n\n              @assets\n            end\n\n            # Returns the current request, if the view is rendered from within an action.\n            #\n            # @return [Hanami::Action::Request] the request\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            #\n            # @api public\n            # @since 2.1.0\n            def request\n              unless @request\n                raise Hanami::ComponentLoadError, <<~STR\n                  Request not available. Only views rendered from Hanami::Action instances have a request.\n                STR\n              end\n\n              @request\n            end\n\n            # Returns true if the view is rendered from within an action and a request is available.\n            #\n            # @return [Boolean]\n            #\n            # @api public\n            # @since 2.3.0\n            def request?\n              !!@request\n            end\n\n            # Returns the app's routes helper.\n            #\n            # @return [Hanami::Slice::RoutesHelper] the routes helper\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-router gem is not bundled or routes\n            #   are not defined\n            #\n            # @api public\n            # @since 2.1.0\n            def routes\n              unless @routes\n                raise Hanami::ComponentLoadError, \"the hanami-router gem is required to access routes\"\n              end\n\n              @routes\n            end\n\n            # @overload content_for(key, value = nil, &block)\n            #   Stores a string or block of template markup for later use.\n            #\n            #   @param key [Symbol] the content key, for later retrieval\n            #   @param value [String, nil] the content, if no block is given\n            #\n            #   @return [String] the content\n            #\n            #   @example\n            #     content_for(:page_title, \"Hello world\")\n            #\n            #   @example In a template\n            #     <%= content_for :page_title do %>\n            #       <h1>Hello world</h1>\n            #     <% end %>\n            #\n            # @overload content_for(key)\n            #   Returns the previously stored content for the given key.\n            #\n            #   @param key [Symbol] the content key\n            #\n            #   @return [String, nil] the content, or nil if no content previously stored with the\n            #     key\n            #\n            # @api public\n            # @since 2.1.0\n            def content_for(key, value = nil)\n              if block_given?\n                @content_for[key] = yield\n                nil\n              elsif value\n                @content_for[key] = value\n                nil\n              else\n                @content_for[key]\n              end\n            end\n\n            # Returns the current request's CSRF token.\n            #\n            # @return [String] the token\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def csrf_token\n              request.session[Hanami::Action::CSRFProtection::CSRF_TOKEN]\n            end\n\n            # Returns the session for the current request.\n            #\n            # @return [Rack::Session::Abstract::SessionHash] the session hash\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def session\n              request.session\n            end\n\n            # Returns the flash hash for the current request.\n            #\n            # @return []\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def flash\n              request.flash\n            end\n          end\n        end\n      end\n    end\n  end\nend\n\nHanami::View::Context.include(Hanami::Extensions::View::Context::ClassExtension)\n", "language": "ruby", "function_component": {"name": "assets", "signature": "def assets unless @assets", "start_line": 135, "end_line": 148}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 663}
{"function_name": "content_for", "file_path": "hanami/lib/hanami/extensions/view/context.rb", "focal_code": "def content_for(key, value = nil)\n              if block_given?\n                @content_for[key] = yield\n                nil\n              elsif value\n                @content_for[key] = value\n                nil\n              else\n                @content_for[key]\n              end\n            end", "file_content": "# frozen_string_literal: true\n\nrequire_relative \"../../errors\"\nrequire_relative \"slice_configured_context\"\n\nmodule Hanami\n  module Extensions\n    module View\n      # View context for views in Hanami apps.\n      #\n      # @api public\n      # @since 2.1.0\n      module Context\n        class << self\n          # Returns a context class for the given slice. If a context class is not defined, defines\n          # a class named `Views::Context` within the slice's namespace.\n          #\n          # @api private\n          # @since 2.1.0\n          def context_class(slice)\n            views_namespace = views_namespace(slice)\n\n            if views_namespace.const_defined?(:Context)\n              return views_namespace.const_get(:Context)\n            end\n\n            views_namespace.const_set(:Context, Class.new(context_superclass(slice)).tap { |klass|\n              klass.configure_for_slice(slice)\n            })\n          end\n\n          private\n\n          # @api private\n          # @since 2.1.0\n          def context_superclass(slice)\n            return Hanami::View::Context if Hanami.app.equal?(slice)\n\n            begin\n              slice.inflector.constantize(\n                slice.inflector.camelize(\"#{slice.app.slice_name.name}/views/context\")\n              )\n            rescue NameError => exception\n              raise exception unless %i[Views Context].include?(exception.name)\n\n              Hanami::View::Context\n            end\n          end\n\n          # @api private\n          # @since 2.1.0\n          def views_namespace(slice)\n            # TODO: this could be moved into the top-level Extensions::View\n            if slice.namespace.const_defined?(:Views)\n              slice.namespace.const_get(:Views)\n            else\n              slice.namespace.const_set(:Views, Module.new)\n            end\n          end\n        end\n\n        # @api private\n        # @since 2.1.0\n        module ClassExtension\n          def self.included(context_class)\n            super\n\n            context_class.extend(Hanami::SliceConfigurable)\n            context_class.extend(ClassMethods)\n            context_class.prepend(InstanceMethods)\n          end\n\n          # @api private\n          # @since 2.1.0\n          module ClassMethods\n            # @api private\n            # @since 2.1.0\n            def configure_for_slice(slice)\n              extend SliceConfiguredContext.new(slice)\n            end\n          end\n\n          # @api public\n          # @since 2.1.0\n          module InstanceMethods\n            # Returns the app's inflector.\n            #\n            # @return [Dry::Inflector] the inflector\n            #\n            # @api public\n            # @since 2.1.0\n            attr_reader :inflector\n\n            # @see SliceConfiguredContext#define_new\n            #\n            # @api private\n            # @since 2.1.0\n            def initialize(\n              inflector: nil,\n              routes: nil,\n              assets: nil,\n              request: nil,\n              **args\n            )\n              @inflector = inflector\n              @routes = routes\n              @assets = assets\n              @request = request\n\n              @content_for = {}\n\n              super(**args)\n            end\n\n            # @api private\n            # @since 2.1.0\n            def initialize_copy(source)\n              # The standard implementation of initialize_copy will make shallow copies of all\n              # instance variables from the source. This is fine for most of our ivars.\n              super\n\n              # Dup any objects that will be mutated over a given rendering to ensure no leakage of\n              # state across distinct view renderings.\n              @content_for = source.instance_variable_get(:@content_for).dup\n            end\n\n            # Returns the app's assets.\n            #\n            # @return [Hanami::Assets] the assets\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-assets gem is not bundled\n            #\n            # @api public\n            # @since 2.1.0\n            def assets\n              unless @assets\n                msg =\n                  if Hanami.bundled?(\"hanami-assets\")\n                    \"Have you put files into your assets directory?\"\n                  else\n                    \"The hanami-assets gem is required to access assets.\"\n                  end\n\n                raise Hanami::ComponentLoadError, \"Assets not available. #{msg}\"\n              end\n\n              @assets\n            end\n\n            # Returns the current request, if the view is rendered from within an action.\n            #\n            # @return [Hanami::Action::Request] the request\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            #\n            # @api public\n            # @since 2.1.0\n            def request\n              unless @request\n                raise Hanami::ComponentLoadError, <<~STR\n                  Request not available. Only views rendered from Hanami::Action instances have a request.\n                STR\n              end\n\n              @request\n            end\n\n            # Returns true if the view is rendered from within an action and a request is available.\n            #\n            # @return [Boolean]\n            #\n            # @api public\n            # @since 2.3.0\n            def request?\n              !!@request\n            end\n\n            # Returns the app's routes helper.\n            #\n            # @return [Hanami::Slice::RoutesHelper] the routes helper\n            #\n            # @raise [Hanami::ComponentLoadError] if the hanami-router gem is not bundled or routes\n            #   are not defined\n            #\n            # @api public\n            # @since 2.1.0\n            def routes\n              unless @routes\n                raise Hanami::ComponentLoadError, \"the hanami-router gem is required to access routes\"\n              end\n\n              @routes\n            end\n\n            # @overload content_for(key, value = nil, &block)\n            #   Stores a string or block of template markup for later use.\n            #\n            #   @param key [Symbol] the content key, for later retrieval\n            #   @param value [String, nil] the content, if no block is given\n            #\n            #   @return [String] the content\n            #\n            #   @example\n            #     content_for(:page_title, \"Hello world\")\n            #\n            #   @example In a template\n            #     <%= content_for :page_title do %>\n            #       <h1>Hello world</h1>\n            #     <% end %>\n            #\n            # @overload content_for(key)\n            #   Returns the previously stored content for the given key.\n            #\n            #   @param key [Symbol] the content key\n            #\n            #   @return [String, nil] the content, or nil if no content previously stored with the\n            #     key\n            #\n            # @api public\n            # @since 2.1.0\n            def content_for(key, value = nil)\n              if block_given?\n                @content_for[key] = yield\n                nil\n              elsif value\n                @content_for[key] = value\n                nil\n              else\n                @content_for[key]\n              end\n            end\n\n            # Returns the current request's CSRF token.\n            #\n            # @return [String] the token\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def csrf_token\n              request.session[Hanami::Action::CSRFProtection::CSRF_TOKEN]\n            end\n\n            # Returns the session for the current request.\n            #\n            # @return [Rack::Session::Abstract::SessionHash] the session hash\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def session\n              request.session\n            end\n\n            # Returns the flash hash for the current request.\n            #\n            # @return []\n            #\n            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request\n            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled\n            #\n            # @api public\n            # @since 2.1.0\n            def flash\n              request.flash\n            end\n          end\n        end\n      end\n    end\n  end\nend\n\nHanami::View::Context.include(Hanami::Extensions::View::Context::ClassExtension)\n", "language": "ruby", "function_component": {"name": "content_for", "signature": "def content_for(key, value = nil)", "start_line": 221, "end_line": 231}, "metadata": {"module": "Hanami", "class_name": "", "class_signature": ""}, "task_id": 664}
{"function_name": "define_new", "file_path": "hanami/lib/hanami/extensions/view/slice_configured_context.rb", "focal_code": "def define_new\n          inflector = slice.inflector\n          resolve_routes = method(:resolve_routes)\n          resolve_assets = method(:resolve_assets)\n\n          define_method :new do |**kwargs|\n            kwargs[:inflector] ||= inflector\n            kwargs[:routes] ||= resolve_routes.()\n            kwargs[:assets] ||= resolve_assets.()\n\n            super(**kwargs)\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module View\n      # Provides slice-specific configuration and behavior for any view context class defined within\n      # a slice's module namespace.\n      #\n      # @api public\n      # @since 2.1.0\n      class SliceConfiguredContext < Module\n        attr_reader :slice\n\n        # @api private\n        # @since 2.1.0\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        # @api private\n        # @since 2.1.0\n        def extended(_context_class)\n          define_new\n        end\n\n        # @api public\n        # @since 2.1.0\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # Defines a {.new} method on the context class that resolves key components from the app\n        # container and provides them to {#initialize} as injected dependencies.\n        #\n        # This includes the following app components:\n        #   - the configured inflector as `inflector`\n        #   - \"routes\" from the app container as `routes`\n        #   - \"assets\" from the app container as `assets`\n        def define_new\n          inflector = slice.inflector\n          resolve_routes = method(:resolve_routes)\n          resolve_assets = method(:resolve_assets)\n\n          define_method :new do |**kwargs|\n            kwargs[:inflector] ||= inflector\n            kwargs[:routes] ||= resolve_routes.()\n            kwargs[:assets] ||= resolve_assets.()\n\n            super(**kwargs)\n          end\n        end\n\n        def resolve_routes\n          slice[\"routes\"] if slice.key?(\"routes\")\n        end\n\n        def resolve_assets\n          slice[\"assets\"] if slice.key?(\"assets\")\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_new", "signature": "def define_new inflector = slice.inflector", "start_line": 42, "end_line": 54}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredContext", "class_signature": "class SliceConfiguredContext < < Module"}, "task_id": 665}
{"function_name": "define_new", "file_path": "hanami/lib/hanami/extensions/action/slice_configured_action.rb", "focal_code": "def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Action\n      # Provides slice-specific configuration and behavior for any action class defined\n      # within a slice's module namespace.\n      #\n      # @api private\n      # @since 2.0.0\n      class SliceConfiguredAction < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(action_class)\n          configure_action(action_class)\n          extend_behavior(action_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # @see Hanami::Extensions::Action::InstanceMethods#initialize\n        def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end\n\n        def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end\n\n        def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end\n\n        def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end\n\n        def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end\n\n        def resolve_routes\n          slice.app[\"routes\"] if slice.app.key?(\"routes\")\n        end\n\n        def resolve_rack_monitor\n          slice.app[\"rack.monitor\"] if slice.app.key?(\"rack.monitor\")\n        end\n\n        def actions_config\n          slice.config.actions\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "define_new", "signature": "def define_new resolve_view = method(:resolve_paired_view)", "start_line": 32, "end_line": 47}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredAction", "class_signature": "class SliceConfiguredAction < < Module"}, "task_id": 666}
{"function_name": "configure_action", "file_path": "hanami/lib/hanami/extensions/action/slice_configured_action.rb", "focal_code": "def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Action\n      # Provides slice-specific configuration and behavior for any action class defined\n      # within a slice's module namespace.\n      #\n      # @api private\n      # @since 2.0.0\n      class SliceConfiguredAction < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(action_class)\n          configure_action(action_class)\n          extend_behavior(action_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # @see Hanami::Extensions::Action::InstanceMethods#initialize\n        def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end\n\n        def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end\n\n        def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end\n\n        def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end\n\n        def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end\n\n        def resolve_routes\n          slice.app[\"routes\"] if slice.app.key?(\"routes\")\n        end\n\n        def resolve_rack_monitor\n          slice.app[\"rack.monitor\"] if slice.app.key?(\"rack.monitor\")\n        end\n\n        def actions_config\n          slice.config.actions\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "configure_action", "signature": "def configure_action(action_class)", "start_line": 49, "end_line": 99}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredAction", "class_signature": "class SliceConfiguredAction < < Module"}, "task_id": 667}
{"function_name": "extend_behavior", "file_path": "hanami/lib/hanami/extensions/action/slice_configured_action.rb", "focal_code": "def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Action\n      # Provides slice-specific configuration and behavior for any action class defined\n      # within a slice's module namespace.\n      #\n      # @api private\n      # @since 2.0.0\n      class SliceConfiguredAction < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(action_class)\n          configure_action(action_class)\n          extend_behavior(action_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # @see Hanami::Extensions::Action::InstanceMethods#initialize\n        def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end\n\n        def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end\n\n        def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end\n\n        def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end\n\n        def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end\n\n        def resolve_routes\n          slice.app[\"routes\"] if slice.app.key?(\"routes\")\n        end\n\n        def resolve_rack_monitor\n          slice.app[\"rack.monitor\"] if slice.app.key?(\"rack.monitor\")\n        end\n\n        def actions_config\n          slice.config.actions\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "extend_behavior", "signature": "def extend_behavior(action_class)", "start_line": 101, "end_line": 116}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredAction", "class_signature": "class SliceConfiguredAction < < Module"}, "task_id": 668}
{"function_name": "resolve_paired_view", "file_path": "hanami/lib/hanami/extensions/action/slice_configured_action.rb", "focal_code": "def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Action\n      # Provides slice-specific configuration and behavior for any action class defined\n      # within a slice's module namespace.\n      #\n      # @api private\n      # @since 2.0.0\n      class SliceConfiguredAction < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(action_class)\n          configure_action(action_class)\n          extend_behavior(action_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # @see Hanami::Extensions::Action::InstanceMethods#initialize\n        def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end\n\n        def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end\n\n        def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end\n\n        def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end\n\n        def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end\n\n        def resolve_routes\n          slice.app[\"routes\"] if slice.app.key?(\"routes\")\n        end\n\n        def resolve_rack_monitor\n          slice.app[\"rack.monitor\"] if slice.app.key?(\"rack.monitor\")\n        end\n\n        def actions_config\n          slice.config.actions\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "resolve_paired_view", "signature": "def resolve_paired_view(action_class)", "start_line": 118, "end_line": 129}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredAction", "class_signature": "class SliceConfiguredAction < < Module"}, "task_id": 669}
{"function_name": "view_context_class", "file_path": "hanami/lib/hanami/extensions/action/slice_configured_action.rb", "focal_code": "def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nmodule Hanami\n  module Extensions\n    module Action\n      # Provides slice-specific configuration and behavior for any action class defined\n      # within a slice's module namespace.\n      #\n      # @api private\n      # @since 2.0.0\n      class SliceConfiguredAction < Module\n        attr_reader :slice\n\n        def initialize(slice)\n          super()\n          @slice = slice\n        end\n\n        def extended(action_class)\n          configure_action(action_class)\n          extend_behavior(action_class)\n          define_new\n        end\n\n        def inspect\n          \"#<#{self.class.name}[#{slice.name}]>\"\n        end\n\n        private\n\n        # @see Hanami::Extensions::Action::InstanceMethods#initialize\n        def define_new\n          resolve_view = method(:resolve_paired_view)\n          view_context_class = method(:view_context_class)\n          resolve_routes = method(:resolve_routes)\n          resolve_rack_monitor = method(:resolve_rack_monitor)\n\n          define_method(:new) do |**kwargs|\n            super(\n              view: kwargs.fetch(:view) { resolve_view.(self) },\n              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },\n              routes: kwargs.fetch(:routes) { resolve_routes.() },\n              rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },\n              **kwargs,\n            )\n          end\n        end\n\n        def configure_action(action_class)\n          action_class.settings.each do |setting|\n            # Configure the action from config on the slice, _unless it has already been configured\n            # by a parent slice_, and re-configuring it for this slice would make no change.\n            #\n            # In the case of most slices, its actions config is likely to be the same as its parent\n            # (since each slice copies its `config` from its parent), and if we re-apply the config\n            # here, then it may possibly overwrite config customisations explicitly made in parent\n            # action classes.\n            #\n            # For example, given an app-level base action class, with custom config:\n            #\n            #   module MyApp\n            #     class Action < Hanami::Action\n            #       config.format :json\n            #     end\n            #   end\n            #\n            # And then an action in a slice inheriting from it:\n            #\n            #   module MySlice\n            #     module Actions\n            #       class SomeAction < MyApp::Action\n            #       end\n            #     end\n            #   end\n            #\n            # In this case, `SliceConfiguredAction` will be extended two times:\n            #\n            # 1. When `MyApp::Action` is defined\n            # 2. Again when `MySlice::Actions::SomeAction` is defined\n            #\n            # If we blindly re-configure all action settings each time `SliceConfiguredAction` is\n            # extended, then at the point of (2) above, we'd end up overwriting the custom\n            # `config.default_response_format` explicitly configured in the `MyApp::Action` base\n            # class, leaving `MySlice::Actions::SomeAction` with `config.default_response_format` of\n            # `:html` (the default at `Hanami.app.config.actions.default_response_format`), and not\n            # the `:json` value configured in its immediate superclass.\n            #\n            # This would be surprising behavior, and we want to avoid it.\n            slice_value = slice.config.actions.public_send(setting.name)\n            parent_value = slice.parent.config.actions.public_send(setting.name) if slice.parent\n\n            next if slice.parent && slice_value == parent_value\n\n            action_class.config.public_send(\n              :\"#{setting.name}=\",\n              setting.mutable? ? slice_value.dup : slice_value\n            )\n          end\n        end\n\n        def extend_behavior(action_class)\n          if actions_config.sessions.enabled?\n            require \"hanami/action/session\"\n            action_class.include Hanami::Action::Session\n          end\n\n          if actions_config.csrf_protection\n            require \"hanami/action/csrf_protection\"\n            action_class.include Hanami::Action::CSRFProtection\n          end\n\n          if actions_config.cookies.enabled?\n            require \"hanami/action/cookies\"\n            action_class.include Hanami::Action::Cookies\n          end\n        end\n\n        def resolve_paired_view(action_class)\n          view_identifiers = actions_config.view_name_inferrer.call(\n            action_class_name: action_class.name,\n            slice: slice\n          )\n\n          view_identifiers.each do |identifier|\n            return slice[identifier] if slice.key?(identifier)\n          end\n\n          nil\n        end\n\n        def view_context_class\n          if Hanami.bundled?(\"hanami-view\")\n            return Extensions::View::Context.context_class(slice)\n          end\n\n          # If hanami-view isn't bundled, try and find a possible third party context class with the\n          # same `Views::Context` name (but don't fall back to automatically defining one).\n          if slice.namespace.const_defined?(:Views)\n            views_namespace = slice.namespace.const_get(:Views)\n\n            if views_namespace.const_defined?(:Context)\n              views_namespace.const_get(:Context)\n            end\n          end\n        end\n\n        def resolve_routes\n          slice.app[\"routes\"] if slice.app.key?(\"routes\")\n        end\n\n        def resolve_rack_monitor\n          slice.app[\"rack.monitor\"] if slice.app.key?(\"rack.monitor\")\n        end\n\n        def actions_config\n          slice.config.actions\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "view_context_class", "signature": "def view_context_class if Hanami.bundled?(\"hanami-view\")", "start_line": 131, "end_line": 145}, "metadata": {"module": "Hanami", "class_name": "SliceConfiguredAction", "class_signature": "class SliceConfiguredAction < < Module"}, "task_id": 670}
{"function_name": "call", "file_path": "hanami/lib/hanami/helpers/form_helper/form_builder.rb", "focal_code": "def call(content, **attributes)\n          attributes[\"accept-charset\"] ||= DEFAULT_CHARSET\n\n          method_override, original_form_method = _form_method(attributes)\n          csrf_token, token = _csrf_token(values, attributes)\n\n          tag.form(**attributes) do\n            (+\"\").tap { |inner|\n              inner << input(type: \"hidden\", name: \"_method\", value: original_form_method) if method_override\n              inner << input(type: \"hidden\", name: \"_csrf_token\", value: token) if csrf_token\n              inner << content\n            }.html_safe\n          end\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/view\"\nrequire_relative \"values\"\n\nmodule Hanami\n  module Helpers\n    module FormHelper\n      # A range of convenient methods for building the fields within an HTML form, integrating with\n      # request params and template locals to populate the fields with appropriate values.\n      #\n      # @see FormHelper#form_for\n      #\n      # @api public\n      # @since 2.1.0\n      class FormBuilder\n        # Set of HTTP methods that are understood by web browsers\n        #\n        # @since 2.1.0\n        # @api private\n        BROWSER_METHODS = %w[GET POST].freeze\n        private_constant :BROWSER_METHODS\n\n        # Set of HTTP methods that should NOT generate CSRF token\n        #\n        # @since 2.1.0\n        # @api private\n        EXCLUDED_CSRF_METHODS = %w[GET].freeze\n        private_constant :EXCLUDED_CSRF_METHODS\n\n        # Separator for accept attribute of file input\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #file_input\n        ACCEPT_SEPARATOR = \",\"\n        private_constant :ACCEPT_SEPARATOR\n\n        # Default value for unchecked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_UNCHECKED_VALUE = \"0\"\n        private_constant :DEFAULT_UNCHECKED_VALUE\n\n        # Default value for checked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_CHECKED_VALUE = \"1\"\n        private_constant :DEFAULT_CHECKED_VALUE\n\n        # Input name separator\n        #\n        # @since 2.1.0\n        # @api private\n        INPUT_NAME_SEPARATOR = \".\"\n        private_constant :INPUT_NAME_SEPARATOR\n\n        # Empty string\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #password_field\n        EMPTY_STRING = \"\"\n        private_constant :EMPTY_STRING\n\n        include Hanami::View::Helpers::EscapeHelper\n        include Hanami::View::Helpers::TagHelper\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :base_name\n        private :base_name\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :values\n        private :values\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :inflector\n        private :inflector\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :form_attributes\n        private :form_attributes\n\n        # Returns a new form builder.\n        #\n        # @param inflector [Dry::Inflector] the app inflector\n        # @param base_name [String, nil] the base name to use for all fields in the form\n        # @param values [Hanami::Helpers::FormHelper::Values] the values for the form\n        #\n        # @return [self]\n        #\n        # @see Hanami::Helpers::FormHelper#form_for\n        #\n        # @api private\n        # @since 2.1.0\n        def initialize(inflector:, form_attributes:, base_name: nil, values: Values.new)\n          @base_name = base_name\n          @values = values\n          @form_attributes = form_attributes\n          @inflector = inflector\n        end\n\n        # @api private\n        # @since 2.1.0\n        def call(content, **attributes)\n          attributes[\"accept-charset\"] ||= DEFAULT_CHARSET\n\n          method_override, original_form_method = _form_method(attributes)\n          csrf_token, token = _csrf_token(values, attributes)\n\n          tag.form(**attributes) do\n            (+\"\").tap { |inner|\n              inner << input(type: \"hidden\", name: \"_method\", value: original_form_method) if method_override\n              inner << input(type: \"hidden\", name: \"_csrf_token\", value: token) if csrf_token\n              inner << content\n            }.html_safe\n          end\n        end\n\n        # Applies the base input name to all fields within the given block.\n        #\n        # This can be helpful when generating a set of nested fields.\n        #\n        # This is a convenience only. You can achieve the same result by including the base name at\n        # the beginning of each input name.\n        #\n        # @param name [String] the base name to be used for all fields in the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        #\n        # @example Basic usage\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #     <%= fa.text_field \"suburb\" %>\n        #   <% end %>\n        #\n        #   # A convenience for:\n        #   # <%= f.text_field \"address.street\" %>\n        #   # <%= f.text_field \"address.suburb\" %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[customer_name]\" id=\"delivery-customer-name\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #\n        # @example Multiple levels of nesting\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #\n        #     <% fa.fields_for \"location\" do |fl| %>\n        #       <%= fl.text_field \"city\" %>\n        #     <% end %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][location][city]\" id=\"delivery-address-location-city\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for(name, *yield_args)\n          new_base_name = [base_name, name.to_s].compact.join(INPUT_NAME_SEPARATOR)\n\n          builder = self.class.new(\n            base_name: new_base_name,\n            values: values,\n            form_attributes: form_attributes,\n            inflector: inflector\n          )\n\n          yield(builder, *yield_args)\n        end\n\n        # Yields to the given block for each element in the matching collection value, and applies\n        # the base input name to all fields within the block.\n        #\n        # Use this whenever generating form fields for an collection of nested fields.\n        #\n        # @param name [String] the input name, also used as the base input name for all fields\n        #   within the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        # @yieldparam [Integer] the index of the iteration over the collection, starting from zero\n        # @yieldparam [Object] the value of the element from the collection\n        #\n        # @example Basic usage\n        #   <% f.fields_for_collection(\"addresses\") do |fa| %>\n        #     <%= fa.text_field(\"street\") %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-0-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-1-street\" value=\"\">\n        #\n        # @example Yielding index and value\n        #   <% f.fields_for_collection(\"bill.addresses\") do |fa, i, address| %>\n        #     <div class=\"form-group\">\n        #       Address id: <%= address.id %>\n        #       <%= fa.label(\"street\") %>\n        #       <%= fa.text_field(\"street\", data: {index: i.to_s}) %>\n        #     </div>\n        #   <% end %>\n        #\n        #   =>\n        #   <div class=\"form-group\">\n        #     Address id: 23\n        #     <label for=\"bill-addresses-0-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-0-street\" value=\"5th Ave\" data-index=\"0\">\n        #   </div>\n        #   <div class=\"form-group\">\n        #     Address id: 42\n        #     <label for=\"bill-addresses-1-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-1-street\" value=\"4th Ave\" data-index=\"1\">\n        #   </div>\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for_collection(name, &block)\n          _value(name).each_with_index do |value, index|\n            fields_for(\"#{name}.#{index}\", index, value, &block)\n          end\n        end\n\n        # Returns a label tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload label(field_name, **attributes)\n        #   Returns a label tag for the given field name, with a humanized version of the field name\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Extended title</label>\n        #\n        #   @example HTML attributes\n        #     <%= f.label(\"book.title\", class: \"form-label\") %>\n        #     # => <label for=\"book-title\" class=\"form-label\">Title</label>\n        #\n        # @overload label(content, **attributes)\n        #   Returns a label tag for the field name given as `for:`, with the given content string as\n        #   the tag's content.\n        #\n        #   @param content [String] the tag's content\n        #   @param for [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"Title\", for: \"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Title</label>\n        #\n        #     f.label(\"book.extended_title\", for: \"ext-title\")\n        #     # => <label for=\"ext-title\">Extended title</label>\n        #\n        # @overload label(field_name, **attributes, &block)\n        #   Returns a label tag for the given field name, with the return value of the given block\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #   @yieldreturn [String] the tag content\n        #\n        #   @example\n        #     <%= f.label for: \"book.free_shipping\" do %>\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     <% end %>\n        #\n        #     # =>\n        #     <label for=\"book-free-shipping\">\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     </label>\n        #\n        # @api public\n        # @since 2.1.0\n        def label(content = nil, **attributes, &block)\n          for_attribute_given = attributes.key?(:for)\n\n          attributes[:for] = _input_id(attributes[:for] || content)\n\n          if content && !for_attribute_given\n            content = inflector.humanize(content.to_s.split(INPUT_NAME_SEPARATOR).last)\n          end\n\n          tag.label(content, **attributes, &block)\n        end\n\n        # @overload fieldset(**attributes, &block)\n        #   Returns a fieldset tag.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag's content\n        #\n        #   @return [String] the tag\n        #\n        #   @example\n        #     <%= f.fieldset do %>\n        #       <%= f.legend(\"Author\") %>\n        #       <%= f.label(\"author.name\") %>\n        #       <%= f.text_field(\"author.name\") %>\n        #     <% end %>\n        #\n        #     # =>\n        #     <fieldset>\n        #       <legend>Author</legend>\n        #       <label for=\"book-author-name\">Name</label>\n        #       <input type=\"text\" name=\"book[author][name]\" id=\"book-author-name\" value=\"\">\n        #     </fieldset>\n        #\n        # @since 2.1.0\n        # @api public\n        def fieldset(...)\n          # This is here only for documentation purposes\n          tag.fieldset(...)\n        end\n\n        # Returns the tags for a check box.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the check box tag.\n        #\n        # Returns a hidden input tag in preceding the check box input tag. This ensures that\n        # unchecked values are submitted with the form.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the HTML attributes for the check box tag\n        # @option attributes [String] :checked_value (defaults to \"1\")\n        # @option attributes [String] :unchecked_value (defaults to \"0\")\n        #\n        # @return [String] the tags\n        #\n        # @example Basic usage\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   # =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\">\n        #\n        # @example HTML Attributes\n        #   f.check_box(\"delivery.free_shipping\", class: \"form-check-input\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" class=\"form-check-input\">\n        #\n        # @example Specifying checked and unchecked values\n        #   f.check_box(\"delivery.free_shipping\", checked_value: \"true\", unchecked_value: \"false\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"false\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"true\">\n        #\n        # @example Automatic \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"1\"}}\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Forcing the \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"0\"}}\n        #   f.check_box(\"deliver.free_shipping\", checked: \"checked\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Multiple check boxes for an array of values\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @example Automatic \"checked\" attribute for an array of values\n        #   # Given the request params:\n        #   # {book: {languages: [\"italian\"]}}\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\" checked=\"checked\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @api public\n        # @since 2.1.0\n        def check_box(name, **attributes)\n          (+\"\").tap { |output|\n            output << _hidden_field_for_check_box(name, attributes).to_s\n            output << input(**_attributes_for_check_box(name, attributes))\n          }.html_safe\n        end\n\n        # Returns a color input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.color_field(\"user.background\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.color_field(\"user.background\", class: \"form-control\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def color_field(name, **attributes)\n          input(**_attributes(:color, name, attributes))\n        end\n\n        # Returns a date input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.date_field(\"user.birth_date\")\n        #   # => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.date_field(\"user.birth_date\", class: \"form-control\")\n        #   => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def date_field(name, **attributes)\n          input(**_attributes(:date, name, attributes))\n        end\n\n        # Returns a datetime input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_field(name, **attributes)\n          input(**_attributes(:datetime, name, attributes))\n        end\n\n        # Returns a datetime-local input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_local_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_local_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_local_field(name, **attributes)\n          input(**_attributes(:\"datetime-local\", name, attributes))\n        end\n\n        # Returns a time input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.time_field(\"book.release_hour\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.time_field(\"book.release_hour\", class: \"form-control\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def time_field(name, **attributes)\n          input(**_attributes(:time, name, attributes))\n        end\n\n        # Returns a month input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.month_field(\"book.release_month\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.month_field(\"book.release_month\", class: \"form-control\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def month_field(name, **attributes)\n          input(**_attributes(:month, name, attributes))\n        end\n\n        # Returns a week input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.week_field(\"book.release_week\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.week_field(\"book.release_week\", class: \"form-control\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def week_field(name, **attributes)\n          input(**_attributes(:week, name, attributes))\n        end\n\n        # Returns an email input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.email_field(\"user.email\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.email_field(\"user.email\", class: \"form-control\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def email_field(name, **attributes)\n          input(**_attributes(:email, name, attributes))\n        end\n\n        # Returns a URL input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.url_field(\"user.website\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.url_field(\"user.website\", class: \"form-control\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def url_field(name, **attributes)\n          attributes[:value] = sanitize_url(attributes.fetch(:value) { _value(name) })\n\n          input(**_attributes(:url, name, attributes))\n        end\n\n        # Returns a telephone input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.tel_field(\"user.telephone\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.tel_field(\"user.telephone\", class: \"form-control\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def tel_field(name, **attributes)\n          input(**_attributes(:tel, name, attributes))\n        end\n\n        # Returns a hidden input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.hidden_field(\"delivery.customer_id\")\n        #   => <input type=\"hidden\" name=\"delivery[customer_id]\" id=\"delivery-customer-id\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def hidden_field(name, **attributes)\n          input(**_attributes(:hidden, name, attributes))\n        end\n\n        # Returns a file input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        # @option attributes [String, Array] :accept Optional set of accepted MIME Types\n        # @option attributes [Boolean] :multiple allow multiple file upload\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.file_field(\"user.avatar\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\">\n        #\n        # @example HTML Attributes\n        #   f.file_field(\"user.avatar\", class: \"avatar-upload\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\" class=\"avatar-upload\">\n        #\n        # @example Accepted MIME Types\n        #   f.file_field(\"user.resume\", accept: \"application/pdf,application/ms-word\")\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        #   f.file_field(\"user.resume\", accept: [\"application/pdf\", \"application/ms-word\"])\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        # @example Accept multiple file uploads\n        #   f.file_field(\"user.resume\", multiple: true)\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" multiple=\"multiple\">\n        #\n        # @api public\n        # @since 2.1.0\n        def file_field(name, **attributes)\n          form_attributes[:enctype] = \"multipart/form-data\"\n\n          attributes[:accept] = Array(attributes[:accept]).join(ACCEPT_SEPARATOR) if attributes.key?(:accept)\n          attributes = {type: :file, name: _input_name(name), id: _input_id(name), **attributes}\n\n          input(**attributes)\n        end\n\n        # Returns a number input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.number_field(\"book.percent_read\")\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.number_field(\"book.percent_read\", min: 1, max: 100, step: 1)\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def number_field(name, **attributes)\n          input(**_attributes(:number, name, attributes))\n        end\n\n        # Returns a range input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.range_field(\"book.discount_percentage\")\n        #   => <input type=\"range\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.range_field(\"book.discount_percentage\", min: 1, max: 1'0, step: 1)\n        #   => <input type=\"number\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def range_field(name, **attributes)\n          input(**_attributes(:range, name, attributes))\n        end\n\n        # Returns a textarea tag.\n        #\n        # @param name [String] the input name\n        # @param content [String] the content of the textarea\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_area(\"user.hobby\")\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\"></textarea>\n        #\n        #   f.text_area \"user.hobby\", \"Football\"\n        #   =>\n        #   <textarea name=\"user[hobby]\" id=\"user-hobby\">\n        #   Football</textarea>\n        #\n        # @example HTML attributes\n        #   f.text_area \"user.hobby\", class: \"form-control\"\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\" class=\"form-control\"></textarea>\n        #\n        # @api public\n        # @since 2.1.0\n        def text_area(name, content = nil, **attributes)\n          if content.respond_to?(:to_hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {name: _input_name(name), id: _input_id(name), **attributes}\n          tag.textarea(content || _value(name), **attributes)\n        end\n\n        # Returns a text input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_field(\"user.first_name\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.text_field(\"user.first_name\", class: \"form-control\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def text_field(name, **attributes)\n          input(**_attributes(:text, name, attributes))\n        end\n        alias_method :input_text, :text_field\n\n        # Returns a search input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.search_field(\"search.q\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.search_field(\"search.q\", class: \"form-control\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def search_field(name, **attributes)\n          input(**_attributes(:search, name, attributes))\n        end\n\n        # Returns a radio input tag.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the tag.\n        #\n        # @param name [String] the input name\n        # @param value [String] the input value\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\">\n        #\n        # @example HTML Attributes\n        #   f.radio_button(\"book.category\", \"Fiction\", class: \"form-check\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\", class: \"form-check\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\" class=\"form-check\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" class=\"form-check\">\n        #\n        # @example Automatic checked value\n        #   # Given the request params:\n        #   # {book: {category: \"Non-Fiction\"}}\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" checked=\"checked\">\n        #\n        # @api public\n        # @since 2.1.0\n        def radio_button(name, value, **attributes)\n          attributes = {type: :radio, name: _input_name(name), value: value, **attributes}\n          attributes[:checked] = true if _value(name).to_s == value.to_s\n\n          input(**attributes)\n        end\n\n        # Returns a password input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.password_field(\"signup.password\")\n        #   => <input type=\"password\" name=\"signup[password]\" id=\"signup-password\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def password_field(name, **attributes)\n          attrs = {type: :password, name: _input_name(name), id: _input_id(name), value: nil, **attributes}\n          attrs[:value] = EMPTY_STRING if attrs[:value].nil?\n\n          input(**attrs)\n        end\n\n        # Returns a select input tag containing option tags for the given values.\n        #\n        # The values should be an enumerable of pairs of content (the displayed text for the option)\n        # and value (the value for the option) strings.\n        #\n        # When editing a resource, automatically assigns the `selected` HTML attribute for any\n        # option tags matching the resource's values.\n        #\n        # @param name [String] the input name\n        # @param values [Hash] a Hash to generate `<option>` tags.\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example HTML Attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected options\n        #   # Given the following request params:\n        #   # {book: {store: \"it\"}}\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {selected: \"it\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"}, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true)\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\">\n        #    <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Values as an array, supporting repeated entries\n        #   values = [[\"Italy\", \"it\"],\n        #             [\"---\", \"\"],\n        #             [\"Afghanistan\", \"af\"],\n        #             ...\n        #             [\"Italy\", \"it\"],\n        #             ...\n        #             [\"Zimbabwe\", \"zw\"]]\n        #   f.select(\"book.stores\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"\">---</option>\n        #     <option value=\"af\">Afghanistan</option>\n        #     ...\n        #     <option value=\"it\">Italy</option>\n        #     ...\n        #     <option value=\"zw\">Zimbabwe</option>\n        #   </select>\n        #\n        # @api public\n        # @since 2.1.0\n        def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize\n          options = attributes.delete(:options) { {} }\n          multiple = attributes[:multiple]\n          attributes = {name: _select_input_name(name, multiple), id: _input_id(name), **attributes}\n          prompt = options.delete(:prompt)\n          selected = options.delete(:selected)\n          input_value = _value(name)\n\n          option_tags = []\n          option_tags << tag.option(prompt) if prompt\n\n          already_selected = nil\n          values.each do |content, value|\n            if (multiple || !already_selected) &&\n               (already_selected = _select_option_selected?(value, selected, input_value, multiple))\n              option_tags << tag.option(content, value: value, selected: true, **options)\n            else\n              option_tags << tag.option(content, value: value, **options)\n            end\n          end\n\n          tag.select(option_tags.join.html_safe, **attributes)\n        end\n\n        # Returns a datalist input tag.\n        #\n        # @param name [String] the input name\n        # @param values [Array,Hash] a collection that is transformed into `<option>` tags\n        # @param list [String] the name of list for the text input; also the id of datalist\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic Usage\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Options As Hash\n        #   values = Hash[\"Italy\" => \"it\", \"Australia\" => \"au\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\">it</option>\n        #     <option value=\"Australia\">au</option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the datalist input\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist \"book.stores\", values, \"books\", datalist: {class: \"form-control\"}\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\" class=\"form-control\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the options list\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\", options: {class: \"form-control\"})\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\" class=\"form-control\"></option>\n        #     <option value=\"Australia\" class=\"form-control\"></option>\n        #   </datalist>\n        #\n        # @api public\n        # @since 2.1.0\n        def datalist(name, values, list, **attributes)\n          options = attributes.delete(:options) || {}\n          datalist = attributes.delete(:datalist) || {}\n\n          attributes[:list] = list\n          datalist[:id] = list\n\n          (+\"\").tap { |output|\n            output << text_field(name, **attributes)\n            output << tag.datalist(**datalist) {\n              (+\"\").tap { |inner|\n                values.each do |value, content|\n                  inner << tag.option(content, value: value, **options)\n                end\n              }.html_safe\n            }\n          }.html_safe\n        end\n\n        # Returns a button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload button(content, **attributes)\n        #   Returns a button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload button(**attributes, &block)\n        #   Returns a button tag with the return value of the given block as the tag's content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.button(\"Click me\")\n        #   => <button>Click me</button>\n        #\n        # @example HTML Attributes\n        #   f.button(\"Click me\", class: \"btn btn-secondary\")\n        #   => <button class=\"btn btn-secondary\">Click me</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.button class: \"btn btn-secondary\" do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button class=\"btn btn-secondary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def button(...)\n          tag.button(...)\n        end\n\n        # Returns an image input tag, to be used as a visual button for the form.\n        #\n        # For security reasons, you should use the absolute URL of the given image.\n        #\n        # @param source [String] The absolute URL of the image\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\")\n        #   => <input type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @example HTML Attributes\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\", name: \"image\", width: \"50\")\n        #   => <input name=\"image\" width=\"50\" type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @api public\n        # @since 2.1.0\n        def image_button(source, **attributes)\n          attributes[:type] = :image\n          attributes[:src] = sanitize_url(source)\n\n          input(**attributes)\n        end\n\n        # Returns a submit button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload submit(content, **attributes)\n        #   Returns a submit button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload submit(**attributes, &blk)\n        #   Returns a submit button tag with the return value of the given block as the tag's\n        #   content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.submit(\"Create\")\n        #   => <button type=\"submit\">Create</button>\n        #\n        # @example HTML Attributes\n        #   f.submit(\"Create\", class: \"btn btn-primary\")\n        #   => <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.submit(class: \"btn btn-primary\") do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button type=\"submit\" class=\"btn btn-primary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def submit(content = nil, **attributes, &blk)\n          if content.is_a?(::Hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {type: :submit, **attributes}\n          tag.button(content, **attributes, &blk)\n        end\n\n        # Returns an input tag.\n        #\n        # Generates an input tag without any special handling. For more convenience and other\n        # advanced features, see the other methods of the form builder.\n        #\n        # @param attributes [Hash] the tag's HTML attributes\n        # @yieldreturn [String] the tag content\n        #\n        # @return [String] the tag\n        #\n        # @since 2.1.0\n        # @api public\n        #\n        # @example Basic usage\n        #   f.input(type: :text, name: \"book[title]\", id: \"book-title\", value: book.title)\n        #   => <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Hanami book\">\n        #\n        # @api public\n        # @since 2.1.0\n        def input(...)\n          tag.input(...)\n        end\n\n        private\n\n        # @api private\n        # @since 2.1.0\n        def _form_method(attributes)\n          attributes[:method] ||= DEFAULT_METHOD\n          attributes[:method] = attributes[:method].to_s.upcase\n\n          original_form_method = attributes[:method]\n\n          if (method_override = !BROWSER_METHODS.include?(attributes[:method]))\n            attributes[:method] = DEFAULT_METHOD\n          end\n\n          [method_override, original_form_method]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _csrf_token(values, attributes)\n          return [] if values.csrf_token.nil?\n\n          return [] if EXCLUDED_CSRF_METHODS.include?(attributes[:method])\n\n          [true, values.csrf_token]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _attributes(type, name, attributes)\n          attrs = {\n            type: type,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: _value(name)\n          }\n          attrs.merge!(attributes)\n          attrs[:value] = escape_html(attrs[:value]).html_safe\n          attrs\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_name(name)\n          tokens = _split_input_name(name)\n          result = tokens.shift\n\n          tokens.each do |t|\n            if t =~ %r{\\A\\d+\\z}\n              result << \"[]\"\n            else\n              result << \"[#{t}]\"\n            end\n          end\n\n          result\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_id(name)\n          [base_name, name].compact.join(INPUT_NAME_SEPARATOR).to_s.tr(\"._\", \"-\")\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _value(name)\n          values.get(*_split_input_name(name).map(&:to_sym))\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _split_input_name(name)\n          [\n            *base_name.to_s.split(INPUT_NAME_SEPARATOR),\n            *name.to_s.split(INPUT_NAME_SEPARATOR)\n          ].compact\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _hidden_field_for_check_box(name, attributes)\n          return unless attributes[:value].nil? || !attributes[:unchecked_value].nil?\n\n          input(\n            type: :hidden,\n            name: attributes[:name] || _input_name(name),\n            value: (attributes.delete(:unchecked_value) || DEFAULT_UNCHECKED_VALUE).to_s\n          )\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _attributes_for_check_box(name, attributes)\n          attributes = {\n            type: :checkbox,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: (attributes.delete(:checked_value) || DEFAULT_CHECKED_VALUE).to_s,\n            **attributes\n          }\n\n          attributes[:checked] = true if _check_box_checked?(attributes[:value], _value(name))\n\n          attributes\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_input_name(name, multiple)\n          select_name = _input_name(name)\n          select_name = \"#{select_name}[]\" if multiple\n          select_name\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_option_selected?(value, selected, input_value, multiple)\n          if input_value && selected.nil?\n            value.to_s == input_value.to_s\n          else\n            (value == selected) ||\n              _is_current_value?(input_value, value) ||\n              _is_in_selected_values?(multiple, selected, value) ||\n              _is_in_input_values?(multiple, input_value, value)\n          end\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_current_value?(input_value, value)\n          return unless input_value\n\n          value.to_s == input_value.to_s\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_selected_values?(multiple, selected, value)\n          return unless multiple && selected.is_a?(Array)\n\n          selected.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_input_values?(multiple, input_value, value)\n          return unless multiple && input_value.is_a?(Array)\n\n          input_value.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _check_box_checked?(value, input_value)\n          !input_value.nil? &&\n            (input_value.to_s == value.to_s || input_value.is_a?(TrueClass) ||\n            (input_value.is_a?(Array) && input_value.include?(value)))\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "call", "signature": "def call(content, **attributes)", "start_line": 118, "end_line": 131}, "metadata": {"module": "Hanami", "class_name": "FormBuilder", "class_signature": "class FormBuilder"}, "task_id": 671}
{"function_name": "fields_for", "file_path": "hanami/lib/hanami/helpers/form_helper/form_builder.rb", "focal_code": "def fields_for(name, *yield_args)\n          new_base_name = [base_name, name.to_s].compact.join(INPUT_NAME_SEPARATOR)\n\n          builder = self.class.new(\n            base_name: new_base_name,\n            values: values,\n            form_attributes: form_attributes,\n            inflector: inflector\n          )\n\n          yield(builder, *yield_args)\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/view\"\nrequire_relative \"values\"\n\nmodule Hanami\n  module Helpers\n    module FormHelper\n      # A range of convenient methods for building the fields within an HTML form, integrating with\n      # request params and template locals to populate the fields with appropriate values.\n      #\n      # @see FormHelper#form_for\n      #\n      # @api public\n      # @since 2.1.0\n      class FormBuilder\n        # Set of HTTP methods that are understood by web browsers\n        #\n        # @since 2.1.0\n        # @api private\n        BROWSER_METHODS = %w[GET POST].freeze\n        private_constant :BROWSER_METHODS\n\n        # Set of HTTP methods that should NOT generate CSRF token\n        #\n        # @since 2.1.0\n        # @api private\n        EXCLUDED_CSRF_METHODS = %w[GET].freeze\n        private_constant :EXCLUDED_CSRF_METHODS\n\n        # Separator for accept attribute of file input\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #file_input\n        ACCEPT_SEPARATOR = \",\"\n        private_constant :ACCEPT_SEPARATOR\n\n        # Default value for unchecked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_UNCHECKED_VALUE = \"0\"\n        private_constant :DEFAULT_UNCHECKED_VALUE\n\n        # Default value for checked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_CHECKED_VALUE = \"1\"\n        private_constant :DEFAULT_CHECKED_VALUE\n\n        # Input name separator\n        #\n        # @since 2.1.0\n        # @api private\n        INPUT_NAME_SEPARATOR = \".\"\n        private_constant :INPUT_NAME_SEPARATOR\n\n        # Empty string\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #password_field\n        EMPTY_STRING = \"\"\n        private_constant :EMPTY_STRING\n\n        include Hanami::View::Helpers::EscapeHelper\n        include Hanami::View::Helpers::TagHelper\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :base_name\n        private :base_name\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :values\n        private :values\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :inflector\n        private :inflector\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :form_attributes\n        private :form_attributes\n\n        # Returns a new form builder.\n        #\n        # @param inflector [Dry::Inflector] the app inflector\n        # @param base_name [String, nil] the base name to use for all fields in the form\n        # @param values [Hanami::Helpers::FormHelper::Values] the values for the form\n        #\n        # @return [self]\n        #\n        # @see Hanami::Helpers::FormHelper#form_for\n        #\n        # @api private\n        # @since 2.1.0\n        def initialize(inflector:, form_attributes:, base_name: nil, values: Values.new)\n          @base_name = base_name\n          @values = values\n          @form_attributes = form_attributes\n          @inflector = inflector\n        end\n\n        # @api private\n        # @since 2.1.0\n        def call(content, **attributes)\n          attributes[\"accept-charset\"] ||= DEFAULT_CHARSET\n\n          method_override, original_form_method = _form_method(attributes)\n          csrf_token, token = _csrf_token(values, attributes)\n\n          tag.form(**attributes) do\n            (+\"\").tap { |inner|\n              inner << input(type: \"hidden\", name: \"_method\", value: original_form_method) if method_override\n              inner << input(type: \"hidden\", name: \"_csrf_token\", value: token) if csrf_token\n              inner << content\n            }.html_safe\n          end\n        end\n\n        # Applies the base input name to all fields within the given block.\n        #\n        # This can be helpful when generating a set of nested fields.\n        #\n        # This is a convenience only. You can achieve the same result by including the base name at\n        # the beginning of each input name.\n        #\n        # @param name [String] the base name to be used for all fields in the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        #\n        # @example Basic usage\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #     <%= fa.text_field \"suburb\" %>\n        #   <% end %>\n        #\n        #   # A convenience for:\n        #   # <%= f.text_field \"address.street\" %>\n        #   # <%= f.text_field \"address.suburb\" %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[customer_name]\" id=\"delivery-customer-name\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #\n        # @example Multiple levels of nesting\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #\n        #     <% fa.fields_for \"location\" do |fl| %>\n        #       <%= fl.text_field \"city\" %>\n        #     <% end %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][location][city]\" id=\"delivery-address-location-city\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for(name, *yield_args)\n          new_base_name = [base_name, name.to_s].compact.join(INPUT_NAME_SEPARATOR)\n\n          builder = self.class.new(\n            base_name: new_base_name,\n            values: values,\n            form_attributes: form_attributes,\n            inflector: inflector\n          )\n\n          yield(builder, *yield_args)\n        end\n\n        # Yields to the given block for each element in the matching collection value, and applies\n        # the base input name to all fields within the block.\n        #\n        # Use this whenever generating form fields for an collection of nested fields.\n        #\n        # @param name [String] the input name, also used as the base input name for all fields\n        #   within the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        # @yieldparam [Integer] the index of the iteration over the collection, starting from zero\n        # @yieldparam [Object] the value of the element from the collection\n        #\n        # @example Basic usage\n        #   <% f.fields_for_collection(\"addresses\") do |fa| %>\n        #     <%= fa.text_field(\"street\") %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-0-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-1-street\" value=\"\">\n        #\n        # @example Yielding index and value\n        #   <% f.fields_for_collection(\"bill.addresses\") do |fa, i, address| %>\n        #     <div class=\"form-group\">\n        #       Address id: <%= address.id %>\n        #       <%= fa.label(\"street\") %>\n        #       <%= fa.text_field(\"street\", data: {index: i.to_s}) %>\n        #     </div>\n        #   <% end %>\n        #\n        #   =>\n        #   <div class=\"form-group\">\n        #     Address id: 23\n        #     <label for=\"bill-addresses-0-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-0-street\" value=\"5th Ave\" data-index=\"0\">\n        #   </div>\n        #   <div class=\"form-group\">\n        #     Address id: 42\n        #     <label for=\"bill-addresses-1-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-1-street\" value=\"4th Ave\" data-index=\"1\">\n        #   </div>\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for_collection(name, &block)\n          _value(name).each_with_index do |value, index|\n            fields_for(\"#{name}.#{index}\", index, value, &block)\n          end\n        end\n\n        # Returns a label tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload label(field_name, **attributes)\n        #   Returns a label tag for the given field name, with a humanized version of the field name\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Extended title</label>\n        #\n        #   @example HTML attributes\n        #     <%= f.label(\"book.title\", class: \"form-label\") %>\n        #     # => <label for=\"book-title\" class=\"form-label\">Title</label>\n        #\n        # @overload label(content, **attributes)\n        #   Returns a label tag for the field name given as `for:`, with the given content string as\n        #   the tag's content.\n        #\n        #   @param content [String] the tag's content\n        #   @param for [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"Title\", for: \"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Title</label>\n        #\n        #     f.label(\"book.extended_title\", for: \"ext-title\")\n        #     # => <label for=\"ext-title\">Extended title</label>\n        #\n        # @overload label(field_name, **attributes, &block)\n        #   Returns a label tag for the given field name, with the return value of the given block\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #   @yieldreturn [String] the tag content\n        #\n        #   @example\n        #     <%= f.label for: \"book.free_shipping\" do %>\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     <% end %>\n        #\n        #     # =>\n        #     <label for=\"book-free-shipping\">\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     </label>\n        #\n        # @api public\n        # @since 2.1.0\n        def label(content = nil, **attributes, &block)\n          for_attribute_given = attributes.key?(:for)\n\n          attributes[:for] = _input_id(attributes[:for] || content)\n\n          if content && !for_attribute_given\n            content = inflector.humanize(content.to_s.split(INPUT_NAME_SEPARATOR).last)\n          end\n\n          tag.label(content, **attributes, &block)\n        end\n\n        # @overload fieldset(**attributes, &block)\n        #   Returns a fieldset tag.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag's content\n        #\n        #   @return [String] the tag\n        #\n        #   @example\n        #     <%= f.fieldset do %>\n        #       <%= f.legend(\"Author\") %>\n        #       <%= f.label(\"author.name\") %>\n        #       <%= f.text_field(\"author.name\") %>\n        #     <% end %>\n        #\n        #     # =>\n        #     <fieldset>\n        #       <legend>Author</legend>\n        #       <label for=\"book-author-name\">Name</label>\n        #       <input type=\"text\" name=\"book[author][name]\" id=\"book-author-name\" value=\"\">\n        #     </fieldset>\n        #\n        # @since 2.1.0\n        # @api public\n        def fieldset(...)\n          # This is here only for documentation purposes\n          tag.fieldset(...)\n        end\n\n        # Returns the tags for a check box.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the check box tag.\n        #\n        # Returns a hidden input tag in preceding the check box input tag. This ensures that\n        # unchecked values are submitted with the form.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the HTML attributes for the check box tag\n        # @option attributes [String] :checked_value (defaults to \"1\")\n        # @option attributes [String] :unchecked_value (defaults to \"0\")\n        #\n        # @return [String] the tags\n        #\n        # @example Basic usage\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   # =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\">\n        #\n        # @example HTML Attributes\n        #   f.check_box(\"delivery.free_shipping\", class: \"form-check-input\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" class=\"form-check-input\">\n        #\n        # @example Specifying checked and unchecked values\n        #   f.check_box(\"delivery.free_shipping\", checked_value: \"true\", unchecked_value: \"false\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"false\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"true\">\n        #\n        # @example Automatic \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"1\"}}\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Forcing the \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"0\"}}\n        #   f.check_box(\"deliver.free_shipping\", checked: \"checked\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Multiple check boxes for an array of values\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @example Automatic \"checked\" attribute for an array of values\n        #   # Given the request params:\n        #   # {book: {languages: [\"italian\"]}}\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\" checked=\"checked\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @api public\n        # @since 2.1.0\n        def check_box(name, **attributes)\n          (+\"\").tap { |output|\n            output << _hidden_field_for_check_box(name, attributes).to_s\n            output << input(**_attributes_for_check_box(name, attributes))\n          }.html_safe\n        end\n\n        # Returns a color input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.color_field(\"user.background\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.color_field(\"user.background\", class: \"form-control\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def color_field(name, **attributes)\n          input(**_attributes(:color, name, attributes))\n        end\n\n        # Returns a date input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.date_field(\"user.birth_date\")\n        #   # => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.date_field(\"user.birth_date\", class: \"form-control\")\n        #   => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def date_field(name, **attributes)\n          input(**_attributes(:date, name, attributes))\n        end\n\n        # Returns a datetime input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_field(name, **attributes)\n          input(**_attributes(:datetime, name, attributes))\n        end\n\n        # Returns a datetime-local input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_local_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_local_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_local_field(name, **attributes)\n          input(**_attributes(:\"datetime-local\", name, attributes))\n        end\n\n        # Returns a time input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.time_field(\"book.release_hour\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.time_field(\"book.release_hour\", class: \"form-control\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def time_field(name, **attributes)\n          input(**_attributes(:time, name, attributes))\n        end\n\n        # Returns a month input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.month_field(\"book.release_month\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.month_field(\"book.release_month\", class: \"form-control\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def month_field(name, **attributes)\n          input(**_attributes(:month, name, attributes))\n        end\n\n        # Returns a week input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.week_field(\"book.release_week\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.week_field(\"book.release_week\", class: \"form-control\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def week_field(name, **attributes)\n          input(**_attributes(:week, name, attributes))\n        end\n\n        # Returns an email input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.email_field(\"user.email\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.email_field(\"user.email\", class: \"form-control\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def email_field(name, **attributes)\n          input(**_attributes(:email, name, attributes))\n        end\n\n        # Returns a URL input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.url_field(\"user.website\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.url_field(\"user.website\", class: \"form-control\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def url_field(name, **attributes)\n          attributes[:value] = sanitize_url(attributes.fetch(:value) { _value(name) })\n\n          input(**_attributes(:url, name, attributes))\n        end\n\n        # Returns a telephone input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.tel_field(\"user.telephone\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.tel_field(\"user.telephone\", class: \"form-control\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def tel_field(name, **attributes)\n          input(**_attributes(:tel, name, attributes))\n        end\n\n        # Returns a hidden input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.hidden_field(\"delivery.customer_id\")\n        #   => <input type=\"hidden\" name=\"delivery[customer_id]\" id=\"delivery-customer-id\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def hidden_field(name, **attributes)\n          input(**_attributes(:hidden, name, attributes))\n        end\n\n        # Returns a file input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        # @option attributes [String, Array] :accept Optional set of accepted MIME Types\n        # @option attributes [Boolean] :multiple allow multiple file upload\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.file_field(\"user.avatar\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\">\n        #\n        # @example HTML Attributes\n        #   f.file_field(\"user.avatar\", class: \"avatar-upload\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\" class=\"avatar-upload\">\n        #\n        # @example Accepted MIME Types\n        #   f.file_field(\"user.resume\", accept: \"application/pdf,application/ms-word\")\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        #   f.file_field(\"user.resume\", accept: [\"application/pdf\", \"application/ms-word\"])\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        # @example Accept multiple file uploads\n        #   f.file_field(\"user.resume\", multiple: true)\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" multiple=\"multiple\">\n        #\n        # @api public\n        # @since 2.1.0\n        def file_field(name, **attributes)\n          form_attributes[:enctype] = \"multipart/form-data\"\n\n          attributes[:accept] = Array(attributes[:accept]).join(ACCEPT_SEPARATOR) if attributes.key?(:accept)\n          attributes = {type: :file, name: _input_name(name), id: _input_id(name), **attributes}\n\n          input(**attributes)\n        end\n\n        # Returns a number input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.number_field(\"book.percent_read\")\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.number_field(\"book.percent_read\", min: 1, max: 100, step: 1)\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def number_field(name, **attributes)\n          input(**_attributes(:number, name, attributes))\n        end\n\n        # Returns a range input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.range_field(\"book.discount_percentage\")\n        #   => <input type=\"range\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.range_field(\"book.discount_percentage\", min: 1, max: 1'0, step: 1)\n        #   => <input type=\"number\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def range_field(name, **attributes)\n          input(**_attributes(:range, name, attributes))\n        end\n\n        # Returns a textarea tag.\n        #\n        # @param name [String] the input name\n        # @param content [String] the content of the textarea\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_area(\"user.hobby\")\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\"></textarea>\n        #\n        #   f.text_area \"user.hobby\", \"Football\"\n        #   =>\n        #   <textarea name=\"user[hobby]\" id=\"user-hobby\">\n        #   Football</textarea>\n        #\n        # @example HTML attributes\n        #   f.text_area \"user.hobby\", class: \"form-control\"\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\" class=\"form-control\"></textarea>\n        #\n        # @api public\n        # @since 2.1.0\n        def text_area(name, content = nil, **attributes)\n          if content.respond_to?(:to_hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {name: _input_name(name), id: _input_id(name), **attributes}\n          tag.textarea(content || _value(name), **attributes)\n        end\n\n        # Returns a text input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_field(\"user.first_name\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.text_field(\"user.first_name\", class: \"form-control\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def text_field(name, **attributes)\n          input(**_attributes(:text, name, attributes))\n        end\n        alias_method :input_text, :text_field\n\n        # Returns a search input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.search_field(\"search.q\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.search_field(\"search.q\", class: \"form-control\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def search_field(name, **attributes)\n          input(**_attributes(:search, name, attributes))\n        end\n\n        # Returns a radio input tag.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the tag.\n        #\n        # @param name [String] the input name\n        # @param value [String] the input value\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\">\n        #\n        # @example HTML Attributes\n        #   f.radio_button(\"book.category\", \"Fiction\", class: \"form-check\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\", class: \"form-check\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\" class=\"form-check\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" class=\"form-check\">\n        #\n        # @example Automatic checked value\n        #   # Given the request params:\n        #   # {book: {category: \"Non-Fiction\"}}\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" checked=\"checked\">\n        #\n        # @api public\n        # @since 2.1.0\n        def radio_button(name, value, **attributes)\n          attributes = {type: :radio, name: _input_name(name), value: value, **attributes}\n          attributes[:checked] = true if _value(name).to_s == value.to_s\n\n          input(**attributes)\n        end\n\n        # Returns a password input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.password_field(\"signup.password\")\n        #   => <input type=\"password\" name=\"signup[password]\" id=\"signup-password\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def password_field(name, **attributes)\n          attrs = {type: :password, name: _input_name(name), id: _input_id(name), value: nil, **attributes}\n          attrs[:value] = EMPTY_STRING if attrs[:value].nil?\n\n          input(**attrs)\n        end\n\n        # Returns a select input tag containing option tags for the given values.\n        #\n        # The values should be an enumerable of pairs of content (the displayed text for the option)\n        # and value (the value for the option) strings.\n        #\n        # When editing a resource, automatically assigns the `selected` HTML attribute for any\n        # option tags matching the resource's values.\n        #\n        # @param name [String] the input name\n        # @param values [Hash] a Hash to generate `<option>` tags.\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example HTML Attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected options\n        #   # Given the following request params:\n        #   # {book: {store: \"it\"}}\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {selected: \"it\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"}, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true)\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\">\n        #    <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Values as an array, supporting repeated entries\n        #   values = [[\"Italy\", \"it\"],\n        #             [\"---\", \"\"],\n        #             [\"Afghanistan\", \"af\"],\n        #             ...\n        #             [\"Italy\", \"it\"],\n        #             ...\n        #             [\"Zimbabwe\", \"zw\"]]\n        #   f.select(\"book.stores\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"\">---</option>\n        #     <option value=\"af\">Afghanistan</option>\n        #     ...\n        #     <option value=\"it\">Italy</option>\n        #     ...\n        #     <option value=\"zw\">Zimbabwe</option>\n        #   </select>\n        #\n        # @api public\n        # @since 2.1.0\n        def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize\n          options = attributes.delete(:options) { {} }\n          multiple = attributes[:multiple]\n          attributes = {name: _select_input_name(name, multiple), id: _input_id(name), **attributes}\n          prompt = options.delete(:prompt)\n          selected = options.delete(:selected)\n          input_value = _value(name)\n\n          option_tags = []\n          option_tags << tag.option(prompt) if prompt\n\n          already_selected = nil\n          values.each do |content, value|\n            if (multiple || !already_selected) &&\n               (already_selected = _select_option_selected?(value, selected, input_value, multiple))\n              option_tags << tag.option(content, value: value, selected: true, **options)\n            else\n              option_tags << tag.option(content, value: value, **options)\n            end\n          end\n\n          tag.select(option_tags.join.html_safe, **attributes)\n        end\n\n        # Returns a datalist input tag.\n        #\n        # @param name [String] the input name\n        # @param values [Array,Hash] a collection that is transformed into `<option>` tags\n        # @param list [String] the name of list for the text input; also the id of datalist\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic Usage\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Options As Hash\n        #   values = Hash[\"Italy\" => \"it\", \"Australia\" => \"au\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\">it</option>\n        #     <option value=\"Australia\">au</option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the datalist input\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist \"book.stores\", values, \"books\", datalist: {class: \"form-control\"}\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\" class=\"form-control\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the options list\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\", options: {class: \"form-control\"})\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\" class=\"form-control\"></option>\n        #     <option value=\"Australia\" class=\"form-control\"></option>\n        #   </datalist>\n        #\n        # @api public\n        # @since 2.1.0\n        def datalist(name, values, list, **attributes)\n          options = attributes.delete(:options) || {}\n          datalist = attributes.delete(:datalist) || {}\n\n          attributes[:list] = list\n          datalist[:id] = list\n\n          (+\"\").tap { |output|\n            output << text_field(name, **attributes)\n            output << tag.datalist(**datalist) {\n              (+\"\").tap { |inner|\n                values.each do |value, content|\n                  inner << tag.option(content, value: value, **options)\n                end\n              }.html_safe\n            }\n          }.html_safe\n        end\n\n        # Returns a button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload button(content, **attributes)\n        #   Returns a button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload button(**attributes, &block)\n        #   Returns a button tag with the return value of the given block as the tag's content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.button(\"Click me\")\n        #   => <button>Click me</button>\n        #\n        # @example HTML Attributes\n        #   f.button(\"Click me\", class: \"btn btn-secondary\")\n        #   => <button class=\"btn btn-secondary\">Click me</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.button class: \"btn btn-secondary\" do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button class=\"btn btn-secondary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def button(...)\n          tag.button(...)\n        end\n\n        # Returns an image input tag, to be used as a visual button for the form.\n        #\n        # For security reasons, you should use the absolute URL of the given image.\n        #\n        # @param source [String] The absolute URL of the image\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\")\n        #   => <input type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @example HTML Attributes\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\", name: \"image\", width: \"50\")\n        #   => <input name=\"image\" width=\"50\" type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @api public\n        # @since 2.1.0\n        def image_button(source, **attributes)\n          attributes[:type] = :image\n          attributes[:src] = sanitize_url(source)\n\n          input(**attributes)\n        end\n\n        # Returns a submit button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload submit(content, **attributes)\n        #   Returns a submit button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload submit(**attributes, &blk)\n        #   Returns a submit button tag with the return value of the given block as the tag's\n        #   content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.submit(\"Create\")\n        #   => <button type=\"submit\">Create</button>\n        #\n        # @example HTML Attributes\n        #   f.submit(\"Create\", class: \"btn btn-primary\")\n        #   => <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.submit(class: \"btn btn-primary\") do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button type=\"submit\" class=\"btn btn-primary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def submit(content = nil, **attributes, &blk)\n          if content.is_a?(::Hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {type: :submit, **attributes}\n          tag.button(content, **attributes, &blk)\n        end\n\n        # Returns an input tag.\n        #\n        # Generates an input tag without any special handling. For more convenience and other\n        # advanced features, see the other methods of the form builder.\n        #\n        # @param attributes [Hash] the tag's HTML attributes\n        # @yieldreturn [String] the tag content\n        #\n        # @return [String] the tag\n        #\n        # @since 2.1.0\n        # @api public\n        #\n        # @example Basic usage\n        #   f.input(type: :text, name: \"book[title]\", id: \"book-title\", value: book.title)\n        #   => <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Hanami book\">\n        #\n        # @api public\n        # @since 2.1.0\n        def input(...)\n          tag.input(...)\n        end\n\n        private\n\n        # @api private\n        # @since 2.1.0\n        def _form_method(attributes)\n          attributes[:method] ||= DEFAULT_METHOD\n          attributes[:method] = attributes[:method].to_s.upcase\n\n          original_form_method = attributes[:method]\n\n          if (method_override = !BROWSER_METHODS.include?(attributes[:method]))\n            attributes[:method] = DEFAULT_METHOD\n          end\n\n          [method_override, original_form_method]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _csrf_token(values, attributes)\n          return [] if values.csrf_token.nil?\n\n          return [] if EXCLUDED_CSRF_METHODS.include?(attributes[:method])\n\n          [true, values.csrf_token]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _attributes(type, name, attributes)\n          attrs = {\n            type: type,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: _value(name)\n          }\n          attrs.merge!(attributes)\n          attrs[:value] = escape_html(attrs[:value]).html_safe\n          attrs\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_name(name)\n          tokens = _split_input_name(name)\n          result = tokens.shift\n\n          tokens.each do |t|\n            if t =~ %r{\\A\\d+\\z}\n              result << \"[]\"\n            else\n              result << \"[#{t}]\"\n            end\n          end\n\n          result\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_id(name)\n          [base_name, name].compact.join(INPUT_NAME_SEPARATOR).to_s.tr(\"._\", \"-\")\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _value(name)\n          values.get(*_split_input_name(name).map(&:to_sym))\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _split_input_name(name)\n          [\n            *base_name.to_s.split(INPUT_NAME_SEPARATOR),\n            *name.to_s.split(INPUT_NAME_SEPARATOR)\n          ].compact\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _hidden_field_for_check_box(name, attributes)\n          return unless attributes[:value].nil? || !attributes[:unchecked_value].nil?\n\n          input(\n            type: :hidden,\n            name: attributes[:name] || _input_name(name),\n            value: (attributes.delete(:unchecked_value) || DEFAULT_UNCHECKED_VALUE).to_s\n          )\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _attributes_for_check_box(name, attributes)\n          attributes = {\n            type: :checkbox,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: (attributes.delete(:checked_value) || DEFAULT_CHECKED_VALUE).to_s,\n            **attributes\n          }\n\n          attributes[:checked] = true if _check_box_checked?(attributes[:value], _value(name))\n\n          attributes\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_input_name(name, multiple)\n          select_name = _input_name(name)\n          select_name = \"#{select_name}[]\" if multiple\n          select_name\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_option_selected?(value, selected, input_value, multiple)\n          if input_value && selected.nil?\n            value.to_s == input_value.to_s\n          else\n            (value == selected) ||\n              _is_current_value?(input_value, value) ||\n              _is_in_selected_values?(multiple, selected, value) ||\n              _is_in_input_values?(multiple, input_value, value)\n          end\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_current_value?(input_value, value)\n          return unless input_value\n\n          value.to_s == input_value.to_s\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_selected_values?(multiple, selected, value)\n          return unless multiple && selected.is_a?(Array)\n\n          selected.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_input_values?(multiple, input_value, value)\n          return unless multiple && input_value.is_a?(Array)\n\n          input_value.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _check_box_checked?(value, input_value)\n          !input_value.nil? &&\n            (input_value.to_s == value.to_s || input_value.is_a?(TrueClass) ||\n            (input_value.is_a?(Array) && input_value.include?(value)))\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "fields_for", "signature": "def fields_for(name, *yield_args)", "start_line": 172, "end_line": 183}, "metadata": {"module": "Hanami", "class_name": "FormBuilder", "class_signature": "class FormBuilder"}, "task_id": 672}
{"function_name": "select", "file_path": "hanami/lib/hanami/helpers/form_helper/form_builder.rb", "focal_code": "def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize\n          options = attributes.delete(:options) { {} }\n          multiple = attributes[:multiple]\n          attributes = {name: _select_input_name(name, multiple), id: _input_id(name), **attributes}\n          prompt = options.delete(:prompt)\n          selected = options.delete(:selected)\n          input_value = _value(name)\n\n          option_tags = []\n          option_tags << tag.option(prompt) if prompt\n\n          already_selected = nil\n          values.each do |content, value|\n            if (multiple || !already_selected) &&\n               (already_selected = _select_option_selected?(value, selected, input_value, multiple))\n              option_tags << tag.option(content, value: value, selected: true, **options)\n            else\n              option_tags << tag.option(content, value: value, **options)\n            end\n          end\n\n          tag.select(option_tags.join.html_safe, **attributes)\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/view\"\nrequire_relative \"values\"\n\nmodule Hanami\n  module Helpers\n    module FormHelper\n      # A range of convenient methods for building the fields within an HTML form, integrating with\n      # request params and template locals to populate the fields with appropriate values.\n      #\n      # @see FormHelper#form_for\n      #\n      # @api public\n      # @since 2.1.0\n      class FormBuilder\n        # Set of HTTP methods that are understood by web browsers\n        #\n        # @since 2.1.0\n        # @api private\n        BROWSER_METHODS = %w[GET POST].freeze\n        private_constant :BROWSER_METHODS\n\n        # Set of HTTP methods that should NOT generate CSRF token\n        #\n        # @since 2.1.0\n        # @api private\n        EXCLUDED_CSRF_METHODS = %w[GET].freeze\n        private_constant :EXCLUDED_CSRF_METHODS\n\n        # Separator for accept attribute of file input\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #file_input\n        ACCEPT_SEPARATOR = \",\"\n        private_constant :ACCEPT_SEPARATOR\n\n        # Default value for unchecked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_UNCHECKED_VALUE = \"0\"\n        private_constant :DEFAULT_UNCHECKED_VALUE\n\n        # Default value for checked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_CHECKED_VALUE = \"1\"\n        private_constant :DEFAULT_CHECKED_VALUE\n\n        # Input name separator\n        #\n        # @since 2.1.0\n        # @api private\n        INPUT_NAME_SEPARATOR = \".\"\n        private_constant :INPUT_NAME_SEPARATOR\n\n        # Empty string\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #password_field\n        EMPTY_STRING = \"\"\n        private_constant :EMPTY_STRING\n\n        include Hanami::View::Helpers::EscapeHelper\n        include Hanami::View::Helpers::TagHelper\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :base_name\n        private :base_name\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :values\n        private :values\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :inflector\n        private :inflector\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :form_attributes\n        private :form_attributes\n\n        # Returns a new form builder.\n        #\n        # @param inflector [Dry::Inflector] the app inflector\n        # @param base_name [String, nil] the base name to use for all fields in the form\n        # @param values [Hanami::Helpers::FormHelper::Values] the values for the form\n        #\n        # @return [self]\n        #\n        # @see Hanami::Helpers::FormHelper#form_for\n        #\n        # @api private\n        # @since 2.1.0\n        def initialize(inflector:, form_attributes:, base_name: nil, values: Values.new)\n          @base_name = base_name\n          @values = values\n          @form_attributes = form_attributes\n          @inflector = inflector\n        end\n\n        # @api private\n        # @since 2.1.0\n        def call(content, **attributes)\n          attributes[\"accept-charset\"] ||= DEFAULT_CHARSET\n\n          method_override, original_form_method = _form_method(attributes)\n          csrf_token, token = _csrf_token(values, attributes)\n\n          tag.form(**attributes) do\n            (+\"\").tap { |inner|\n              inner << input(type: \"hidden\", name: \"_method\", value: original_form_method) if method_override\n              inner << input(type: \"hidden\", name: \"_csrf_token\", value: token) if csrf_token\n              inner << content\n            }.html_safe\n          end\n        end\n\n        # Applies the base input name to all fields within the given block.\n        #\n        # This can be helpful when generating a set of nested fields.\n        #\n        # This is a convenience only. You can achieve the same result by including the base name at\n        # the beginning of each input name.\n        #\n        # @param name [String] the base name to be used for all fields in the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        #\n        # @example Basic usage\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #     <%= fa.text_field \"suburb\" %>\n        #   <% end %>\n        #\n        #   # A convenience for:\n        #   # <%= f.text_field \"address.street\" %>\n        #   # <%= f.text_field \"address.suburb\" %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[customer_name]\" id=\"delivery-customer-name\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #\n        # @example Multiple levels of nesting\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #\n        #     <% fa.fields_for \"location\" do |fl| %>\n        #       <%= fl.text_field \"city\" %>\n        #     <% end %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][location][city]\" id=\"delivery-address-location-city\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for(name, *yield_args)\n          new_base_name = [base_name, name.to_s].compact.join(INPUT_NAME_SEPARATOR)\n\n          builder = self.class.new(\n            base_name: new_base_name,\n            values: values,\n            form_attributes: form_attributes,\n            inflector: inflector\n          )\n\n          yield(builder, *yield_args)\n        end\n\n        # Yields to the given block for each element in the matching collection value, and applies\n        # the base input name to all fields within the block.\n        #\n        # Use this whenever generating form fields for an collection of nested fields.\n        #\n        # @param name [String] the input name, also used as the base input name for all fields\n        #   within the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        # @yieldparam [Integer] the index of the iteration over the collection, starting from zero\n        # @yieldparam [Object] the value of the element from the collection\n        #\n        # @example Basic usage\n        #   <% f.fields_for_collection(\"addresses\") do |fa| %>\n        #     <%= fa.text_field(\"street\") %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-0-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-1-street\" value=\"\">\n        #\n        # @example Yielding index and value\n        #   <% f.fields_for_collection(\"bill.addresses\") do |fa, i, address| %>\n        #     <div class=\"form-group\">\n        #       Address id: <%= address.id %>\n        #       <%= fa.label(\"street\") %>\n        #       <%= fa.text_field(\"street\", data: {index: i.to_s}) %>\n        #     </div>\n        #   <% end %>\n        #\n        #   =>\n        #   <div class=\"form-group\">\n        #     Address id: 23\n        #     <label for=\"bill-addresses-0-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-0-street\" value=\"5th Ave\" data-index=\"0\">\n        #   </div>\n        #   <div class=\"form-group\">\n        #     Address id: 42\n        #     <label for=\"bill-addresses-1-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-1-street\" value=\"4th Ave\" data-index=\"1\">\n        #   </div>\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for_collection(name, &block)\n          _value(name).each_with_index do |value, index|\n            fields_for(\"#{name}.#{index}\", index, value, &block)\n          end\n        end\n\n        # Returns a label tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload label(field_name, **attributes)\n        #   Returns a label tag for the given field name, with a humanized version of the field name\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Extended title</label>\n        #\n        #   @example HTML attributes\n        #     <%= f.label(\"book.title\", class: \"form-label\") %>\n        #     # => <label for=\"book-title\" class=\"form-label\">Title</label>\n        #\n        # @overload label(content, **attributes)\n        #   Returns a label tag for the field name given as `for:`, with the given content string as\n        #   the tag's content.\n        #\n        #   @param content [String] the tag's content\n        #   @param for [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"Title\", for: \"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Title</label>\n        #\n        #     f.label(\"book.extended_title\", for: \"ext-title\")\n        #     # => <label for=\"ext-title\">Extended title</label>\n        #\n        # @overload label(field_name, **attributes, &block)\n        #   Returns a label tag for the given field name, with the return value of the given block\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #   @yieldreturn [String] the tag content\n        #\n        #   @example\n        #     <%= f.label for: \"book.free_shipping\" do %>\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     <% end %>\n        #\n        #     # =>\n        #     <label for=\"book-free-shipping\">\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     </label>\n        #\n        # @api public\n        # @since 2.1.0\n        def label(content = nil, **attributes, &block)\n          for_attribute_given = attributes.key?(:for)\n\n          attributes[:for] = _input_id(attributes[:for] || content)\n\n          if content && !for_attribute_given\n            content = inflector.humanize(content.to_s.split(INPUT_NAME_SEPARATOR).last)\n          end\n\n          tag.label(content, **attributes, &block)\n        end\n\n        # @overload fieldset(**attributes, &block)\n        #   Returns a fieldset tag.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag's content\n        #\n        #   @return [String] the tag\n        #\n        #   @example\n        #     <%= f.fieldset do %>\n        #       <%= f.legend(\"Author\") %>\n        #       <%= f.label(\"author.name\") %>\n        #       <%= f.text_field(\"author.name\") %>\n        #     <% end %>\n        #\n        #     # =>\n        #     <fieldset>\n        #       <legend>Author</legend>\n        #       <label for=\"book-author-name\">Name</label>\n        #       <input type=\"text\" name=\"book[author][name]\" id=\"book-author-name\" value=\"\">\n        #     </fieldset>\n        #\n        # @since 2.1.0\n        # @api public\n        def fieldset(...)\n          # This is here only for documentation purposes\n          tag.fieldset(...)\n        end\n\n        # Returns the tags for a check box.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the check box tag.\n        #\n        # Returns a hidden input tag in preceding the check box input tag. This ensures that\n        # unchecked values are submitted with the form.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the HTML attributes for the check box tag\n        # @option attributes [String] :checked_value (defaults to \"1\")\n        # @option attributes [String] :unchecked_value (defaults to \"0\")\n        #\n        # @return [String] the tags\n        #\n        # @example Basic usage\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   # =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\">\n        #\n        # @example HTML Attributes\n        #   f.check_box(\"delivery.free_shipping\", class: \"form-check-input\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" class=\"form-check-input\">\n        #\n        # @example Specifying checked and unchecked values\n        #   f.check_box(\"delivery.free_shipping\", checked_value: \"true\", unchecked_value: \"false\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"false\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"true\">\n        #\n        # @example Automatic \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"1\"}}\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Forcing the \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"0\"}}\n        #   f.check_box(\"deliver.free_shipping\", checked: \"checked\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Multiple check boxes for an array of values\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @example Automatic \"checked\" attribute for an array of values\n        #   # Given the request params:\n        #   # {book: {languages: [\"italian\"]}}\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\" checked=\"checked\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @api public\n        # @since 2.1.0\n        def check_box(name, **attributes)\n          (+\"\").tap { |output|\n            output << _hidden_field_for_check_box(name, attributes).to_s\n            output << input(**_attributes_for_check_box(name, attributes))\n          }.html_safe\n        end\n\n        # Returns a color input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.color_field(\"user.background\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.color_field(\"user.background\", class: \"form-control\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def color_field(name, **attributes)\n          input(**_attributes(:color, name, attributes))\n        end\n\n        # Returns a date input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.date_field(\"user.birth_date\")\n        #   # => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.date_field(\"user.birth_date\", class: \"form-control\")\n        #   => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def date_field(name, **attributes)\n          input(**_attributes(:date, name, attributes))\n        end\n\n        # Returns a datetime input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_field(name, **attributes)\n          input(**_attributes(:datetime, name, attributes))\n        end\n\n        # Returns a datetime-local input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_local_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_local_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_local_field(name, **attributes)\n          input(**_attributes(:\"datetime-local\", name, attributes))\n        end\n\n        # Returns a time input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.time_field(\"book.release_hour\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.time_field(\"book.release_hour\", class: \"form-control\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def time_field(name, **attributes)\n          input(**_attributes(:time, name, attributes))\n        end\n\n        # Returns a month input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.month_field(\"book.release_month\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.month_field(\"book.release_month\", class: \"form-control\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def month_field(name, **attributes)\n          input(**_attributes(:month, name, attributes))\n        end\n\n        # Returns a week input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.week_field(\"book.release_week\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.week_field(\"book.release_week\", class: \"form-control\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def week_field(name, **attributes)\n          input(**_attributes(:week, name, attributes))\n        end\n\n        # Returns an email input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.email_field(\"user.email\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.email_field(\"user.email\", class: \"form-control\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def email_field(name, **attributes)\n          input(**_attributes(:email, name, attributes))\n        end\n\n        # Returns a URL input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.url_field(\"user.website\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.url_field(\"user.website\", class: \"form-control\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def url_field(name, **attributes)\n          attributes[:value] = sanitize_url(attributes.fetch(:value) { _value(name) })\n\n          input(**_attributes(:url, name, attributes))\n        end\n\n        # Returns a telephone input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.tel_field(\"user.telephone\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.tel_field(\"user.telephone\", class: \"form-control\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def tel_field(name, **attributes)\n          input(**_attributes(:tel, name, attributes))\n        end\n\n        # Returns a hidden input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.hidden_field(\"delivery.customer_id\")\n        #   => <input type=\"hidden\" name=\"delivery[customer_id]\" id=\"delivery-customer-id\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def hidden_field(name, **attributes)\n          input(**_attributes(:hidden, name, attributes))\n        end\n\n        # Returns a file input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        # @option attributes [String, Array] :accept Optional set of accepted MIME Types\n        # @option attributes [Boolean] :multiple allow multiple file upload\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.file_field(\"user.avatar\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\">\n        #\n        # @example HTML Attributes\n        #   f.file_field(\"user.avatar\", class: \"avatar-upload\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\" class=\"avatar-upload\">\n        #\n        # @example Accepted MIME Types\n        #   f.file_field(\"user.resume\", accept: \"application/pdf,application/ms-word\")\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        #   f.file_field(\"user.resume\", accept: [\"application/pdf\", \"application/ms-word\"])\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        # @example Accept multiple file uploads\n        #   f.file_field(\"user.resume\", multiple: true)\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" multiple=\"multiple\">\n        #\n        # @api public\n        # @since 2.1.0\n        def file_field(name, **attributes)\n          form_attributes[:enctype] = \"multipart/form-data\"\n\n          attributes[:accept] = Array(attributes[:accept]).join(ACCEPT_SEPARATOR) if attributes.key?(:accept)\n          attributes = {type: :file, name: _input_name(name), id: _input_id(name), **attributes}\n\n          input(**attributes)\n        end\n\n        # Returns a number input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.number_field(\"book.percent_read\")\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.number_field(\"book.percent_read\", min: 1, max: 100, step: 1)\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def number_field(name, **attributes)\n          input(**_attributes(:number, name, attributes))\n        end\n\n        # Returns a range input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.range_field(\"book.discount_percentage\")\n        #   => <input type=\"range\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.range_field(\"book.discount_percentage\", min: 1, max: 1'0, step: 1)\n        #   => <input type=\"number\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def range_field(name, **attributes)\n          input(**_attributes(:range, name, attributes))\n        end\n\n        # Returns a textarea tag.\n        #\n        # @param name [String] the input name\n        # @param content [String] the content of the textarea\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_area(\"user.hobby\")\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\"></textarea>\n        #\n        #   f.text_area \"user.hobby\", \"Football\"\n        #   =>\n        #   <textarea name=\"user[hobby]\" id=\"user-hobby\">\n        #   Football</textarea>\n        #\n        # @example HTML attributes\n        #   f.text_area \"user.hobby\", class: \"form-control\"\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\" class=\"form-control\"></textarea>\n        #\n        # @api public\n        # @since 2.1.0\n        def text_area(name, content = nil, **attributes)\n          if content.respond_to?(:to_hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {name: _input_name(name), id: _input_id(name), **attributes}\n          tag.textarea(content || _value(name), **attributes)\n        end\n\n        # Returns a text input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_field(\"user.first_name\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.text_field(\"user.first_name\", class: \"form-control\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def text_field(name, **attributes)\n          input(**_attributes(:text, name, attributes))\n        end\n        alias_method :input_text, :text_field\n\n        # Returns a search input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.search_field(\"search.q\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.search_field(\"search.q\", class: \"form-control\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def search_field(name, **attributes)\n          input(**_attributes(:search, name, attributes))\n        end\n\n        # Returns a radio input tag.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the tag.\n        #\n        # @param name [String] the input name\n        # @param value [String] the input value\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\">\n        #\n        # @example HTML Attributes\n        #   f.radio_button(\"book.category\", \"Fiction\", class: \"form-check\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\", class: \"form-check\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\" class=\"form-check\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" class=\"form-check\">\n        #\n        # @example Automatic checked value\n        #   # Given the request params:\n        #   # {book: {category: \"Non-Fiction\"}}\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" checked=\"checked\">\n        #\n        # @api public\n        # @since 2.1.0\n        def radio_button(name, value, **attributes)\n          attributes = {type: :radio, name: _input_name(name), value: value, **attributes}\n          attributes[:checked] = true if _value(name).to_s == value.to_s\n\n          input(**attributes)\n        end\n\n        # Returns a password input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.password_field(\"signup.password\")\n        #   => <input type=\"password\" name=\"signup[password]\" id=\"signup-password\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def password_field(name, **attributes)\n          attrs = {type: :password, name: _input_name(name), id: _input_id(name), value: nil, **attributes}\n          attrs[:value] = EMPTY_STRING if attrs[:value].nil?\n\n          input(**attrs)\n        end\n\n        # Returns a select input tag containing option tags for the given values.\n        #\n        # The values should be an enumerable of pairs of content (the displayed text for the option)\n        # and value (the value for the option) strings.\n        #\n        # When editing a resource, automatically assigns the `selected` HTML attribute for any\n        # option tags matching the resource's values.\n        #\n        # @param name [String] the input name\n        # @param values [Hash] a Hash to generate `<option>` tags.\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example HTML Attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected options\n        #   # Given the following request params:\n        #   # {book: {store: \"it\"}}\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {selected: \"it\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"}, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true)\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\">\n        #    <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Values as an array, supporting repeated entries\n        #   values = [[\"Italy\", \"it\"],\n        #             [\"---\", \"\"],\n        #             [\"Afghanistan\", \"af\"],\n        #             ...\n        #             [\"Italy\", \"it\"],\n        #             ...\n        #             [\"Zimbabwe\", \"zw\"]]\n        #   f.select(\"book.stores\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"\">---</option>\n        #     <option value=\"af\">Afghanistan</option>\n        #     ...\n        #     <option value=\"it\">Italy</option>\n        #     ...\n        #     <option value=\"zw\">Zimbabwe</option>\n        #   </select>\n        #\n        # @api public\n        # @since 2.1.0\n        def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize\n          options = attributes.delete(:options) { {} }\n          multiple = attributes[:multiple]\n          attributes = {name: _select_input_name(name, multiple), id: _input_id(name), **attributes}\n          prompt = options.delete(:prompt)\n          selected = options.delete(:selected)\n          input_value = _value(name)\n\n          option_tags = []\n          option_tags << tag.option(prompt) if prompt\n\n          already_selected = nil\n          values.each do |content, value|\n            if (multiple || !already_selected) &&\n               (already_selected = _select_option_selected?(value, selected, input_value, multiple))\n              option_tags << tag.option(content, value: value, selected: true, **options)\n            else\n              option_tags << tag.option(content, value: value, **options)\n            end\n          end\n\n          tag.select(option_tags.join.html_safe, **attributes)\n        end\n\n        # Returns a datalist input tag.\n        #\n        # @param name [String] the input name\n        # @param values [Array,Hash] a collection that is transformed into `<option>` tags\n        # @param list [String] the name of list for the text input; also the id of datalist\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic Usage\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Options As Hash\n        #   values = Hash[\"Italy\" => \"it\", \"Australia\" => \"au\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\">it</option>\n        #     <option value=\"Australia\">au</option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the datalist input\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist \"book.stores\", values, \"books\", datalist: {class: \"form-control\"}\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\" class=\"form-control\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the options list\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\", options: {class: \"form-control\"})\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\" class=\"form-control\"></option>\n        #     <option value=\"Australia\" class=\"form-control\"></option>\n        #   </datalist>\n        #\n        # @api public\n        # @since 2.1.0\n        def datalist(name, values, list, **attributes)\n          options = attributes.delete(:options) || {}\n          datalist = attributes.delete(:datalist) || {}\n\n          attributes[:list] = list\n          datalist[:id] = list\n\n          (+\"\").tap { |output|\n            output << text_field(name, **attributes)\n            output << tag.datalist(**datalist) {\n              (+\"\").tap { |inner|\n                values.each do |value, content|\n                  inner << tag.option(content, value: value, **options)\n                end\n              }.html_safe\n            }\n          }.html_safe\n        end\n\n        # Returns a button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload button(content, **attributes)\n        #   Returns a button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload button(**attributes, &block)\n        #   Returns a button tag with the return value of the given block as the tag's content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.button(\"Click me\")\n        #   => <button>Click me</button>\n        #\n        # @example HTML Attributes\n        #   f.button(\"Click me\", class: \"btn btn-secondary\")\n        #   => <button class=\"btn btn-secondary\">Click me</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.button class: \"btn btn-secondary\" do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button class=\"btn btn-secondary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def button(...)\n          tag.button(...)\n        end\n\n        # Returns an image input tag, to be used as a visual button for the form.\n        #\n        # For security reasons, you should use the absolute URL of the given image.\n        #\n        # @param source [String] The absolute URL of the image\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\")\n        #   => <input type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @example HTML Attributes\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\", name: \"image\", width: \"50\")\n        #   => <input name=\"image\" width=\"50\" type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @api public\n        # @since 2.1.0\n        def image_button(source, **attributes)\n          attributes[:type] = :image\n          attributes[:src] = sanitize_url(source)\n\n          input(**attributes)\n        end\n\n        # Returns a submit button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload submit(content, **attributes)\n        #   Returns a submit button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload submit(**attributes, &blk)\n        #   Returns a submit button tag with the return value of the given block as the tag's\n        #   content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.submit(\"Create\")\n        #   => <button type=\"submit\">Create</button>\n        #\n        # @example HTML Attributes\n        #   f.submit(\"Create\", class: \"btn btn-primary\")\n        #   => <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.submit(class: \"btn btn-primary\") do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button type=\"submit\" class=\"btn btn-primary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def submit(content = nil, **attributes, &blk)\n          if content.is_a?(::Hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {type: :submit, **attributes}\n          tag.button(content, **attributes, &blk)\n        end\n\n        # Returns an input tag.\n        #\n        # Generates an input tag without any special handling. For more convenience and other\n        # advanced features, see the other methods of the form builder.\n        #\n        # @param attributes [Hash] the tag's HTML attributes\n        # @yieldreturn [String] the tag content\n        #\n        # @return [String] the tag\n        #\n        # @since 2.1.0\n        # @api public\n        #\n        # @example Basic usage\n        #   f.input(type: :text, name: \"book[title]\", id: \"book-title\", value: book.title)\n        #   => <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Hanami book\">\n        #\n        # @api public\n        # @since 2.1.0\n        def input(...)\n          tag.input(...)\n        end\n\n        private\n\n        # @api private\n        # @since 2.1.0\n        def _form_method(attributes)\n          attributes[:method] ||= DEFAULT_METHOD\n          attributes[:method] = attributes[:method].to_s.upcase\n\n          original_form_method = attributes[:method]\n\n          if (method_override = !BROWSER_METHODS.include?(attributes[:method]))\n            attributes[:method] = DEFAULT_METHOD\n          end\n\n          [method_override, original_form_method]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _csrf_token(values, attributes)\n          return [] if values.csrf_token.nil?\n\n          return [] if EXCLUDED_CSRF_METHODS.include?(attributes[:method])\n\n          [true, values.csrf_token]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _attributes(type, name, attributes)\n          attrs = {\n            type: type,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: _value(name)\n          }\n          attrs.merge!(attributes)\n          attrs[:value] = escape_html(attrs[:value]).html_safe\n          attrs\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_name(name)\n          tokens = _split_input_name(name)\n          result = tokens.shift\n\n          tokens.each do |t|\n            if t =~ %r{\\A\\d+\\z}\n              result << \"[]\"\n            else\n              result << \"[#{t}]\"\n            end\n          end\n\n          result\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_id(name)\n          [base_name, name].compact.join(INPUT_NAME_SEPARATOR).to_s.tr(\"._\", \"-\")\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _value(name)\n          values.get(*_split_input_name(name).map(&:to_sym))\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _split_input_name(name)\n          [\n            *base_name.to_s.split(INPUT_NAME_SEPARATOR),\n            *name.to_s.split(INPUT_NAME_SEPARATOR)\n          ].compact\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _hidden_field_for_check_box(name, attributes)\n          return unless attributes[:value].nil? || !attributes[:unchecked_value].nil?\n\n          input(\n            type: :hidden,\n            name: attributes[:name] || _input_name(name),\n            value: (attributes.delete(:unchecked_value) || DEFAULT_UNCHECKED_VALUE).to_s\n          )\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _attributes_for_check_box(name, attributes)\n          attributes = {\n            type: :checkbox,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: (attributes.delete(:checked_value) || DEFAULT_CHECKED_VALUE).to_s,\n            **attributes\n          }\n\n          attributes[:checked] = true if _check_box_checked?(attributes[:value], _value(name))\n\n          attributes\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_input_name(name, multiple)\n          select_name = _input_name(name)\n          select_name = \"#{select_name}[]\" if multiple\n          select_name\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_option_selected?(value, selected, input_value, multiple)\n          if input_value && selected.nil?\n            value.to_s == input_value.to_s\n          else\n            (value == selected) ||\n              _is_current_value?(input_value, value) ||\n              _is_in_selected_values?(multiple, selected, value) ||\n              _is_in_input_values?(multiple, input_value, value)\n          end\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_current_value?(input_value, value)\n          return unless input_value\n\n          value.to_s == input_value.to_s\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_selected_values?(multiple, selected, value)\n          return unless multiple && selected.is_a?(Array)\n\n          selected.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_input_values?(multiple, input_value, value)\n          return unless multiple && input_value.is_a?(Array)\n\n          input_value.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _check_box_checked?(value, input_value)\n          !input_value.nil? &&\n            (input_value.to_s == value.to_s || input_value.is_a?(TrueClass) ||\n            (input_value.is_a?(Array) && input_value.include?(value)))\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "select", "signature": "def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize", "start_line": 989, "end_line": 1011}, "metadata": {"module": "Hanami", "class_name": "FormBuilder", "class_signature": "class FormBuilder"}, "task_id": 673}
{"function_name": "datalist", "file_path": "hanami/lib/hanami/helpers/form_helper/form_builder.rb", "focal_code": "def datalist(name, values, list, **attributes)\n          options = attributes.delete(:options) || {}\n          datalist = attributes.delete(:datalist) || {}\n\n          attributes[:list] = list\n          datalist[:id] = list\n\n          (+\"\").tap { |output|\n            output << text_field(name, **attributes)\n            output << tag.datalist(**datalist) {\n              (+\"\").tap { |inner|\n                values.each do |value, content|\n                  inner << tag.option(content, value: value, **options)\n                end\n              }.html_safe\n            }\n          }.html_safe\n        end", "file_content": "# frozen_string_literal: true\n\nrequire \"hanami/view\"\nrequire_relative \"values\"\n\nmodule Hanami\n  module Helpers\n    module FormHelper\n      # A range of convenient methods for building the fields within an HTML form, integrating with\n      # request params and template locals to populate the fields with appropriate values.\n      #\n      # @see FormHelper#form_for\n      #\n      # @api public\n      # @since 2.1.0\n      class FormBuilder\n        # Set of HTTP methods that are understood by web browsers\n        #\n        # @since 2.1.0\n        # @api private\n        BROWSER_METHODS = %w[GET POST].freeze\n        private_constant :BROWSER_METHODS\n\n        # Set of HTTP methods that should NOT generate CSRF token\n        #\n        # @since 2.1.0\n        # @api private\n        EXCLUDED_CSRF_METHODS = %w[GET].freeze\n        private_constant :EXCLUDED_CSRF_METHODS\n\n        # Separator for accept attribute of file input\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #file_input\n        ACCEPT_SEPARATOR = \",\"\n        private_constant :ACCEPT_SEPARATOR\n\n        # Default value for unchecked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_UNCHECKED_VALUE = \"0\"\n        private_constant :DEFAULT_UNCHECKED_VALUE\n\n        # Default value for checked check box\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #check_box\n        DEFAULT_CHECKED_VALUE = \"1\"\n        private_constant :DEFAULT_CHECKED_VALUE\n\n        # Input name separator\n        #\n        # @since 2.1.0\n        # @api private\n        INPUT_NAME_SEPARATOR = \".\"\n        private_constant :INPUT_NAME_SEPARATOR\n\n        # Empty string\n        #\n        # @since 2.1.0\n        # @api private\n        #\n        # @see #password_field\n        EMPTY_STRING = \"\"\n        private_constant :EMPTY_STRING\n\n        include Hanami::View::Helpers::EscapeHelper\n        include Hanami::View::Helpers::TagHelper\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :base_name\n        private :base_name\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :values\n        private :values\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :inflector\n        private :inflector\n\n        # @api private\n        # @since 2.1.0\n        attr_reader :form_attributes\n        private :form_attributes\n\n        # Returns a new form builder.\n        #\n        # @param inflector [Dry::Inflector] the app inflector\n        # @param base_name [String, nil] the base name to use for all fields in the form\n        # @param values [Hanami::Helpers::FormHelper::Values] the values for the form\n        #\n        # @return [self]\n        #\n        # @see Hanami::Helpers::FormHelper#form_for\n        #\n        # @api private\n        # @since 2.1.0\n        def initialize(inflector:, form_attributes:, base_name: nil, values: Values.new)\n          @base_name = base_name\n          @values = values\n          @form_attributes = form_attributes\n          @inflector = inflector\n        end\n\n        # @api private\n        # @since 2.1.0\n        def call(content, **attributes)\n          attributes[\"accept-charset\"] ||= DEFAULT_CHARSET\n\n          method_override, original_form_method = _form_method(attributes)\n          csrf_token, token = _csrf_token(values, attributes)\n\n          tag.form(**attributes) do\n            (+\"\").tap { |inner|\n              inner << input(type: \"hidden\", name: \"_method\", value: original_form_method) if method_override\n              inner << input(type: \"hidden\", name: \"_csrf_token\", value: token) if csrf_token\n              inner << content\n            }.html_safe\n          end\n        end\n\n        # Applies the base input name to all fields within the given block.\n        #\n        # This can be helpful when generating a set of nested fields.\n        #\n        # This is a convenience only. You can achieve the same result by including the base name at\n        # the beginning of each input name.\n        #\n        # @param name [String] the base name to be used for all fields in the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        #\n        # @example Basic usage\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #     <%= fa.text_field \"suburb\" %>\n        #   <% end %>\n        #\n        #   # A convenience for:\n        #   # <%= f.text_field \"address.street\" %>\n        #   # <%= f.text_field \"address.suburb\" %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[customer_name]\" id=\"delivery-customer-name\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #\n        # @example Multiple levels of nesting\n        #   <% f.fields_for \"address\" do |fa| %>\n        #     <%= fa.text_field \"street\" %>\n        #\n        #     <% fa.fields_for \"location\" do |fl| %>\n        #       <%= fl.text_field \"city\" %>\n        #     <% end %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[address][street]\" id=\"delivery-address-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[address][location][city]\" id=\"delivery-address-location-city\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for(name, *yield_args)\n          new_base_name = [base_name, name.to_s].compact.join(INPUT_NAME_SEPARATOR)\n\n          builder = self.class.new(\n            base_name: new_base_name,\n            values: values,\n            form_attributes: form_attributes,\n            inflector: inflector\n          )\n\n          yield(builder, *yield_args)\n        end\n\n        # Yields to the given block for each element in the matching collection value, and applies\n        # the base input name to all fields within the block.\n        #\n        # Use this whenever generating form fields for an collection of nested fields.\n        #\n        # @param name [String] the input name, also used as the base input name for all fields\n        #   within the block\n        # @yieldparam [FormBuilder] the form builder for the nested fields\n        # @yieldparam [Integer] the index of the iteration over the collection, starting from zero\n        # @yieldparam [Object] the value of the element from the collection\n        #\n        # @example Basic usage\n        #   <% f.fields_for_collection(\"addresses\") do |fa| %>\n        #     <%= fa.text_field(\"street\") %>\n        #   <% end %>\n        #\n        #   =>\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-0-street\" value=\"\">\n        #   <input type=\"text\" name=\"delivery[addresses][][street]\" id=\"delivery-address-1-street\" value=\"\">\n        #\n        # @example Yielding index and value\n        #   <% f.fields_for_collection(\"bill.addresses\") do |fa, i, address| %>\n        #     <div class=\"form-group\">\n        #       Address id: <%= address.id %>\n        #       <%= fa.label(\"street\") %>\n        #       <%= fa.text_field(\"street\", data: {index: i.to_s}) %>\n        #     </div>\n        #   <% end %>\n        #\n        #   =>\n        #   <div class=\"form-group\">\n        #     Address id: 23\n        #     <label for=\"bill-addresses-0-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-0-street\" value=\"5th Ave\" data-index=\"0\">\n        #   </div>\n        #   <div class=\"form-group\">\n        #     Address id: 42\n        #     <label for=\"bill-addresses-1-street\">Street</label>\n        #     <input type=\"text\" name=\"bill[addresses][][street]\" id=\"bill-addresses-1-street\" value=\"4th Ave\" data-index=\"1\">\n        #   </div>\n        #\n        # @api public\n        # @since 2.1.0\n        def fields_for_collection(name, &block)\n          _value(name).each_with_index do |value, index|\n            fields_for(\"#{name}.#{index}\", index, value, &block)\n          end\n        end\n\n        # Returns a label tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload label(field_name, **attributes)\n        #   Returns a label tag for the given field name, with a humanized version of the field name\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Extended title</label>\n        #\n        #   @example HTML attributes\n        #     <%= f.label(\"book.title\", class: \"form-label\") %>\n        #     # => <label for=\"book-title\" class=\"form-label\">Title</label>\n        #\n        # @overload label(content, **attributes)\n        #   Returns a label tag for the field name given as `for:`, with the given content string as\n        #   the tag's content.\n        #\n        #   @param content [String] the tag's content\n        #   @param for [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #\n        #   @example\n        #     <%= f.label(\"Title\", for: \"book.extended_title\") %>\n        #     # => <label for=\"book-extended-title\">Title</label>\n        #\n        #     f.label(\"book.extended_title\", for: \"ext-title\")\n        #     # => <label for=\"ext-title\">Extended title</label>\n        #\n        # @overload label(field_name, **attributes, &block)\n        #   Returns a label tag for the given field name, with the return value of the given block\n        #   as the tag's content.\n        #\n        #   @param field_name [String] the field name\n        #   @param attributes [Hash] the tag attributes\n        #   @yieldreturn [String] the tag content\n        #\n        #   @example\n        #     <%= f.label for: \"book.free_shipping\" do %>\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     <% end %>\n        #\n        #     # =>\n        #     <label for=\"book-free-shipping\">\n        #       Free shipping\n        #       <abbr title=\"optional\" aria-label=\"optional\">*</abbr>\n        #     </label>\n        #\n        # @api public\n        # @since 2.1.0\n        def label(content = nil, **attributes, &block)\n          for_attribute_given = attributes.key?(:for)\n\n          attributes[:for] = _input_id(attributes[:for] || content)\n\n          if content && !for_attribute_given\n            content = inflector.humanize(content.to_s.split(INPUT_NAME_SEPARATOR).last)\n          end\n\n          tag.label(content, **attributes, &block)\n        end\n\n        # @overload fieldset(**attributes, &block)\n        #   Returns a fieldset tag.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag's content\n        #\n        #   @return [String] the tag\n        #\n        #   @example\n        #     <%= f.fieldset do %>\n        #       <%= f.legend(\"Author\") %>\n        #       <%= f.label(\"author.name\") %>\n        #       <%= f.text_field(\"author.name\") %>\n        #     <% end %>\n        #\n        #     # =>\n        #     <fieldset>\n        #       <legend>Author</legend>\n        #       <label for=\"book-author-name\">Name</label>\n        #       <input type=\"text\" name=\"book[author][name]\" id=\"book-author-name\" value=\"\">\n        #     </fieldset>\n        #\n        # @since 2.1.0\n        # @api public\n        def fieldset(...)\n          # This is here only for documentation purposes\n          tag.fieldset(...)\n        end\n\n        # Returns the tags for a check box.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the check box tag.\n        #\n        # Returns a hidden input tag in preceding the check box input tag. This ensures that\n        # unchecked values are submitted with the form.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the HTML attributes for the check box tag\n        # @option attributes [String] :checked_value (defaults to \"1\")\n        # @option attributes [String] :unchecked_value (defaults to \"0\")\n        #\n        # @return [String] the tags\n        #\n        # @example Basic usage\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   # =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\">\n        #\n        # @example HTML Attributes\n        #   f.check_box(\"delivery.free_shipping\", class: \"form-check-input\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" class=\"form-check-input\">\n        #\n        # @example Specifying checked and unchecked values\n        #   f.check_box(\"delivery.free_shipping\", checked_value: \"true\", unchecked_value: \"false\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"false\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"true\">\n        #\n        # @example Automatic \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"1\"}}\n        #   f.check_box(\"delivery.free_shipping\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Forcing the \"checked\" attribute\n        #   # Given the request params:\n        #   # {delivery: {free_shipping: \"0\"}}\n        #   f.check_box(\"deliver.free_shipping\", checked: \"checked\")\n        #\n        #   =>\n        #   <input type=\"hidden\" name=\"delivery[free_shipping]\" value=\"0\">\n        #   <input type=\"checkbox\" name=\"delivery[free_shipping]\" id=\"delivery-free-shipping\" value=\"1\" checked=\"checked\">\n        #\n        # @example Multiple check boxes for an array of values\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @example Automatic \"checked\" attribute for an array of values\n        #   # Given the request params:\n        #   # {book: {languages: [\"italian\"]}}\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"italian\", id: nil)\n        #   f.check_box(\"book.languages\", name: \"book[languages][]\", value: \"english\", id: nil)\n        #\n        #   =>\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"italian\" checked=\"checked\">\n        #   <input type=\"checkbox\" name=\"book[languages][]\" value=\"english\">\n        #\n        # @api public\n        # @since 2.1.0\n        def check_box(name, **attributes)\n          (+\"\").tap { |output|\n            output << _hidden_field_for_check_box(name, attributes).to_s\n            output << input(**_attributes_for_check_box(name, attributes))\n          }.html_safe\n        end\n\n        # Returns a color input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.color_field(\"user.background\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.color_field(\"user.background\", class: \"form-control\")\n        #   => <input type=\"color\" name=\"user[background]\" id=\"user-background\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def color_field(name, **attributes)\n          input(**_attributes(:color, name, attributes))\n        end\n\n        # Returns a date input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.date_field(\"user.birth_date\")\n        #   # => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.date_field(\"user.birth_date\", class: \"form-control\")\n        #   => <input type=\"date\" name=\"user[birth_date]\" id=\"user-birth-date\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def date_field(name, **attributes)\n          input(**_attributes(:date, name, attributes))\n        end\n\n        # Returns a datetime input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_field(name, **attributes)\n          input(**_attributes(:datetime, name, attributes))\n        end\n\n        # Returns a datetime-local input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.datetime_local_field(\"delivery.delivered_at\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.datetime_local_field(\"delivery.delivered_at\", class: \"form-control\")\n        #   => <input type=\"datetime-local\" name=\"delivery[delivered_at]\" id=\"delivery-delivered-at\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def datetime_local_field(name, **attributes)\n          input(**_attributes(:\"datetime-local\", name, attributes))\n        end\n\n        # Returns a time input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.time_field(\"book.release_hour\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.time_field(\"book.release_hour\", class: \"form-control\")\n        #   => <input type=\"time\" name=\"book[release_hour]\" id=\"book-release-hour\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def time_field(name, **attributes)\n          input(**_attributes(:time, name, attributes))\n        end\n\n        # Returns a month input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.month_field(\"book.release_month\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.month_field(\"book.release_month\", class: \"form-control\")\n        #   => <input type=\"month\" name=\"book[release_month]\" id=\"book-release-month\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def month_field(name, **attributes)\n          input(**_attributes(:month, name, attributes))\n        end\n\n        # Returns a week input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.week_field(\"book.release_week\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.week_field(\"book.release_week\", class: \"form-control\")\n        #   => <input type=\"week\" name=\"book[release_week]\" id=\"book-release-week\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def week_field(name, **attributes)\n          input(**_attributes(:week, name, attributes))\n        end\n\n        # Returns an email input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.email_field(\"user.email\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.email_field(\"user.email\", class: \"form-control\")\n        #   => <input type=\"email\" name=\"user[email]\" id=\"user-email\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def email_field(name, **attributes)\n          input(**_attributes(:email, name, attributes))\n        end\n\n        # Returns a URL input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.url_field(\"user.website\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.url_field(\"user.website\", class: \"form-control\")\n        #   => <input type=\"url\" name=\"user[website]\" id=\"user-website\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def url_field(name, **attributes)\n          attributes[:value] = sanitize_url(attributes.fetch(:value) { _value(name) })\n\n          input(**_attributes(:url, name, attributes))\n        end\n\n        # Returns a telephone input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.tel_field(\"user.telephone\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.tel_field(\"user.telephone\", class: \"form-control\")\n        #   => <input type=\"tel\" name=\"user[telephone]\" id=\"user-telephone\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def tel_field(name, **attributes)\n          input(**_attributes(:tel, name, attributes))\n        end\n\n        # Returns a hidden input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example\n        #   f.hidden_field(\"delivery.customer_id\")\n        #   => <input type=\"hidden\" name=\"delivery[customer_id]\" id=\"delivery-customer-id\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def hidden_field(name, **attributes)\n          input(**_attributes(:hidden, name, attributes))\n        end\n\n        # Returns a file input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        # @option attributes [String, Array] :accept Optional set of accepted MIME Types\n        # @option attributes [Boolean] :multiple allow multiple file upload\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.file_field(\"user.avatar\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\">\n        #\n        # @example HTML Attributes\n        #   f.file_field(\"user.avatar\", class: \"avatar-upload\")\n        #   => <input type=\"file\" name=\"user[avatar]\" id=\"user-avatar\" class=\"avatar-upload\">\n        #\n        # @example Accepted MIME Types\n        #   f.file_field(\"user.resume\", accept: \"application/pdf,application/ms-word\")\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        #   f.file_field(\"user.resume\", accept: [\"application/pdf\", \"application/ms-word\"])\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" accept=\"application/pdf,application/ms-word\">\n        #\n        # @example Accept multiple file uploads\n        #   f.file_field(\"user.resume\", multiple: true)\n        #   => <input type=\"file\" name=\"user[resume]\" id=\"user-resume\" multiple=\"multiple\">\n        #\n        # @api public\n        # @since 2.1.0\n        def file_field(name, **attributes)\n          form_attributes[:enctype] = \"multipart/form-data\"\n\n          attributes[:accept] = Array(attributes[:accept]).join(ACCEPT_SEPARATOR) if attributes.key?(:accept)\n          attributes = {type: :file, name: _input_name(name), id: _input_id(name), **attributes}\n\n          input(**attributes)\n        end\n\n        # Returns a number input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.number_field(\"book.percent_read\")\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.number_field(\"book.percent_read\", min: 1, max: 100, step: 1)\n        #   => <input type=\"number\" name=\"book[percent_read]\" id=\"book-percent-read\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def number_field(name, **attributes)\n          input(**_attributes(:number, name, attributes))\n        end\n\n        # Returns a range input tag.\n        #\n        # For this tag, you can make use of the `max`, `min`, and `step` HTML attributes.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.range_field(\"book.discount_percentage\")\n        #   => <input type=\"range\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\">\n        #\n        # @example Advanced attributes\n        #   f.range_field(\"book.discount_percentage\", min: 1, max: 1'0, step: 1)\n        #   => <input type=\"number\" name=\"book[discount_percentage]\" id=\"book-discount-percentage\" value=\"\" min=\"1\" max=\"100\" step=\"1\">\n        #\n        # @api public\n        # @since 2.1.0\n        def range_field(name, **attributes)\n          input(**_attributes(:range, name, attributes))\n        end\n\n        # Returns a textarea tag.\n        #\n        # @param name [String] the input name\n        # @param content [String] the content of the textarea\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_area(\"user.hobby\")\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\"></textarea>\n        #\n        #   f.text_area \"user.hobby\", \"Football\"\n        #   =>\n        #   <textarea name=\"user[hobby]\" id=\"user-hobby\">\n        #   Football</textarea>\n        #\n        # @example HTML attributes\n        #   f.text_area \"user.hobby\", class: \"form-control\"\n        #   => <textarea name=\"user[hobby]\" id=\"user-hobby\" class=\"form-control\"></textarea>\n        #\n        # @api public\n        # @since 2.1.0\n        def text_area(name, content = nil, **attributes)\n          if content.respond_to?(:to_hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {name: _input_name(name), id: _input_id(name), **attributes}\n          tag.textarea(content || _value(name), **attributes)\n        end\n\n        # Returns a text input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.text_field(\"user.first_name\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.text_field(\"user.first_name\", class: \"form-control\")\n        #   => <input type=\"text\" name=\"user[first_name]\" id=\"user-first-name\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def text_field(name, **attributes)\n          input(**_attributes(:text, name, attributes))\n        end\n        alias_method :input_text, :text_field\n\n        # Returns a search input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.search_field(\"search.q\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\">\n        #\n        # @example HTML Attributes\n        #   f.search_field(\"search.q\", class: \"form-control\")\n        #   => <input type=\"search\" name=\"search[q]\" id=\"search-q\" value=\"\" class=\"form-control\">\n        #\n        # @api public\n        # @since 2.1.0\n        def search_field(name, **attributes)\n          input(**_attributes(:search, name, attributes))\n        end\n\n        # Returns a radio input tag.\n        #\n        # When editing a resource, the form automatically assigns the `checked` HTML attribute for\n        # the tag.\n        #\n        # @param name [String] the input name\n        # @param value [String] the input value\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\">\n        #\n        # @example HTML Attributes\n        #   f.radio_button(\"book.category\", \"Fiction\", class: \"form-check\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\", class: \"form-check\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\" class=\"form-check\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" class=\"form-check\">\n        #\n        # @example Automatic checked value\n        #   # Given the request params:\n        #   # {book: {category: \"Non-Fiction\"}}\n        #   f.radio_button(\"book.category\", \"Fiction\")\n        #   f.radio_button(\"book.category\", \"Non-Fiction\")\n        #\n        #   =>\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Fiction\">\n        #   <input type=\"radio\" name=\"book[category]\" value=\"Non-Fiction\" checked=\"checked\">\n        #\n        # @api public\n        # @since 2.1.0\n        def radio_button(name, value, **attributes)\n          attributes = {type: :radio, name: _input_name(name), value: value, **attributes}\n          attributes[:checked] = true if _value(name).to_s == value.to_s\n\n          input(**attributes)\n        end\n\n        # Returns a password input tag.\n        #\n        # @param name [String] the input name\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.password_field(\"signup.password\")\n        #   => <input type=\"password\" name=\"signup[password]\" id=\"signup-password\" value=\"\">\n        #\n        # @api public\n        # @since 2.1.0\n        def password_field(name, **attributes)\n          attrs = {type: :password, name: _input_name(name), id: _input_id(name), value: nil, **attributes}\n          attrs[:value] = EMPTY_STRING if attrs[:value].nil?\n\n          input(**attrs)\n        end\n\n        # Returns a select input tag containing option tags for the given values.\n        #\n        # The values should be an enumerable of pairs of content (the displayed text for the option)\n        # and value (the value for the option) strings.\n        #\n        # When editing a resource, automatically assigns the `selected` HTML attribute for any\n        # option tags matching the resource's values.\n        #\n        # @param name [String] the input name\n        # @param values [Hash] a Hash to generate `<option>` tags.\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example HTML Attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected options\n        #   # Given the following request params:\n        #   # {book: {store: \"it\"}}\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Selected option\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {selected: \"it\"})\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\" selected=\"selected\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Prompt option and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.store\", values, options: {prompt: \"Select a store\"}, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\" class=\"form-control\">\n        #     <option>Select a store</option>\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true)\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\">\n        #    <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Multiple select and HTML attributes\n        #   values = {\"Italy\" => \"it\", \"Australia\" => \"au\"}\n        #   f.select(\"book.stores\", values, multiple: true, class: \"form-control\")\n        #\n        #   =>\n        #   <select name=\"book[store][]\" id=\"book-store\" multiple=\"multiple\" class=\"form-control\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"au\">Australia</option>\n        #   </select>\n        #\n        # @example Values as an array, supporting repeated entries\n        #   values = [[\"Italy\", \"it\"],\n        #             [\"---\", \"\"],\n        #             [\"Afghanistan\", \"af\"],\n        #             ...\n        #             [\"Italy\", \"it\"],\n        #             ...\n        #             [\"Zimbabwe\", \"zw\"]]\n        #   f.select(\"book.stores\", values)\n        #\n        #   =>\n        #   <select name=\"book[store]\" id=\"book-store\">\n        #     <option value=\"it\">Italy</option>\n        #     <option value=\"\">---</option>\n        #     <option value=\"af\">Afghanistan</option>\n        #     ...\n        #     <option value=\"it\">Italy</option>\n        #     ...\n        #     <option value=\"zw\">Zimbabwe</option>\n        #   </select>\n        #\n        # @api public\n        # @since 2.1.0\n        def select(name, values, **attributes) # rubocop:disable Metrics/AbcSize\n          options = attributes.delete(:options) { {} }\n          multiple = attributes[:multiple]\n          attributes = {name: _select_input_name(name, multiple), id: _input_id(name), **attributes}\n          prompt = options.delete(:prompt)\n          selected = options.delete(:selected)\n          input_value = _value(name)\n\n          option_tags = []\n          option_tags << tag.option(prompt) if prompt\n\n          already_selected = nil\n          values.each do |content, value|\n            if (multiple || !already_selected) &&\n               (already_selected = _select_option_selected?(value, selected, input_value, multiple))\n              option_tags << tag.option(content, value: value, selected: true, **options)\n            else\n              option_tags << tag.option(content, value: value, **options)\n            end\n          end\n\n          tag.select(option_tags.join.html_safe, **attributes)\n        end\n\n        # Returns a datalist input tag.\n        #\n        # @param name [String] the input name\n        # @param values [Array,Hash] a collection that is transformed into `<option>` tags\n        # @param list [String] the name of list for the text input; also the id of datalist\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic Usage\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Options As Hash\n        #   values = Hash[\"Italy\" => \"it\", \"Australia\" => \"au\"]\n        #   f.datalist(\"book.stores\", values, \"books\")\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\">it</option>\n        #     <option value=\"Australia\">au</option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the datalist input\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist \"book.stores\", values, \"books\", datalist: {class: \"form-control\"}\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\" class=\"form-control\">\n        #     <option value=\"Italy\"></option>\n        #     <option value=\"Australia\"></option>\n        #   </datalist>\n        #\n        # @example Specifying custom attributes for the options list\n        #   values = [\"Italy\", \"Australia\"]\n        #   f.datalist(\"book.stores\", values, \"books\", options: {class: \"form-control\"})\n        #\n        #   =>\n        #   <input type=\"text\" name=\"book[store]\" id=\"book-store\" value=\"\" list=\"books\">\n        #   <datalist id=\"books\">\n        #     <option value=\"Italy\" class=\"form-control\"></option>\n        #     <option value=\"Australia\" class=\"form-control\"></option>\n        #   </datalist>\n        #\n        # @api public\n        # @since 2.1.0\n        def datalist(name, values, list, **attributes)\n          options = attributes.delete(:options) || {}\n          datalist = attributes.delete(:datalist) || {}\n\n          attributes[:list] = list\n          datalist[:id] = list\n\n          (+\"\").tap { |output|\n            output << text_field(name, **attributes)\n            output << tag.datalist(**datalist) {\n              (+\"\").tap { |inner|\n                values.each do |value, content|\n                  inner << tag.option(content, value: value, **options)\n                end\n              }.html_safe\n            }\n          }.html_safe\n        end\n\n        # Returns a button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload button(content, **attributes)\n        #   Returns a button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload button(**attributes, &block)\n        #   Returns a button tag with the return value of the given block as the tag's content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.button(\"Click me\")\n        #   => <button>Click me</button>\n        #\n        # @example HTML Attributes\n        #   f.button(\"Click me\", class: \"btn btn-secondary\")\n        #   => <button class=\"btn btn-secondary\">Click me</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.button class: \"btn btn-secondary\" do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button class=\"btn btn-secondary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def button(...)\n          tag.button(...)\n        end\n\n        # Returns an image input tag, to be used as a visual button for the form.\n        #\n        # For security reasons, you should use the absolute URL of the given image.\n        #\n        # @param source [String] The absolute URL of the image\n        # @param attributes [Hash] the tag's HTML attributes\n        #\n        # @return [String] the tag\n        #\n        # @example Basic usage\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\")\n        #   => <input type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @example HTML Attributes\n        #   f.image_button(\"https://hanamirb.org/assets/button.png\", name: \"image\", width: \"50\")\n        #   => <input name=\"image\" width=\"50\" type=\"image\" src=\"https://hanamirb.org/assets/button.png\">\n        #\n        # @api public\n        # @since 2.1.0\n        def image_button(source, **attributes)\n          attributes[:type] = :image\n          attributes[:src] = sanitize_url(source)\n\n          input(**attributes)\n        end\n\n        # Returns a submit button tag.\n        #\n        # @return [String] the tag\n        #\n        # @overload submit(content, **attributes)\n        #   Returns a submit button tag with the given content.\n        #\n        #   @param content [String] the content for the tag\n        #   @param attributes [Hash] the tag's HTML attributes\n        #\n        # @overload submit(**attributes, &blk)\n        #   Returns a submit button tag with the return value of the given block as the tag's\n        #   content.\n        #\n        #   @param attributes [Hash] the tag's HTML attributes\n        #   @yieldreturn [String] the tag content\n        #\n        # @example Basic usage\n        #   f.submit(\"Create\")\n        #   => <button type=\"submit\">Create</button>\n        #\n        # @example HTML Attributes\n        #   f.submit(\"Create\", class: \"btn btn-primary\")\n        #   => <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n        #\n        # @example Returning content from a block\n        #   <%= f.submit(class: \"btn btn-primary\") do %>\n        #     <span class=\"oi oi-check\">\n        #   <% end %>\n        #\n        #   =>\n        #   <button type=\"submit\" class=\"btn btn-primary\">\n        #     <span class=\"oi oi-check\"></span>\n        #   </button>\n        #\n        # @api public\n        # @since 2.1.0\n        def submit(content = nil, **attributes, &blk)\n          if content.is_a?(::Hash)\n            attributes = content\n            content = nil\n          end\n\n          attributes = {type: :submit, **attributes}\n          tag.button(content, **attributes, &blk)\n        end\n\n        # Returns an input tag.\n        #\n        # Generates an input tag without any special handling. For more convenience and other\n        # advanced features, see the other methods of the form builder.\n        #\n        # @param attributes [Hash] the tag's HTML attributes\n        # @yieldreturn [String] the tag content\n        #\n        # @return [String] the tag\n        #\n        # @since 2.1.0\n        # @api public\n        #\n        # @example Basic usage\n        #   f.input(type: :text, name: \"book[title]\", id: \"book-title\", value: book.title)\n        #   => <input type=\"text\" name=\"book[title]\" id=\"book-title\" value=\"Hanami book\">\n        #\n        # @api public\n        # @since 2.1.0\n        def input(...)\n          tag.input(...)\n        end\n\n        private\n\n        # @api private\n        # @since 2.1.0\n        def _form_method(attributes)\n          attributes[:method] ||= DEFAULT_METHOD\n          attributes[:method] = attributes[:method].to_s.upcase\n\n          original_form_method = attributes[:method]\n\n          if (method_override = !BROWSER_METHODS.include?(attributes[:method]))\n            attributes[:method] = DEFAULT_METHOD\n          end\n\n          [method_override, original_form_method]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _csrf_token(values, attributes)\n          return [] if values.csrf_token.nil?\n\n          return [] if EXCLUDED_CSRF_METHODS.include?(attributes[:method])\n\n          [true, values.csrf_token]\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _attributes(type, name, attributes)\n          attrs = {\n            type: type,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: _value(name)\n          }\n          attrs.merge!(attributes)\n          attrs[:value] = escape_html(attrs[:value]).html_safe\n          attrs\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_name(name)\n          tokens = _split_input_name(name)\n          result = tokens.shift\n\n          tokens.each do |t|\n            if t =~ %r{\\A\\d+\\z}\n              result << \"[]\"\n            else\n              result << \"[#{t}]\"\n            end\n          end\n\n          result\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _input_id(name)\n          [base_name, name].compact.join(INPUT_NAME_SEPARATOR).to_s.tr(\"._\", \"-\")\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _value(name)\n          values.get(*_split_input_name(name).map(&:to_sym))\n        end\n\n        # @api private\n        # @since 2.1.0\n        def _split_input_name(name)\n          [\n            *base_name.to_s.split(INPUT_NAME_SEPARATOR),\n            *name.to_s.split(INPUT_NAME_SEPARATOR)\n          ].compact\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _hidden_field_for_check_box(name, attributes)\n          return unless attributes[:value].nil? || !attributes[:unchecked_value].nil?\n\n          input(\n            type: :hidden,\n            name: attributes[:name] || _input_name(name),\n            value: (attributes.delete(:unchecked_value) || DEFAULT_UNCHECKED_VALUE).to_s\n          )\n        end\n\n        # @api private\n        # @since 2.1.0\n        #\n        # @see #check_box\n        def _attributes_for_check_box(name, attributes)\n          attributes = {\n            type: :checkbox,\n            name: _input_name(name),\n            id: _input_id(name),\n            value: (attributes.delete(:checked_value) || DEFAULT_CHECKED_VALUE).to_s,\n            **attributes\n          }\n\n          attributes[:checked] = true if _check_box_checked?(attributes[:value], _value(name))\n\n          attributes\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_input_name(name, multiple)\n          select_name = _input_name(name)\n          select_name = \"#{select_name}[]\" if multiple\n          select_name\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _select_option_selected?(value, selected, input_value, multiple)\n          if input_value && selected.nil?\n            value.to_s == input_value.to_s\n          else\n            (value == selected) ||\n              _is_current_value?(input_value, value) ||\n              _is_in_selected_values?(multiple, selected, value) ||\n              _is_in_input_values?(multiple, input_value, value)\n          end\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_current_value?(input_value, value)\n          return unless input_value\n\n          value.to_s == input_value.to_s\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_selected_values?(multiple, selected, value)\n          return unless multiple && selected.is_a?(Array)\n\n          selected.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _is_in_input_values?(multiple, input_value, value)\n          return unless multiple && input_value.is_a?(Array)\n\n          input_value.include?(value)\n        end\n\n        # @api private\n        # @since 1.2.0\n        def _check_box_checked?(value, input_value)\n          !input_value.nil? &&\n            (input_value.to_s == value.to_s || input_value.is_a?(TrueClass) ||\n            (input_value.is_a?(Array) && input_value.include?(value)))\n        end\n      end\n    end\n  end\nend\n", "language": "ruby", "function_component": {"name": "datalist", "signature": "def datalist(name, values, list, **attributes)", "start_line": 1068, "end_line": 1085}, "metadata": {"module": "Hanami", "class_name": "FormBuilder", "class_signature": "class FormBuilder"}, "task_id": 674}